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)) {
417 my $loc = delete $self->hashref->{$l};
418 # XXX if we're moving a prospect's locations, do that here
420 #return "$l not set";
421 #location-less customer records are now permitted
425 if ( !$loc->locationnum ) {
426 # warn the location that we're going to insert it with no custnum
427 $loc->set(custnum_pending => 1);
428 warn " inserting $l\n"
430 my $error = $loc->insert;
432 $dbh->rollback if $oldAutoCommit;
433 my $label = $l eq 'ship_location' ? 'service' : 'billing';
434 return "$error (in $label location)";
437 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
438 # then it somehow belongs to another customer--shouldn't happen
439 $dbh->rollback if $oldAutoCommit;
440 return "$l belongs to customer ".$loc->custnum;
442 # else it already belongs to this customer
443 # (happens when ship_location is identical to bill_location)
445 $self->set($l.'num', $loc->locationnum);
447 if ( $self->get($l.'num') eq '' ) {
448 $dbh->rollback if $oldAutoCommit;
453 warn " inserting $self\n"
456 $self->signupdate(time) unless $self->signupdate;
458 $self->auto_agent_custid()
459 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
461 my $error = $self->SUPER::insert;
463 $dbh->rollback if $oldAutoCommit;
464 #return "inserting cust_main record (transaction rolled back): $error";
468 # now set cust_location.custnum
469 foreach my $l (qw(bill_location ship_location)) {
470 warn " setting $l.custnum\n"
472 my $loc = $self->$l or next;
473 unless ( $loc->custnum ) {
474 $loc->set(custnum => $self->custnum);
475 $error ||= $loc->replace;
479 $dbh->rollback if $oldAutoCommit;
480 return "error setting $l custnum: $error";
484 warn " setting invoicing list\n"
487 if ( $invoicing_list ) {
488 $error = $self->check_invoicing_list( $invoicing_list );
490 $dbh->rollback if $oldAutoCommit;
491 #return "checking invoicing_list (transaction rolled back): $error";
494 $self->invoicing_list( $invoicing_list );
497 warn " setting customer tags\n"
500 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
501 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
502 'custnum' => $self->custnum };
503 my $error = $cust_tag->insert;
505 $dbh->rollback if $oldAutoCommit;
510 my $prospectnum = delete $options{'prospectnum'};
511 if ( $prospectnum ) {
513 warn " moving contacts and locations from prospect $prospectnum\n"
517 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
518 unless ( $prospect_main ) {
519 $dbh->rollback if $oldAutoCommit;
520 return "Unknown prospectnum $prospectnum";
522 $prospect_main->custnum($self->custnum);
523 $prospect_main->disabled('Y');
524 my $error = $prospect_main->replace;
526 $dbh->rollback if $oldAutoCommit;
530 my @contact = $prospect_main->contact;
531 my @cust_location = $prospect_main->cust_location;
532 my @qual = $prospect_main->qual;
534 foreach my $r ( @contact, @cust_location, @qual ) {
536 $r->custnum($self->custnum);
537 my $error = $r->replace;
539 $dbh->rollback if $oldAutoCommit;
546 my $contact = delete $options{'contact'};
549 foreach my $c ( @$contact ) {
550 $c->custnum($self->custnum);
551 my $error = $c->insert;
553 $dbh->rollback if $oldAutoCommit;
561 warn " setting cust_main_exemption\n"
564 my $tax_exemption = delete $options{'tax_exemption'};
565 if ( $tax_exemption ) {
567 $tax_exemption = { map { $_ => '' } @$tax_exemption }
568 if ref($tax_exemption) eq 'ARRAY';
570 foreach my $taxname ( keys %$tax_exemption ) {
571 my $cust_main_exemption = new FS::cust_main_exemption {
572 'custnum' => $self->custnum,
573 'taxname' => $taxname,
574 'exempt_number' => $tax_exemption->{$taxname},
576 my $error = $cust_main_exemption->insert;
578 $dbh->rollback if $oldAutoCommit;
579 return "inserting cust_main_exemption (transaction rolled back): $error";
584 warn " ordering packages\n"
587 $error = $self->order_pkgs( $cust_pkgs,
589 'seconds_ref' => \$seconds,
590 'upbytes_ref' => \$upbytes,
591 'downbytes_ref' => \$downbytes,
592 'totalbytes_ref' => \$totalbytes,
595 $dbh->rollback if $oldAutoCommit;
600 $dbh->rollback if $oldAutoCommit;
601 return "No svc_acct record to apply pre-paid time";
603 if ( $upbytes || $downbytes || $totalbytes ) {
604 $dbh->rollback if $oldAutoCommit;
605 return "No svc_acct record to apply pre-paid data";
609 warn " inserting initial $payby payment of $amount\n"
611 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
613 $dbh->rollback if $oldAutoCommit;
614 return "inserting payment (transaction rolled back): $error";
618 unless ( $import || $skip_fuzzyfiles ) {
619 warn " queueing fuzzyfiles update\n"
621 $error = $self->queue_fuzzyfiles_update;
623 $dbh->rollback if $oldAutoCommit;
624 return "updating fuzzy search cache: $error";
628 # FS::geocode_Mixin::after_insert or something?
629 if ( $conf->config('tax_district_method') and !$import ) {
630 # if anything non-empty, try to look it up
631 my $queue = new FS::queue {
632 'job' => 'FS::geocode_Mixin::process_district_update',
633 'custnum' => $self->custnum,
635 my $error = $queue->insert( ref($self), $self->custnum );
637 $dbh->rollback if $oldAutoCommit;
638 return "queueing tax district update: $error";
643 warn " exporting\n" if $DEBUG > 1;
645 my $export_args = $options{'export_args'} || [];
648 map qsearch( 'part_export', {exportnum=>$_} ),
649 $conf->config('cust_main-exports'); #, $agentnum
651 foreach my $part_export ( @part_export ) {
652 my $error = $part_export->export_insert($self, @$export_args);
654 $dbh->rollback if $oldAutoCommit;
655 return "exporting to ". $part_export->exporttype.
656 " (transaction rolled back): $error";
660 #foreach my $depend_jobnum ( @$depend_jobnums ) {
661 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
663 # foreach my $jobnum ( @jobnums ) {
664 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
665 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
667 # my $error = $queue->depend_insert($depend_jobnum);
669 # $dbh->rollback if $oldAutoCommit;
670 # return "error queuing job dependancy: $error";
677 #if ( exists $options{'jobnums'} ) {
678 # push @{ $options{'jobnums'} }, @jobnums;
681 warn " insert complete; committing transaction\n"
684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
689 use File::CounterFile;
690 sub auto_agent_custid {
693 my $format = $conf->config('cust_main-auto_agent_custid');
695 if ( $format eq '1YMMXXXXXXXX' ) {
697 my $counter = new File::CounterFile 'cust_main.agent_custid';
700 my $ym = 100000000000 + time2str('%y%m00000000', time);
701 if ( $ym > $counter->value ) {
702 $counter->{'value'} = $agent_custid = $ym;
703 $counter->{'updated'} = 1;
705 $agent_custid = $counter->inc;
711 die "Unknown cust_main-auto_agent_custid format: $format";
714 $self->agent_custid($agent_custid);
718 =item PACKAGE METHODS
720 Documentation on customer package methods has been moved to
721 L<FS::cust_main::Packages>.
723 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
725 Recharges this (existing) customer with the specified prepaid card (see
726 L<FS::prepay_credit>), specified either by I<identifier> or as an
727 FS::prepay_credit object. If there is an error, returns the error, otherwise
730 Optionally, five scalar references can be passed as well. They will have their
731 values filled in with the amount, number of seconds, and number of upload,
732 download, and total bytes applied by this prepaid card.
736 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
737 #the only place that uses these args
738 sub recharge_prepay {
739 my( $self, $prepay_credit, $amountref, $secondsref,
740 $upbytesref, $downbytesref, $totalbytesref ) = @_;
742 local $SIG{HUP} = 'IGNORE';
743 local $SIG{INT} = 'IGNORE';
744 local $SIG{QUIT} = 'IGNORE';
745 local $SIG{TERM} = 'IGNORE';
746 local $SIG{TSTP} = 'IGNORE';
747 local $SIG{PIPE} = 'IGNORE';
749 my $oldAutoCommit = $FS::UID::AutoCommit;
750 local $FS::UID::AutoCommit = 0;
753 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
755 my $error = $self->get_prepay( $prepay_credit,
756 'amount_ref' => \$amount,
757 'seconds_ref' => \$seconds,
758 'upbytes_ref' => \$upbytes,
759 'downbytes_ref' => \$downbytes,
760 'totalbytes_ref' => \$totalbytes,
762 || $self->increment_seconds($seconds)
763 || $self->increment_upbytes($upbytes)
764 || $self->increment_downbytes($downbytes)
765 || $self->increment_totalbytes($totalbytes)
766 || $self->insert_cust_pay_prepay( $amount,
768 ? $prepay_credit->identifier
773 $dbh->rollback if $oldAutoCommit;
777 if ( defined($amountref) ) { $$amountref = $amount; }
778 if ( defined($secondsref) ) { $$secondsref = $seconds; }
779 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
780 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
781 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
783 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
788 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
790 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
791 specified either by I<identifier> or as an FS::prepay_credit object.
793 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
794 incremented by the values of the prepaid card.
796 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
797 check or set this customer's I<agentnum>.
799 If there is an error, returns the error, otherwise returns false.
805 my( $self, $prepay_credit, %opt ) = @_;
807 local $SIG{HUP} = 'IGNORE';
808 local $SIG{INT} = 'IGNORE';
809 local $SIG{QUIT} = 'IGNORE';
810 local $SIG{TERM} = 'IGNORE';
811 local $SIG{TSTP} = 'IGNORE';
812 local $SIG{PIPE} = 'IGNORE';
814 my $oldAutoCommit = $FS::UID::AutoCommit;
815 local $FS::UID::AutoCommit = 0;
818 unless ( ref($prepay_credit) ) {
820 my $identifier = $prepay_credit;
822 $prepay_credit = qsearchs(
824 { 'identifier' => $identifier },
829 unless ( $prepay_credit ) {
830 $dbh->rollback if $oldAutoCommit;
831 return "Invalid prepaid card: ". $identifier;
836 if ( $prepay_credit->agentnum ) {
837 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
838 $dbh->rollback if $oldAutoCommit;
839 return "prepaid card not valid for agent ". $self->agentnum;
841 $self->agentnum($prepay_credit->agentnum);
844 my $error = $prepay_credit->delete;
846 $dbh->rollback if $oldAutoCommit;
847 return "removing prepay_credit (transaction rolled back): $error";
850 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
851 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
853 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
858 =item increment_upbytes SECONDS
860 Updates this customer's single or primary account (see L<FS::svc_acct>) by
861 the specified number of upbytes. If there is an error, returns the error,
862 otherwise returns false.
866 sub increment_upbytes {
867 _increment_column( shift, 'upbytes', @_);
870 =item increment_downbytes SECONDS
872 Updates this customer's single or primary account (see L<FS::svc_acct>) by
873 the specified number of downbytes. If there is an error, returns the error,
874 otherwise returns false.
878 sub increment_downbytes {
879 _increment_column( shift, 'downbytes', @_);
882 =item increment_totalbytes SECONDS
884 Updates this customer's single or primary account (see L<FS::svc_acct>) by
885 the specified number of totalbytes. If there is an error, returns the error,
886 otherwise returns false.
890 sub increment_totalbytes {
891 _increment_column( shift, 'totalbytes', @_);
894 =item increment_seconds SECONDS
896 Updates this customer's single or primary account (see L<FS::svc_acct>) by
897 the specified number of seconds. If there is an error, returns the error,
898 otherwise returns false.
902 sub increment_seconds {
903 _increment_column( shift, 'seconds', @_);
906 =item _increment_column AMOUNT
908 Updates this customer's single or primary account (see L<FS::svc_acct>) by
909 the specified number of seconds or bytes. If there is an error, returns
910 the error, otherwise returns false.
914 sub _increment_column {
915 my( $self, $column, $amount ) = @_;
916 warn "$me increment_column called: $column, $amount\n"
919 return '' unless $amount;
921 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
922 $self->ncancelled_pkgs;
925 return 'No packages with primary or single services found'.
926 ' to apply pre-paid time';
927 } elsif ( scalar(@cust_pkg) > 1 ) {
928 #maybe have a way to specify the package/account?
929 return 'Multiple packages found to apply pre-paid time';
932 my $cust_pkg = $cust_pkg[0];
933 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
937 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
940 return 'No account found to apply pre-paid time';
941 } elsif ( scalar(@cust_svc) > 1 ) {
942 return 'Multiple accounts found to apply pre-paid time';
945 my $svc_acct = $cust_svc[0]->svc_x;
946 warn " found service svcnum ". $svc_acct->pkgnum.
947 ' ('. $svc_acct->email. ")\n"
950 $column = "increment_$column";
951 $svc_acct->$column($amount);
955 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
957 Inserts a prepayment in the specified amount for this customer. An optional
958 second argument can specify the prepayment identifier for tracking purposes.
959 If there is an error, returns the error, otherwise returns false.
963 sub insert_cust_pay_prepay {
964 shift->insert_cust_pay('PREP', @_);
967 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
969 Inserts a cash payment in the specified amount for this customer. An optional
970 second argument can specify the payment identifier for tracking purposes.
971 If there is an error, returns the error, otherwise returns false.
975 sub insert_cust_pay_cash {
976 shift->insert_cust_pay('CASH', @_);
979 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
981 Inserts a Western Union payment in the specified amount for this customer. An
982 optional second argument can specify the prepayment identifier for tracking
983 purposes. If there is an error, returns the error, otherwise returns false.
987 sub insert_cust_pay_west {
988 shift->insert_cust_pay('WEST', @_);
991 sub insert_cust_pay {
992 my( $self, $payby, $amount ) = splice(@_, 0, 3);
993 my $payinfo = scalar(@_) ? shift : '';
995 my $cust_pay = new FS::cust_pay {
996 'custnum' => $self->custnum,
997 'paid' => sprintf('%.2f', $amount),
998 #'_date' => #date the prepaid card was purchased???
1000 'payinfo' => $payinfo,
1006 =item delete [ OPTION => VALUE ... ]
1008 This deletes the customer. If there is an error, returns the error, otherwise
1011 This will completely remove all traces of the customer record. This is not
1012 what you want when a customer cancels service; for that, cancel all of the
1013 customer's packages (see L</cancel>).
1015 If the customer has any uncancelled packages, you need to pass a new (valid)
1016 customer number for those packages to be transferred to, as the "new_customer"
1017 option. Cancelled packages will be deleted. Did I mention that this is NOT
1018 what you want when a customer cancels service and that you really should be
1019 looking at L<FS::cust_pkg/cancel>?
1021 You can't delete a customer with invoices (see L<FS::cust_bill>),
1022 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1023 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1024 set the "delete_financials" option to a true value.
1029 my( $self, %opt ) = @_;
1031 local $SIG{HUP} = 'IGNORE';
1032 local $SIG{INT} = 'IGNORE';
1033 local $SIG{QUIT} = 'IGNORE';
1034 local $SIG{TERM} = 'IGNORE';
1035 local $SIG{TSTP} = 'IGNORE';
1036 local $SIG{PIPE} = 'IGNORE';
1038 my $oldAutoCommit = $FS::UID::AutoCommit;
1039 local $FS::UID::AutoCommit = 0;
1042 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1043 $dbh->rollback if $oldAutoCommit;
1044 return "Can't delete a master agent customer";
1047 #use FS::access_user
1048 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1049 $dbh->rollback if $oldAutoCommit;
1050 return "Can't delete a master employee customer";
1053 tie my %financial_tables, 'Tie::IxHash',
1054 'cust_bill' => 'invoices',
1055 'cust_statement' => 'statements',
1056 'cust_credit' => 'credits',
1057 'cust_pay' => 'payments',
1058 'cust_refund' => 'refunds',
1061 foreach my $table ( keys %financial_tables ) {
1063 my @records = $self->$table();
1065 if ( @records && ! $opt{'delete_financials'} ) {
1066 $dbh->rollback if $oldAutoCommit;
1067 return "Can't delete a customer with ". $financial_tables{$table};
1070 foreach my $record ( @records ) {
1071 my $error = $record->delete;
1073 $dbh->rollback if $oldAutoCommit;
1074 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1080 my @cust_pkg = $self->ncancelled_pkgs;
1082 my $new_custnum = $opt{'new_custnum'};
1083 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Invalid new customer number: $new_custnum";
1087 foreach my $cust_pkg ( @cust_pkg ) {
1088 my %hash = $cust_pkg->hash;
1089 $hash{'custnum'} = $new_custnum;
1090 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1091 my $error = $new_cust_pkg->replace($cust_pkg,
1092 options => { $cust_pkg->options },
1095 $dbh->rollback if $oldAutoCommit;
1100 my @cancelled_cust_pkg = $self->all_pkgs;
1101 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1102 my $error = $cust_pkg->delete;
1104 $dbh->rollback if $oldAutoCommit;
1109 #cust_tax_adjustment in financials?
1110 #cust_pay_pending? ouch
1112 foreach my $table (qw(
1113 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1114 cust_location cust_main_note cust_tax_adjustment
1115 cust_pay_void cust_pay_batch queue cust_tax_exempt
1117 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1118 my $error = $record->delete;
1120 $dbh->rollback if $oldAutoCommit;
1126 my $sth = $dbh->prepare(
1127 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1129 my $errstr = $dbh->errstr;
1130 $dbh->rollback if $oldAutoCommit;
1133 $sth->execute($self->custnum) or do {
1134 my $errstr = $sth->errstr;
1135 $dbh->rollback if $oldAutoCommit;
1141 my $ticket_dbh = '';
1142 if ($conf->config('ticket_system') eq 'RT_Internal') {
1144 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1145 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1146 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1147 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1150 if ( $ticket_dbh ) {
1152 my $ticket_sth = $ticket_dbh->prepare(
1153 'DELETE FROM Links WHERE Target = ?'
1155 my $errstr = $ticket_dbh->errstr;
1156 $dbh->rollback if $oldAutoCommit;
1159 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1161 my $errstr = $ticket_sth->errstr;
1162 $dbh->rollback if $oldAutoCommit;
1166 #check and see if the customer is the only link on the ticket, and
1167 #if so, set the ticket to deleted status in RT?
1168 #maybe someday, for now this will at least fix tickets not displaying
1172 #delete the customer record
1174 my $error = $self->SUPER::delete;
1176 $dbh->rollback if $oldAutoCommit;
1180 # cust_main exports!
1182 #my $export_args = $options{'export_args'} || [];
1185 map qsearch( 'part_export', {exportnum=>$_} ),
1186 $conf->config('cust_main-exports'); #, $agentnum
1188 foreach my $part_export ( @part_export ) {
1189 my $error = $part_export->export_delete( $self ); #, @$export_args);
1191 $dbh->rollback if $oldAutoCommit;
1192 return "exporting to ". $part_export->exporttype.
1193 " (transaction rolled back): $error";
1197 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1202 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1204 This merges this customer into the provided new custnum, and then deletes the
1205 customer. If there is an error, returns the error, otherwise returns false.
1207 The source customer's name, company name, phone numbers, agent,
1208 referring customer, customer class, advertising source, order taker, and
1209 billing information (except balance) are discarded.
1211 All packages are moved to the target customer. Packages with package locations
1212 are preserved. Packages without package locations are moved to a new package
1213 location with the source customer's service/shipping address.
1215 All invoices, statements, payments, credits and refunds are moved to the target
1216 customer. The source customer's balance is added to the target customer.
1218 All notes, attachments, tickets and customer tags are moved to the target
1221 Change history is not currently moved.
1226 my( $self, $new_custnum, %opt ) = @_;
1228 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1230 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1231 or return "Invalid new customer number: $new_custnum";
1233 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1234 if $self->agentnum != $new_cust_main->agentnum
1235 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1237 local $SIG{HUP} = 'IGNORE';
1238 local $SIG{INT} = 'IGNORE';
1239 local $SIG{QUIT} = 'IGNORE';
1240 local $SIG{TERM} = 'IGNORE';
1241 local $SIG{TSTP} = 'IGNORE';
1242 local $SIG{PIPE} = 'IGNORE';
1244 my $oldAutoCommit = $FS::UID::AutoCommit;
1245 local $FS::UID::AutoCommit = 0;
1248 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1249 $dbh->rollback if $oldAutoCommit;
1250 return "Can't merge a master agent customer";
1253 #use FS::access_user
1254 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1255 $dbh->rollback if $oldAutoCommit;
1256 return "Can't merge a master employee customer";
1259 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1260 'status' => { op=>'!=', value=>'done' },
1264 $dbh->rollback if $oldAutoCommit;
1265 return "Can't merge a customer with pending payments";
1268 tie my %financial_tables, 'Tie::IxHash',
1269 'cust_bill' => 'invoices',
1270 'cust_bill_void' => 'voided invoices',
1271 'cust_statement' => 'statements',
1272 'cust_credit' => 'credits',
1273 'cust_credit_void' => 'voided credits',
1274 'cust_pay' => 'payments',
1275 'cust_pay_void' => 'voided payments',
1276 'cust_refund' => 'refunds',
1279 foreach my $table ( keys %financial_tables ) {
1281 my @records = $self->$table();
1283 foreach my $record ( @records ) {
1284 $record->custnum($new_custnum);
1285 my $error = $record->replace;
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Error merging ". $financial_tables{$table}. ": $error\n";
1294 my $name = $self->ship_name; #?
1296 my $locationnum = '';
1297 foreach my $cust_pkg ( $self->all_pkgs ) {
1298 $cust_pkg->custnum($new_custnum);
1300 unless ( $cust_pkg->locationnum ) {
1301 unless ( $locationnum ) {
1302 my $cust_location = new FS::cust_location {
1303 $self->location_hash,
1304 'custnum' => $new_custnum,
1306 my $error = $cust_location->insert;
1308 $dbh->rollback if $oldAutoCommit;
1311 $locationnum = $cust_location->locationnum;
1313 $cust_pkg->locationnum($locationnum);
1316 my $error = $cust_pkg->replace;
1318 $dbh->rollback if $oldAutoCommit;
1322 # add customer (ship) name to svc_phone.phone_name if blank
1323 my @cust_svc = $cust_pkg->cust_svc;
1324 foreach my $cust_svc (@cust_svc) {
1325 my($label, $value, $svcdb) = $cust_svc->label;
1326 next unless $svcdb eq 'svc_phone';
1327 my $svc_phone = $cust_svc->svc_x;
1328 next if $svc_phone->phone_name;
1329 $svc_phone->phone_name($name);
1330 my $error = $svc_phone->replace;
1332 $dbh->rollback if $oldAutoCommit;
1340 # cust_tax_exempt (texas tax exemptions)
1341 # cust_recon (some sort of not-well understood thing for OnPac)
1343 #these are moved over
1344 foreach my $table (qw(
1345 cust_tag cust_location contact cust_attachment cust_main_note
1346 cust_tax_adjustment cust_pay_batch queue
1348 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1349 $record->custnum($new_custnum);
1350 my $error = $record->replace;
1352 $dbh->rollback if $oldAutoCommit;
1358 #these aren't preserved
1359 foreach my $table (qw(
1360 cust_main_exemption cust_main_invoice
1362 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1363 my $error = $record->delete;
1365 $dbh->rollback if $oldAutoCommit;
1372 my $sth = $dbh->prepare(
1373 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1375 my $errstr = $dbh->errstr;
1376 $dbh->rollback if $oldAutoCommit;
1379 $sth->execute($new_custnum, $self->custnum) or do {
1380 my $errstr = $sth->errstr;
1381 $dbh->rollback if $oldAutoCommit;
1387 my $ticket_dbh = '';
1388 if ($conf->config('ticket_system') eq 'RT_Internal') {
1390 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1391 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1392 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1393 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1396 if ( $ticket_dbh ) {
1398 my $ticket_sth = $ticket_dbh->prepare(
1399 'UPDATE Links SET Target = ? WHERE Target = ?'
1401 my $errstr = $ticket_dbh->errstr;
1402 $dbh->rollback if $oldAutoCommit;
1405 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1406 'freeside://freeside/cust_main/'.$self->custnum)
1408 my $errstr = $ticket_sth->errstr;
1409 $dbh->rollback if $oldAutoCommit;
1415 #delete the customer record
1417 my $error = $self->delete;
1419 $dbh->rollback if $oldAutoCommit;
1423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1428 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1430 Replaces the OLD_RECORD with this one in the database. If there is an error,
1431 returns the error, otherwise returns false.
1433 To change the customer's address, set the pseudo-fields C<bill_location> and
1434 C<ship_location>. The address will still only change if at least one of the
1435 address fields differs from the existing values.
1437 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1438 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1439 expected and rollback the entire transaction; it is not necessary to call
1440 check_invoicing_list first. Here's an example:
1442 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1444 Currently available options are: I<tax_exemption>.
1446 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1447 of tax names and exemption numbers. FS::cust_main_exemption records will be
1448 deleted and inserted as appropriate.
1455 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1457 : $self->replace_old;
1461 warn "$me replace called\n"
1464 my $curuser = $FS::CurrentUser::CurrentUser;
1465 if ( $self->payby eq 'COMP'
1466 && $self->payby ne $old->payby
1467 && ! $curuser->access_right('Complimentary customer')
1470 return "You are not permitted to create complimentary accounts.";
1473 local($ignore_expired_card) = 1
1474 if $old->payby =~ /^(CARD|DCRD)$/
1475 && $self->payby =~ /^(CARD|DCRD)$/
1476 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1478 local($ignore_banned_card) = 1
1479 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1480 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1481 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1483 return "Invoicing locale is required"
1486 && $conf->exists('cust_main-require_locale');
1488 local $SIG{HUP} = 'IGNORE';
1489 local $SIG{INT} = 'IGNORE';
1490 local $SIG{QUIT} = 'IGNORE';
1491 local $SIG{TERM} = 'IGNORE';
1492 local $SIG{TSTP} = 'IGNORE';
1493 local $SIG{PIPE} = 'IGNORE';
1495 my $oldAutoCommit = $FS::UID::AutoCommit;
1496 local $FS::UID::AutoCommit = 0;
1499 for my $l (qw(bill_location ship_location)) {
1500 my $old_loc = $old->$l;
1501 my $new_loc = $self->$l;
1503 # find the existing location if there is one
1504 $new_loc->set('custnum' => $self->custnum);
1505 my $error = $new_loc->find_or_insert;
1507 $dbh->rollback if $oldAutoCommit;
1510 $self->set($l.'num', $new_loc->locationnum);
1513 # replace the customer record
1514 my $error = $self->SUPER::replace($old);
1517 $dbh->rollback if $oldAutoCommit;
1521 # now move packages to the new service location
1522 $self->set('ship_location', ''); #flush cache
1523 if ( $old->ship_locationnum and # should only be null during upgrade...
1524 $old->ship_locationnum != $self->ship_locationnum ) {
1525 $error = $old->ship_location->move_to($self->ship_location);
1527 $dbh->rollback if $oldAutoCommit;
1531 # don't move packages based on the billing location, but
1532 # disable it if it's no longer in use
1533 if ( $old->bill_locationnum and
1534 $old->bill_locationnum != $self->bill_locationnum ) {
1535 $error = $old->bill_location->disable_if_unused;
1537 $dbh->rollback if $oldAutoCommit;
1542 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1543 my $invoicing_list = shift @param;
1544 $error = $self->check_invoicing_list( $invoicing_list );
1546 $dbh->rollback if $oldAutoCommit;
1549 $self->invoicing_list( $invoicing_list );
1552 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1554 #this could be more efficient than deleting and re-inserting, if it matters
1555 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1556 my $error = $cust_tag->delete;
1558 $dbh->rollback if $oldAutoCommit;
1562 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1563 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1564 'custnum' => $self->custnum };
1565 my $error = $cust_tag->insert;
1567 $dbh->rollback if $oldAutoCommit;
1574 my %options = @param;
1576 my $tax_exemption = delete $options{'tax_exemption'};
1577 if ( $tax_exemption ) {
1579 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1580 if ref($tax_exemption) eq 'ARRAY';
1582 my %cust_main_exemption =
1583 map { $_->taxname => $_ }
1584 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1586 foreach my $taxname ( keys %$tax_exemption ) {
1588 if ( $cust_main_exemption{$taxname} &&
1589 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1592 delete $cust_main_exemption{$taxname};
1596 my $cust_main_exemption = new FS::cust_main_exemption {
1597 'custnum' => $self->custnum,
1598 'taxname' => $taxname,
1599 'exempt_number' => $tax_exemption->{$taxname},
1601 my $error = $cust_main_exemption->insert;
1603 $dbh->rollback if $oldAutoCommit;
1604 return "inserting cust_main_exemption (transaction rolled back): $error";
1608 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1609 my $error = $cust_main_exemption->delete;
1611 $dbh->rollback if $oldAutoCommit;
1612 return "deleting cust_main_exemption (transaction rolled back): $error";
1618 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1619 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1620 && $self->get('payinfo') !~ /^99\d{14}$/
1622 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1627 # card/check/lec info has changed, want to retry realtime_ invoice events
1628 my $error = $self->retry_realtime;
1630 $dbh->rollback if $oldAutoCommit;
1635 unless ( $import || $skip_fuzzyfiles ) {
1636 $error = $self->queue_fuzzyfiles_update;
1638 $dbh->rollback if $oldAutoCommit;
1639 return "updating fuzzy search cache: $error";
1643 # tax district update in cust_location
1645 # cust_main exports!
1647 my $export_args = $options{'export_args'} || [];
1650 map qsearch( 'part_export', {exportnum=>$_} ),
1651 $conf->config('cust_main-exports'); #, $agentnum
1653 foreach my $part_export ( @part_export ) {
1654 my $error = $part_export->export_replace( $self, $old, @$export_args);
1656 $dbh->rollback if $oldAutoCommit;
1657 return "exporting to ". $part_export->exporttype.
1658 " (transaction rolled back): $error";
1662 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1667 =item queue_fuzzyfiles_update
1669 Used by insert & replace to update the fuzzy search cache
1673 use FS::cust_main::Search;
1674 sub queue_fuzzyfiles_update {
1677 local $SIG{HUP} = 'IGNORE';
1678 local $SIG{INT} = 'IGNORE';
1679 local $SIG{QUIT} = 'IGNORE';
1680 local $SIG{TERM} = 'IGNORE';
1681 local $SIG{TSTP} = 'IGNORE';
1682 local $SIG{PIPE} = 'IGNORE';
1684 my $oldAutoCommit = $FS::UID::AutoCommit;
1685 local $FS::UID::AutoCommit = 0;
1688 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1689 my $queue = new FS::queue {
1690 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1692 my @args = "cust_main.$field", $self->get($field);
1693 my $error = $queue->insert( @args );
1695 $dbh->rollback if $oldAutoCommit;
1696 return "queueing job (transaction rolled back): $error";
1701 push @locations, $self->bill_location if $self->bill_locationnum;
1702 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1703 foreach my $location (@locations) {
1704 my $queue = new FS::queue {
1705 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1707 my @args = 'cust_location.address1', $location->address1;
1708 my $error = $queue->insert( @args );
1710 $dbh->rollback if $oldAutoCommit;
1711 return "queueing job (transaction rolled back): $error";
1715 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1722 Checks all fields to make sure this is a valid customer record. If there is
1723 an error, returns the error, otherwise returns false. Called by the insert
1724 and replace methods.
1731 warn "$me check BEFORE: \n". $self->_dump
1735 $self->ut_numbern('custnum')
1736 || $self->ut_number('agentnum')
1737 || $self->ut_textn('agent_custid')
1738 || $self->ut_number('refnum')
1739 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1740 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1741 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1742 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1743 || $self->ut_textn('custbatch')
1744 || $self->ut_name('last')
1745 || $self->ut_name('first')
1746 || $self->ut_snumbern('signupdate')
1747 || $self->ut_snumbern('birthdate')
1748 || $self->ut_namen('spouse_last')
1749 || $self->ut_namen('spouse_first')
1750 || $self->ut_snumbern('spouse_birthdate')
1751 || $self->ut_snumbern('anniversary_date')
1752 || $self->ut_textn('company')
1753 || $self->ut_textn('ship_company')
1754 || $self->ut_anything('comments')
1755 || $self->ut_numbern('referral_custnum')
1756 || $self->ut_textn('stateid')
1757 || $self->ut_textn('stateid_state')
1758 || $self->ut_textn('invoice_terms')
1759 || $self->ut_floatn('cdr_termination_percentage')
1760 || $self->ut_floatn('credit_limit')
1761 || $self->ut_numbern('billday')
1762 || $self->ut_numbern('prorate_day')
1763 || $self->ut_flag('edit_subject')
1764 || $self->ut_flag('calling_list_exempt')
1765 || $self->ut_flag('invoice_noemail')
1766 || $self->ut_flag('message_noemail')
1767 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1768 || $self->ut_currencyn('currency')
1771 foreach (qw(company ship_company)) {
1772 my $company = $self->get($_);
1773 $company =~ s/^\s+//;
1774 $company =~ s/\s+$//;
1775 $company =~ s/\s+/ /g;
1776 $self->set($_, $company);
1779 #barf. need message catalogs. i18n. etc.
1780 $error .= "Please select an advertising source."
1781 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1782 return $error if $error;
1784 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1785 or return "Unknown agent";
1787 if ( $self->currency ) {
1788 my $agent_currency = qsearchs( 'agent_currency', {
1789 'agentnum' => $agent->agentnum,
1790 'currency' => $self->currency,
1792 or return "Agent ". $agent->agent.
1793 " not permitted to offer ". $self->currency. " invoicing";
1796 return "Unknown refnum"
1797 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1799 return "Unknown referring custnum: ". $self->referral_custnum
1800 unless ! $self->referral_custnum
1801 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1803 if ( $self->ss eq '' ) {
1808 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1809 or return "Illegal social security number: ". $self->ss;
1810 $self->ss("$1-$2-$3");
1813 # cust_main_county verification now handled by cust_location check
1816 $self->ut_phonen('daytime', $self->country)
1817 || $self->ut_phonen('night', $self->country)
1818 || $self->ut_phonen('fax', $self->country)
1819 || $self->ut_phonen('mobile', $self->country)
1821 return $error if $error;
1823 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1825 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1828 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1830 : FS::Msgcat::_gettext('daytime');
1831 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1833 : FS::Msgcat::_gettext('night');
1835 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1837 : FS::Msgcat::_gettext('mobile');
1839 return "$daytime_label, $night_label or $mobile_label is required"
1843 ### start of stuff moved to cust_payby
1844 # then mostly kept here to support upgrades (can remove in 5.x)
1845 # but modified to allow everything to be empty
1847 if ( $self->payby ) {
1848 FS::payby->can_payby($self->table, $self->payby)
1849 or return "Illegal payby: ". $self->payby;
1854 $error = $self->ut_numbern('paystart_month')
1855 || $self->ut_numbern('paystart_year')
1856 || $self->ut_numbern('payissue')
1857 || $self->ut_textn('paytype')
1859 return $error if $error;
1861 if ( $self->payip eq '' ) {
1864 $error = $self->ut_ip('payip');
1865 return $error if $error;
1868 # If it is encrypted and the private key is not availaible then we can't
1869 # check the credit card.
1870 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1872 # Need some kind of global flag to accept invalid cards, for testing
1874 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1875 $self->payby =~ /^(CARD|DCRD)$/ ) {
1877 my $payinfo = $self->payinfo;
1878 $payinfo =~ s/\D//g;
1879 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1880 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1882 $self->payinfo($payinfo);
1884 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1886 return gettext('unknown_card_type')
1887 if $self->payinfo !~ /^99\d{14}$/ #token
1888 && cardtype($self->payinfo) eq "Unknown";
1890 unless ( $ignore_banned_card ) {
1891 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1893 if ( $ban->bantype eq 'warn' ) {
1894 #or others depending on value of $ban->reason ?
1895 return '_duplicate_card'.
1896 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1897 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1898 ' (ban# '. $ban->bannum. ')'
1899 unless $self->override_ban_warn;
1901 return 'Banned credit card: banned on '.
1902 time2str('%a %h %o at %r', $ban->_date).
1903 ' by '. $ban->otaker.
1904 ' (ban# '. $ban->bannum. ')';
1909 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1910 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1911 $self->paycvv =~ /^(\d{4})$/
1912 or return "CVV2 (CID) for American Express cards is four digits.";
1915 $self->paycvv =~ /^(\d{3})$/
1916 or return "CVV2 (CVC2/CID) is three digits.";
1923 my $cardtype = cardtype($payinfo);
1924 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1926 return "Start date or issue number is required for $cardtype cards"
1927 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1929 return "Start month must be between 1 and 12"
1930 if $self->paystart_month
1931 and $self->paystart_month < 1 || $self->paystart_month > 12;
1933 return "Start year must be 1990 or later"
1934 if $self->paystart_year
1935 and $self->paystart_year < 1990;
1937 return "Issue number must be beween 1 and 99"
1939 and $self->payissue < 1 || $self->payissue > 99;
1942 $self->paystart_month('');
1943 $self->paystart_year('');
1944 $self->payissue('');
1947 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1948 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1950 my $payinfo = $self->payinfo;
1951 $payinfo =~ s/[^\d\@\.]//g;
1952 if ( $conf->config('echeck-country') eq 'CA' ) {
1953 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1954 or return 'invalid echeck account@branch.bank';
1955 $payinfo = "$1\@$2.$3";
1956 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1957 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1958 $payinfo = "$1\@$2";
1960 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1961 $payinfo = "$1\@$2";
1963 $self->payinfo($payinfo);
1966 unless ( $ignore_banned_card ) {
1967 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1969 if ( $ban->bantype eq 'warn' ) {
1970 #or others depending on value of $ban->reason ?
1971 return '_duplicate_ach' unless $self->override_ban_warn;
1973 return 'Banned ACH account: banned on '.
1974 time2str('%a %h %o at %r', $ban->_date).
1975 ' by '. $ban->otaker.
1976 ' (ban# '. $ban->bannum. ')';
1981 } elsif ( $self->payby eq 'LECB' ) {
1983 my $payinfo = $self->payinfo;
1984 $payinfo =~ s/\D//g;
1985 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1987 $self->payinfo($payinfo);
1990 } elsif ( $self->payby eq 'BILL' ) {
1992 $error = $self->ut_textn('payinfo');
1993 return "Illegal P.O. number: ". $self->payinfo if $error;
1996 } elsif ( $self->payby eq 'COMP' ) {
1998 my $curuser = $FS::CurrentUser::CurrentUser;
1999 if ( ! $self->custnum
2000 && ! $curuser->access_right('Complimentary customer')
2003 return "You are not permitted to create complimentary accounts."
2006 $error = $self->ut_textn('payinfo');
2007 return "Illegal comp account issuer: ". $self->payinfo if $error;
2010 } elsif ( $self->payby eq 'PREPAY' ) {
2012 my $payinfo = $self->payinfo;
2013 $payinfo =~ s/\W//g; #anything else would just confuse things
2014 $self->payinfo($payinfo);
2015 $error = $self->ut_alpha('payinfo');
2016 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2017 return "Unknown prepayment identifier"
2018 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2023 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2024 return "Expiration date required"
2025 # shouldn't payinfo_check do this?
2026 unless ! $self->payby
2027 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2031 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2032 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2033 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2034 ( $m, $y ) = ( $2, "19$1" );
2035 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2036 ( $m, $y ) = ( $3, "20$2" );
2038 return "Illegal expiration date: ". $self->paydate;
2040 $m = sprintf('%02d',$m);
2041 $self->paydate("$y-$m-01");
2042 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2043 return gettext('expired_card')
2045 && !$ignore_expired_card
2046 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2049 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2050 ( ! $conf->exists('require_cardname')
2051 || $self->payby !~ /^(CARD|DCRD)$/ )
2053 $self->payname( $self->first. " ". $self->getfield('last') );
2056 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2057 $self->payname =~ /^([\w \,\.\-\']*)$/
2058 or return gettext('illegal_name'). " payname: ". $self->payname;
2061 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2062 or return gettext('illegal_name'). " payname: ". $self->payname;
2068 ### end of stuff moved to cust_payby
2070 return "Please select an invoicing locale"
2073 && $conf->exists('cust_main-require_locale');
2075 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2076 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2080 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2082 warn "$me check AFTER: \n". $self->_dump
2085 $self->SUPER::check;
2090 Returns a list of fields which have ship_ duplicates.
2095 qw( last first company
2096 address1 address2 city county state zip country
2098 daytime night fax mobile
2102 =item has_ship_address
2104 Returns true if this customer record has a separate shipping address.
2108 sub has_ship_address {
2110 $self->bill_locationnum != $self->ship_locationnum;
2115 Returns a list of key/value pairs, with the following keys: address1,
2116 adddress2, city, county, state, zip, country, district, and geocode. The
2117 shipping address is used if present.
2123 $self->ship_location->location_hash;
2128 Returns all locations (see L<FS::cust_location>) for this customer.
2134 qsearch('cust_location', { 'custnum' => $self->custnum,
2135 'prospectnum' => '' } );
2140 Returns all contacts (see L<FS::contact>) for this customer.
2144 #already used :/ sub contact {
2147 qsearch('contact', { 'custnum' => $self->custnum } );
2152 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2159 'table' => 'cust_payby',
2160 'hashref' => { 'custnum' => $self->custnum },
2161 'order_by' => 'ORDER BY weight ASC',
2167 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2168 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2169 on success or a list of errors.
2175 grep { $_->unsuspend } $self->suspended_pkgs;
2180 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2182 Returns a list: an empty list on success or a list of errors.
2188 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2191 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2193 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2194 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2195 of a list of pkgparts; the hashref has the following keys:
2199 =item pkgparts - listref of pkgparts
2201 =item (other options are passed to the suspend method)
2206 Returns a list: an empty list on success or a list of errors.
2210 sub suspend_if_pkgpart {
2212 my (@pkgparts, %opt);
2213 if (ref($_[0]) eq 'HASH'){
2214 @pkgparts = @{$_[0]{pkgparts}};
2219 grep { $_->suspend(%opt) }
2220 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2221 $self->unsuspended_pkgs;
2224 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2226 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2227 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2228 instead of a list of pkgparts; the hashref has the following keys:
2232 =item pkgparts - listref of pkgparts
2234 =item (other options are passed to the suspend method)
2238 Returns a list: an empty list on success or a list of errors.
2242 sub suspend_unless_pkgpart {
2244 my (@pkgparts, %opt);
2245 if (ref($_[0]) eq 'HASH'){
2246 @pkgparts = @{$_[0]{pkgparts}};
2251 grep { $_->suspend(%opt) }
2252 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2253 $self->unsuspended_pkgs;
2256 =item cancel [ OPTION => VALUE ... ]
2258 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2260 Available options are:
2264 =item quiet - can be set true to supress email cancellation notices.
2266 =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.
2268 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2270 =item nobill - can be set true to skip billing if it might otherwise be done.
2274 Always returns a list: an empty list on success or a list of errors.
2278 # nb that dates are not specified as valid options to this method
2281 my( $self, %opt ) = @_;
2283 warn "$me cancel called on customer ". $self->custnum. " with options ".
2284 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2287 return ( 'access denied' )
2288 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2290 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2292 #should try decryption (we might have the private key)
2293 # and if not maybe queue a job for the server that does?
2294 return ( "Can't (yet) ban encrypted credit cards" )
2295 if $self->is_encrypted($self->payinfo);
2297 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2298 my $error = $ban->insert;
2299 return ( $error ) if $error;
2303 my @pkgs = $self->ncancelled_pkgs;
2305 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2307 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2308 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2312 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2313 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2316 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2319 sub _banned_pay_hashref {
2330 'payby' => $payby2ban{$self->payby},
2331 'payinfo' => $self->payinfo,
2332 #don't ever *search* on reason! #'reason' =>
2336 sub _new_banned_pay_hashref {
2338 my $hr = $self->_banned_pay_hashref;
2339 $hr->{payinfo} = md5_base64($hr->{payinfo});
2345 Returns all notes (see L<FS::cust_main_note>) for this customer.
2350 my($self,$orderby_classnum) = (shift,shift);
2351 my $orderby = "_DATE DESC";
2352 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2353 qsearch( 'cust_main_note',
2354 { 'custnum' => $self->custnum },
2356 "ORDER BY $orderby",
2362 Returns the agent (see L<FS::agent>) for this customer.
2366 Returns the agent name (see L<FS::agent>) for this customer.
2372 $self->agent->agent;
2377 Returns any tags associated with this customer, as FS::cust_tag objects,
2378 or an empty list if there are no tags.
2382 Returns any tags associated with this customer, as FS::part_tag objects,
2383 or an empty list if there are no tags.
2389 map $_->part_tag, $self->cust_tag;
2395 Returns the customer class, as an FS::cust_class object, or the empty string
2396 if there is no customer class.
2400 Returns the customer category name, or the empty string if there is no customer
2407 my $cust_class = $self->cust_class;
2409 ? $cust_class->categoryname
2415 Returns the customer class name, or the empty string if there is no customer
2422 my $cust_class = $self->cust_class;
2424 ? $cust_class->classname
2428 =item BILLING METHODS
2430 Documentation on billing methods has been moved to
2431 L<FS::cust_main::Billing>.
2433 =item REALTIME BILLING METHODS
2435 Documentation on realtime billing methods has been moved to
2436 L<FS::cust_main::Billing_Realtime>.
2440 Removes the I<paycvv> field from the database directly.
2442 If there is an error, returns the error, otherwise returns false.
2448 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2449 or return dbh->errstr;
2450 $sth->execute($self->custnum)
2451 or return $sth->errstr;
2456 =item batch_card OPTION => VALUE...
2458 Adds a payment for this invoice to the pending credit card batch (see
2459 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2460 runs the payment using a realtime gateway.
2462 Options may include:
2464 B<amount>: the amount to be paid; defaults to the customer's balance minus
2465 any payments in transit.
2467 B<payby>: the payment method; defaults to cust_main.payby
2469 B<realtime>: runs this as a realtime payment instead of adding it to a
2472 B<invnum>: sets cust_pay_batch.invnum.
2474 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2475 the billing address for the payment; defaults to the customer's billing
2478 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2479 date, and name; defaults to those fields in cust_main.
2484 my ($self, %options) = @_;
2487 if (exists($options{amount})) {
2488 $amount = $options{amount};
2490 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2492 return '' unless $amount > 0;
2494 my $invnum = delete $options{invnum};
2495 my $payby = $options{payby} || $self->payby; #still dubious
2497 if ($options{'realtime'}) {
2498 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2504 my $oldAutoCommit = $FS::UID::AutoCommit;
2505 local $FS::UID::AutoCommit = 0;
2508 #this needs to handle mysql as well as Pg, like svc_acct.pm
2509 #(make it into a common function if folks need to do batching with mysql)
2510 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2511 or return "Cannot lock pay_batch: " . $dbh->errstr;
2515 'payby' => FS::payby->payby2payment($payby),
2517 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2519 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2521 unless ( $pay_batch ) {
2522 $pay_batch = new FS::pay_batch \%pay_batch;
2523 my $error = $pay_batch->insert;
2525 $dbh->rollback if $oldAutoCommit;
2526 die "error creating new batch: $error\n";
2530 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2531 'batchnum' => $pay_batch->batchnum,
2532 'custnum' => $self->custnum,
2535 foreach (qw( address1 address2 city state zip country latitude longitude
2536 payby payinfo paydate payname ))
2538 $options{$_} = '' unless exists($options{$_});
2541 my $loc = $self->bill_location;
2543 my $cust_pay_batch = new FS::cust_pay_batch ( {
2544 'batchnum' => $pay_batch->batchnum,
2545 'invnum' => $invnum || 0, # is there a better value?
2546 # this field should be
2548 # cust_bill_pay_batch now
2549 'custnum' => $self->custnum,
2550 'last' => $self->getfield('last'),
2551 'first' => $self->getfield('first'),
2552 'address1' => $options{address1} || $loc->address1,
2553 'address2' => $options{address2} || $loc->address2,
2554 'city' => $options{city} || $loc->city,
2555 'state' => $options{state} || $loc->state,
2556 'zip' => $options{zip} || $loc->zip,
2557 'country' => $options{country} || $loc->country,
2558 'payby' => $options{payby} || $self->payby,
2559 'payinfo' => $options{payinfo} || $self->payinfo,
2560 'exp' => $options{paydate} || $self->paydate,
2561 'payname' => $options{payname} || $self->payname,
2562 'amount' => $amount, # consolidating
2565 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2566 if $old_cust_pay_batch;
2569 if ($old_cust_pay_batch) {
2570 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2572 $error = $cust_pay_batch->insert;
2576 $dbh->rollback if $oldAutoCommit;
2580 my $unapplied = $self->total_unapplied_credits
2581 + $self->total_unapplied_payments
2582 + $self->in_transit_payments;
2583 foreach my $cust_bill ($self->open_cust_bill) {
2584 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2585 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2586 'invnum' => $cust_bill->invnum,
2587 'paybatchnum' => $cust_pay_batch->paybatchnum,
2588 'amount' => $cust_bill->owed,
2591 if ($unapplied >= $cust_bill_pay_batch->amount){
2592 $unapplied -= $cust_bill_pay_batch->amount;
2595 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2596 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2598 $error = $cust_bill_pay_batch->insert;
2600 $dbh->rollback if $oldAutoCommit;
2605 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2611 Returns the total owed for this customer on all invoices
2612 (see L<FS::cust_bill/owed>).
2618 $self->total_owed_date(2145859200); #12/31/2037
2621 =item total_owed_date TIME
2623 Returns the total owed for this customer on all invoices with date earlier than
2624 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2625 see L<Time::Local> and L<Date::Parse> for conversion functions.
2629 sub total_owed_date {
2633 my $custnum = $self->custnum;
2635 my $owed_sql = FS::cust_bill->owed_sql;
2638 SELECT SUM($owed_sql) FROM cust_bill
2639 WHERE custnum = $custnum
2643 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2647 =item total_owed_pkgnum PKGNUM
2649 Returns the total owed on all invoices for this customer's specific package
2650 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2654 sub total_owed_pkgnum {
2655 my( $self, $pkgnum ) = @_;
2656 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2659 =item total_owed_date_pkgnum TIME PKGNUM
2661 Returns the total owed for this customer's specific package when using
2662 experimental package balances on all invoices with date earlier than
2663 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2664 see L<Time::Local> and L<Date::Parse> for conversion functions.
2668 sub total_owed_date_pkgnum {
2669 my( $self, $time, $pkgnum ) = @_;
2672 foreach my $cust_bill (
2673 grep { $_->_date <= $time }
2674 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2676 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2678 sprintf( "%.2f", $total_bill );
2684 Returns the total amount of all payments.
2691 $total += $_->paid foreach $self->cust_pay;
2692 sprintf( "%.2f", $total );
2695 =item total_unapplied_credits
2697 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2698 customer. See L<FS::cust_credit/credited>.
2700 =item total_credited
2702 Old name for total_unapplied_credits. Don't use.
2706 sub total_credited {
2707 #carp "total_credited deprecated, use total_unapplied_credits";
2708 shift->total_unapplied_credits(@_);
2711 sub total_unapplied_credits {
2714 my $custnum = $self->custnum;
2716 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2719 SELECT SUM($unapplied_sql) FROM cust_credit
2720 WHERE custnum = $custnum
2723 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2727 =item total_unapplied_credits_pkgnum PKGNUM
2729 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2730 customer. See L<FS::cust_credit/credited>.
2734 sub total_unapplied_credits_pkgnum {
2735 my( $self, $pkgnum ) = @_;
2736 my $total_credit = 0;
2737 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2738 sprintf( "%.2f", $total_credit );
2742 =item total_unapplied_payments
2744 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2745 See L<FS::cust_pay/unapplied>.
2749 sub total_unapplied_payments {
2752 my $custnum = $self->custnum;
2754 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2757 SELECT SUM($unapplied_sql) FROM cust_pay
2758 WHERE custnum = $custnum
2761 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2765 =item total_unapplied_payments_pkgnum PKGNUM
2767 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2768 specific package when using experimental package balances. See
2769 L<FS::cust_pay/unapplied>.
2773 sub total_unapplied_payments_pkgnum {
2774 my( $self, $pkgnum ) = @_;
2775 my $total_unapplied = 0;
2776 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2777 sprintf( "%.2f", $total_unapplied );
2781 =item total_unapplied_refunds
2783 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2784 customer. See L<FS::cust_refund/unapplied>.
2788 sub total_unapplied_refunds {
2790 my $custnum = $self->custnum;
2792 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2795 SELECT SUM($unapplied_sql) FROM cust_refund
2796 WHERE custnum = $custnum
2799 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2805 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2806 total_unapplied_credits minus total_unapplied_payments).
2812 $self->balance_date_range;
2815 =item balance_date TIME
2817 Returns the balance for this customer, only considering invoices with date
2818 earlier than TIME (total_owed_date minus total_credited minus
2819 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2820 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2827 $self->balance_date_range(shift);
2830 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2832 Returns the balance for this customer, optionally considering invoices with
2833 date earlier than START_TIME, and not later than END_TIME
2834 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2836 Times are specified as SQL fragments or numeric
2837 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2838 L<Date::Parse> for conversion functions. The empty string can be passed
2839 to disable that time constraint completely.
2841 Accepts the same options as L<balance_date_sql>:
2845 =item unapplied_date
2847 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)
2851 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2852 time will be ignored. Note that START_TIME and END_TIME only limit the date
2853 range for invoices and I<unapplied> payments, credits, and refunds.
2859 sub balance_date_range {
2861 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2862 ') FROM cust_main WHERE custnum='. $self->custnum;
2863 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2866 =item balance_pkgnum PKGNUM
2868 Returns the balance for this customer's specific package when using
2869 experimental package balances (total_owed plus total_unrefunded, minus
2870 total_unapplied_credits minus total_unapplied_payments)
2874 sub balance_pkgnum {
2875 my( $self, $pkgnum ) = @_;
2878 $self->total_owed_pkgnum($pkgnum)
2879 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2880 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2881 - $self->total_unapplied_credits_pkgnum($pkgnum)
2882 - $self->total_unapplied_payments_pkgnum($pkgnum)
2886 =item in_transit_payments
2888 Returns the total of requests for payments for this customer pending in
2889 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2893 sub in_transit_payments {
2895 my $in_transit_payments = 0;
2896 foreach my $pay_batch ( qsearch('pay_batch', {
2899 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2900 'batchnum' => $pay_batch->batchnum,
2901 'custnum' => $self->custnum,
2903 $in_transit_payments += $cust_pay_batch->amount;
2906 sprintf( "%.2f", $in_transit_payments );
2911 Returns a hash of useful information for making a payment.
2921 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2922 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2923 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2927 For credit card transactions:
2939 For electronic check transactions:
2954 $return{balance} = $self->balance;
2956 $return{payname} = $self->payname
2957 || ( $self->first. ' '. $self->get('last') );
2959 $return{$_} = $self->bill_location->$_
2960 for qw(address1 address2 city state zip);
2962 $return{payby} = $self->payby;
2963 $return{stateid_state} = $self->stateid_state;
2965 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2966 $return{card_type} = cardtype($self->payinfo);
2967 $return{payinfo} = $self->paymask;
2969 @return{'month', 'year'} = $self->paydate_monthyear;
2973 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2974 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2975 $return{payinfo1} = $payinfo1;
2976 $return{payinfo2} = $payinfo2;
2977 $return{paytype} = $self->paytype;
2978 $return{paystate} = $self->paystate;
2982 #doubleclick protection
2984 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2990 =item paydate_monthyear
2992 Returns a two-element list consisting of the month and year of this customer's
2993 paydate (credit card expiration date for CARD customers)
2997 sub paydate_monthyear {
2999 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3001 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3010 Returns the exact time in seconds corresponding to the payment method
3011 expiration date. For CARD/DCRD customers this is the end of the month;
3012 for others (COMP is the only other payby that uses paydate) it's the start.
3013 Returns 0 if the paydate is empty or set to the far future.
3019 my ($month, $year) = $self->paydate_monthyear;
3020 return 0 if !$year or $year >= 2037;
3021 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3023 if ( $month == 13 ) {
3027 return timelocal(0,0,0,1,$month-1,$year) - 1;
3030 return timelocal(0,0,0,1,$month-1,$year);
3034 =item paydate_epoch_sql
3036 Class method. Returns an SQL expression to obtain the payment expiration date
3037 as a number of seconds.
3041 # Special expiration date behavior for non-CARD/DCRD customers has been
3042 # carefully preserved. Do we really use that?
3043 sub paydate_epoch_sql {
3045 my $table = shift || 'cust_main';
3046 my ($case1, $case2);
3047 if ( driver_name eq 'Pg' ) {
3048 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3049 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3051 elsif ( lc(driver_name) eq 'mysql' ) {
3052 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3053 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3056 return "CASE WHEN $table.payby IN('CARD','DCRD')
3062 =item tax_exemption TAXNAME
3067 my( $self, $taxname ) = @_;
3069 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3070 'taxname' => $taxname,
3075 =item cust_main_exemption
3077 =item invoicing_list [ ARRAYREF ]
3079 If an arguement is given, sets these email addresses as invoice recipients
3080 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3081 (except as warnings), so use check_invoicing_list first.
3083 Returns a list of email addresses (with svcnum entries expanded).
3085 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3086 check it without disturbing anything by passing nothing.
3088 This interface may change in the future.
3092 sub invoicing_list {
3093 my( $self, $arrayref ) = @_;
3096 my @cust_main_invoice;
3097 if ( $self->custnum ) {
3098 @cust_main_invoice =
3099 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3101 @cust_main_invoice = ();
3103 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3104 #warn $cust_main_invoice->destnum;
3105 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3106 #warn $cust_main_invoice->destnum;
3107 my $error = $cust_main_invoice->delete;
3108 warn $error if $error;
3111 if ( $self->custnum ) {
3112 @cust_main_invoice =
3113 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3115 @cust_main_invoice = ();
3117 my %seen = map { $_->address => 1 } @cust_main_invoice;
3118 foreach my $address ( @{$arrayref} ) {
3119 next if exists $seen{$address} && $seen{$address};
3120 $seen{$address} = 1;
3121 my $cust_main_invoice = new FS::cust_main_invoice ( {
3122 'custnum' => $self->custnum,
3125 my $error = $cust_main_invoice->insert;
3126 warn $error if $error;
3130 if ( $self->custnum ) {
3132 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3139 =item check_invoicing_list ARRAYREF
3141 Checks these arguements as valid input for the invoicing_list method. If there
3142 is an error, returns the error, otherwise returns false.
3146 sub check_invoicing_list {
3147 my( $self, $arrayref ) = @_;
3149 foreach my $address ( @$arrayref ) {
3151 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3152 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3155 my $cust_main_invoice = new FS::cust_main_invoice ( {
3156 'custnum' => $self->custnum,
3159 my $error = $self->custnum
3160 ? $cust_main_invoice->check
3161 : $cust_main_invoice->checkdest
3163 return $error if $error;
3167 return "Email address required"
3168 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3169 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3174 =item set_default_invoicing_list
3176 Sets the invoicing list to all accounts associated with this customer,
3177 overwriting any previous invoicing list.
3181 sub set_default_invoicing_list {
3183 $self->invoicing_list($self->all_emails);
3188 Returns the email addresses of all accounts provisioned for this customer.
3195 foreach my $cust_pkg ( $self->all_pkgs ) {
3196 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3198 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3199 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3201 $list{$_}=1 foreach map { $_->email } @svc_acct;
3206 =item invoicing_list_addpost
3208 Adds postal invoicing to this customer. If this customer is already configured
3209 to receive postal invoices, does nothing.
3213 sub invoicing_list_addpost {
3215 return if grep { $_ eq 'POST' } $self->invoicing_list;
3216 my @invoicing_list = $self->invoicing_list;
3217 push @invoicing_list, 'POST';
3218 $self->invoicing_list(\@invoicing_list);
3221 =item invoicing_list_emailonly
3223 Returns the list of email invoice recipients (invoicing_list without non-email
3224 destinations such as POST and FAX).
3228 sub invoicing_list_emailonly {
3230 warn "$me invoicing_list_emailonly called"
3232 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3235 =item invoicing_list_emailonly_scalar
3237 Returns the list of email invoice recipients (invoicing_list without non-email
3238 destinations such as POST and FAX) as a comma-separated scalar.
3242 sub invoicing_list_emailonly_scalar {
3244 warn "$me invoicing_list_emailonly_scalar called"
3246 join(', ', $self->invoicing_list_emailonly);
3249 =item referral_custnum_cust_main
3251 Returns the customer who referred this customer (or the empty string, if
3252 this customer was not referred).
3254 Note the difference with referral_cust_main method: This method,
3255 referral_custnum_cust_main returns the single customer (if any) who referred
3256 this customer, while referral_cust_main returns an array of customers referred
3261 sub referral_custnum_cust_main {
3263 return '' unless $self->referral_custnum;
3264 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3267 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3269 Returns an array of customers referred by this customer (referral_custnum set
3270 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3271 customers referred by customers referred by this customer and so on, inclusive.
3272 The default behavior is DEPTH 1 (no recursion).
3274 Note the difference with referral_custnum_cust_main method: This method,
3275 referral_cust_main, returns an array of customers referred BY this customer,
3276 while referral_custnum_cust_main returns the single customer (if any) who
3277 referred this customer.
3281 sub referral_cust_main {
3283 my $depth = @_ ? shift : 1;
3284 my $exclude = @_ ? shift : {};
3287 map { $exclude->{$_->custnum}++; $_; }
3288 grep { ! $exclude->{ $_->custnum } }
3289 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3293 map { $_->referral_cust_main($depth-1, $exclude) }
3300 =item referral_cust_main_ncancelled
3302 Same as referral_cust_main, except only returns customers with uncancelled
3307 sub referral_cust_main_ncancelled {
3309 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3312 =item referral_cust_pkg [ DEPTH ]
3314 Like referral_cust_main, except returns a flat list of all unsuspended (and
3315 uncancelled) packages for each customer. The number of items in this list may
3316 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3320 sub referral_cust_pkg {
3322 my $depth = @_ ? shift : 1;
3324 map { $_->unsuspended_pkgs }
3325 grep { $_->unsuspended_pkgs }
3326 $self->referral_cust_main($depth);
3329 =item referring_cust_main
3331 Returns the single cust_main record for the customer who referred this customer
3332 (referral_custnum), or false.
3336 sub referring_cust_main {
3338 return '' unless $self->referral_custnum;
3339 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3342 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3344 Applies a credit to this customer. If there is an error, returns the error,
3345 otherwise returns false.
3347 REASON can be a text string, an FS::reason object, or a scalar reference to
3348 a reasonnum. If a text string, it will be automatically inserted as a new
3349 reason, and a 'reason_type' option must be passed to indicate the
3350 FS::reason_type for the new reason.
3352 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3353 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3354 I<commission_pkgnum>.
3356 Any other options are passed to FS::cust_credit::insert.
3361 my( $self, $amount, $reason, %options ) = @_;
3363 my $cust_credit = new FS::cust_credit {
3364 'custnum' => $self->custnum,
3365 'amount' => $amount,
3368 if ( ref($reason) ) {
3370 if ( ref($reason) eq 'SCALAR' ) {
3371 $cust_credit->reasonnum( $$reason );
3373 $cust_credit->reasonnum( $reason->reasonnum );
3377 $cust_credit->set('reason', $reason)
3380 $cust_credit->$_( delete $options{$_} )
3381 foreach grep exists($options{$_}),
3382 qw( addlinfo eventnum ),
3383 map "commission_$_", qw( agentnum salesnum pkgnum );
3385 $cust_credit->insert(%options);
3389 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3391 Creates a one-time charge for this customer. If there is an error, returns
3392 the error, otherwise returns false.
3394 New-style, with a hashref of options:
3396 my $error = $cust_main->charge(
3400 'start_date' => str2time('7/4/2009'),
3401 'pkg' => 'Description',
3402 'comment' => 'Comment',
3403 'additional' => [], #extra invoice detail
3404 'classnum' => 1, #pkg_class
3406 'setuptax' => '', # or 'Y' for tax exempt
3408 'locationnum'=> 1234, # optional
3411 'taxclass' => 'Tax class',
3414 'taxproduct' => 2, #part_pkg_taxproduct
3415 'override' => {}, #XXX describe
3417 #will be filled in with the new object
3418 'cust_pkg_ref' => \$cust_pkg,
3420 #generate an invoice immediately
3422 'invoice_terms' => '', #with these terms
3428 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3434 my ( $amount, $quantity, $start_date, $classnum );
3435 my ( $pkg, $comment, $additional );
3436 my ( $setuptax, $taxclass ); #internal taxes
3437 my ( $taxproduct, $override ); #vendor (CCH) taxes
3439 my $cust_pkg_ref = '';
3440 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3442 if ( ref( $_[0] ) ) {
3443 $amount = $_[0]->{amount};
3444 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3445 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3446 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3447 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3448 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3449 : '$'. sprintf("%.2f",$amount);
3450 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3451 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3452 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3453 $additional = $_[0]->{additional} || [];
3454 $taxproduct = $_[0]->{taxproductnum};
3455 $override = { '' => $_[0]->{tax_override} };
3456 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3457 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3458 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3459 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3464 $pkg = @_ ? shift : 'One-time charge';
3465 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3467 $taxclass = @_ ? shift : '';
3471 local $SIG{HUP} = 'IGNORE';
3472 local $SIG{INT} = 'IGNORE';
3473 local $SIG{QUIT} = 'IGNORE';
3474 local $SIG{TERM} = 'IGNORE';
3475 local $SIG{TSTP} = 'IGNORE';
3476 local $SIG{PIPE} = 'IGNORE';
3478 my $oldAutoCommit = $FS::UID::AutoCommit;
3479 local $FS::UID::AutoCommit = 0;
3482 my $part_pkg = new FS::part_pkg ( {
3484 'comment' => $comment,
3488 'classnum' => ( $classnum ? $classnum : '' ),
3489 'setuptax' => $setuptax,
3490 'taxclass' => $taxclass,
3491 'taxproductnum' => $taxproduct,
3494 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3495 ( 0 .. @$additional - 1 )
3497 'additional_count' => scalar(@$additional),
3498 'setup_fee' => $amount,
3501 my $error = $part_pkg->insert( options => \%options,
3502 tax_overrides => $override,
3505 $dbh->rollback if $oldAutoCommit;
3509 my $pkgpart = $part_pkg->pkgpart;
3510 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3511 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3512 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3513 $error = $type_pkgs->insert;
3515 $dbh->rollback if $oldAutoCommit;
3520 my $cust_pkg = new FS::cust_pkg ( {
3521 'custnum' => $self->custnum,
3522 'pkgpart' => $pkgpart,
3523 'quantity' => $quantity,
3524 'start_date' => $start_date,
3525 'no_auto' => $no_auto,
3526 'locationnum'=> $locationnum,
3529 $error = $cust_pkg->insert;
3531 $dbh->rollback if $oldAutoCommit;
3533 } elsif ( $cust_pkg_ref ) {
3534 ${$cust_pkg_ref} = $cust_pkg;
3538 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3539 'pkg_list' => [ $cust_pkg ],
3542 $dbh->rollback if $oldAutoCommit;
3547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3552 #=item charge_postal_fee
3554 #Applies a one time charge this customer. If there is an error,
3555 #returns the error, returns the cust_pkg charge object or false
3556 #if there was no charge.
3560 # This should be a customer event. For that to work requires that bill
3561 # also be a customer event.
3563 sub charge_postal_fee {
3566 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3567 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3569 my $cust_pkg = new FS::cust_pkg ( {
3570 'custnum' => $self->custnum,
3571 'pkgpart' => $pkgpart,
3575 my $error = $cust_pkg->insert;
3576 $error ? $error : $cust_pkg;
3579 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3581 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3583 Optionally, a list or hashref of additional arguments to the qsearch call can
3590 my $opt = ref($_[0]) ? shift : { @_ };
3592 #return $self->num_cust_bill unless wantarray || keys %$opt;
3594 $opt->{'table'} = 'cust_bill';
3595 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3596 $opt->{'hashref'}{'custnum'} = $self->custnum;
3597 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3599 map { $_ } #behavior of sort undefined in scalar context
3600 sort { $a->_date <=> $b->_date }
3604 =item open_cust_bill
3606 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3611 sub open_cust_bill {
3615 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3621 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3623 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3627 sub legacy_cust_bill {
3630 #return $self->num_legacy_cust_bill unless wantarray;
3632 map { $_ } #behavior of sort undefined in scalar context
3633 sort { $a->_date <=> $b->_date }
3634 qsearch({ 'table' => 'legacy_cust_bill',
3635 'hashref' => { 'custnum' => $self->custnum, },
3636 'order_by' => 'ORDER BY _date ASC',
3640 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3642 Returns all the statements (see L<FS::cust_statement>) for this customer.
3644 Optionally, a list or hashref of additional arguments to the qsearch call can
3649 =item cust_bill_void
3651 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3655 sub cust_bill_void {
3658 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3659 sort { $a->_date <=> $b->_date }
3660 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3663 sub cust_statement {
3665 my $opt = ref($_[0]) ? shift : { @_ };
3667 #return $self->num_cust_statement unless wantarray || keys %$opt;
3669 $opt->{'table'} = 'cust_statement';
3670 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3671 $opt->{'hashref'}{'custnum'} = $self->custnum;
3672 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3674 map { $_ } #behavior of sort undefined in scalar context
3675 sort { $a->_date <=> $b->_date }
3679 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3681 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3683 Optionally, a list or hashref of additional arguments to the qsearch call can
3684 be passed following the SVCDB.
3691 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3692 warn "$me svc_x requires a svcdb";
3695 my $opt = ref($_[0]) ? shift : { @_ };
3697 $opt->{'table'} = $svcdb;
3698 $opt->{'addl_from'} =
3699 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3700 ($opt->{'addl_from'} || '');
3702 my $custnum = $self->custnum;
3703 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3704 my $where = "cust_pkg.custnum = $custnum";
3706 my $extra_sql = $opt->{'extra_sql'} || '';
3707 if ( keys %{ $opt->{'hashref'} } ) {
3708 $extra_sql = " AND $where $extra_sql";
3711 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3712 $extra_sql = "WHERE $where AND $1";
3715 $extra_sql = "WHERE $where $extra_sql";
3718 $opt->{'extra_sql'} = $extra_sql;
3723 # required for use as an eventtable;
3726 $self->svc_x('svc_acct', @_);
3731 Returns all the credits (see L<FS::cust_credit>) for this customer.
3737 map { $_ } #return $self->num_cust_credit unless wantarray;
3738 sort { $a->_date <=> $b->_date }
3739 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3742 =item cust_credit_pkgnum
3744 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3745 package when using experimental package balances.
3749 sub cust_credit_pkgnum {
3750 my( $self, $pkgnum ) = @_;
3751 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3752 sort { $a->_date <=> $b->_date }
3753 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3754 'pkgnum' => $pkgnum,
3759 =item cust_credit_void
3761 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3765 sub cust_credit_void {
3768 sort { $a->_date <=> $b->_date }
3769 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3774 Returns all the payments (see L<FS::cust_pay>) for this customer.
3780 return $self->num_cust_pay unless wantarray;
3781 sort { $a->_date <=> $b->_date }
3782 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3787 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3788 called automatically when the cust_pay method is used in a scalar context.
3794 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3795 my $sth = dbh->prepare($sql) or die dbh->errstr;
3796 $sth->execute($self->custnum) or die $sth->errstr;
3797 $sth->fetchrow_arrayref->[0];
3800 =item cust_pay_pkgnum
3802 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3803 package when using experimental package balances.
3807 sub cust_pay_pkgnum {
3808 my( $self, $pkgnum ) = @_;
3809 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3810 sort { $a->_date <=> $b->_date }
3811 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3812 'pkgnum' => $pkgnum,
3819 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3825 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3826 sort { $a->_date <=> $b->_date }
3827 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3830 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3832 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3834 Optionally, a list or hashref of additional arguments to the qsearch call can
3839 sub cust_pay_batch {
3841 my $opt = ref($_[0]) ? shift : { @_ };
3843 #return $self->num_cust_statement unless wantarray || keys %$opt;
3845 $opt->{'table'} = 'cust_pay_batch';
3846 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3847 $opt->{'hashref'}{'custnum'} = $self->custnum;
3848 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3850 map { $_ } #behavior of sort undefined in scalar context
3851 sort { $a->paybatchnum <=> $b->paybatchnum }
3855 =item cust_pay_pending
3857 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3858 (without status "done").
3862 sub cust_pay_pending {
3864 return $self->num_cust_pay_pending unless wantarray;
3865 sort { $a->_date <=> $b->_date }
3866 qsearch( 'cust_pay_pending', {
3867 'custnum' => $self->custnum,
3868 'status' => { op=>'!=', value=>'done' },
3873 =item cust_pay_pending_attempt
3875 Returns all payment attempts / declined payments for this customer, as pending
3876 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3877 a corresponding payment (see L<FS::cust_pay>).
3881 sub cust_pay_pending_attempt {
3883 return $self->num_cust_pay_pending_attempt unless wantarray;
3884 sort { $a->_date <=> $b->_date }
3885 qsearch( 'cust_pay_pending', {
3886 'custnum' => $self->custnum,
3893 =item num_cust_pay_pending
3895 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3896 customer (without status "done"). Also called automatically when the
3897 cust_pay_pending method is used in a scalar context.
3901 sub num_cust_pay_pending {
3904 " SELECT COUNT(*) FROM cust_pay_pending ".
3905 " WHERE custnum = ? AND status != 'done' ",
3910 =item num_cust_pay_pending_attempt
3912 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3913 customer, with status "done" but without a corresp. Also called automatically when the
3914 cust_pay_pending method is used in a scalar context.
3918 sub num_cust_pay_pending_attempt {
3921 " SELECT COUNT(*) FROM cust_pay_pending ".
3922 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3929 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3935 map { $_ } #return $self->num_cust_refund unless wantarray;
3936 sort { $a->_date <=> $b->_date }
3937 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3940 =item display_custnum
3942 Returns the displayed customer number for this customer: agent_custid if
3943 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3947 sub display_custnum {
3950 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3951 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3952 if ( $special eq 'CoStAg' ) {
3953 $prefix = uc( join('',
3955 ($self->state =~ /^(..)/),
3956 $prefix || ($self->agent->agent =~ /^(..)/)
3959 elsif ( $special eq 'CoStCl' ) {
3960 $prefix = uc( join('',
3962 ($self->state =~ /^(..)/),
3963 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3966 # add any others here if needed
3969 my $length = $conf->config('cust_main-custnum-display_length');
3970 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3971 return $self->agent_custid;
3972 } elsif ( $prefix ) {
3973 $length = 8 if !defined($length);
3975 sprintf('%0'.$length.'d', $self->custnum)
3976 } elsif ( $length ) {
3977 return sprintf('%0'.$length.'d', $self->custnum);
3979 return $self->custnum;
3985 Returns a name string for this customer, either "Company (Last, First)" or
3992 my $name = $self->contact;
3993 $name = $self->company. " ($name)" if $self->company;
3997 =item service_contact
3999 Returns the L<FS::contact> object for this customer that has the 'Service'
4000 contact class, or undef if there is no such contact. Deprecated; don't use
4005 sub service_contact {
4007 if ( !exists($self->{service_contact}) ) {
4008 my $classnum = $self->scalar_sql(
4009 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4010 ) || 0; #if it's zero, qsearchs will return nothing
4011 $self->{service_contact} = qsearchs('contact', {
4012 'classnum' => $classnum, 'custnum' => $self->custnum
4015 $self->{service_contact};
4020 Returns a name string for this (service/shipping) contact, either
4021 "Company (Last, First)" or "Last, First".
4028 my $name = $self->ship_contact;
4029 $name = $self->company. " ($name)" if $self->company;
4035 Returns a name string for this customer, either "Company" or "First Last".
4041 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4044 =item ship_name_short
4046 Returns a name string for this (service/shipping) contact, either "Company"
4051 sub ship_name_short {
4053 $self->service_contact
4054 ? $self->ship_contact_firstlast
4060 Returns this customer's full (billing) contact name only, "Last, First"
4066 $self->get('last'). ', '. $self->first;
4071 Returns this customer's full (shipping) contact name only, "Last, First"
4077 my $contact = $self->service_contact || $self;
4078 $contact->get('last') . ', ' . $contact->get('first');
4081 =item contact_firstlast
4083 Returns this customers full (billing) contact name only, "First Last".
4087 sub contact_firstlast {
4089 $self->first. ' '. $self->get('last');
4092 =item ship_contact_firstlast
4094 Returns this customer's full (shipping) contact name only, "First Last".
4098 sub ship_contact_firstlast {
4100 my $contact = $self->service_contact || $self;
4101 $contact->get('first') . ' '. $contact->get('last');
4104 #XXX this doesn't work in 3.x+
4107 #Returns this customer's full country name
4113 # code2country($self->country);
4116 sub bill_country_full {
4118 code2country($self->bill_location->country);
4121 sub ship_country_full {
4123 code2country($self->ship_location->country);
4126 =item county_state_county [ PREFIX ]
4128 Returns a string consisting of just the county, state and country.
4132 sub county_state_country {
4135 if ( @_ && $_[0] && $self->has_ship_address ) {
4136 $locationnum = $self->ship_locationnum;
4138 $locationnum = $self->bill_locationnum;
4140 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4141 $cust_location->county_state_country;
4144 =item geocode DATA_VENDOR
4146 Returns a value for the customer location as encoded by DATA_VENDOR.
4147 Currently this only makes sense for "CCH" as DATA_VENDOR.
4155 Returns a status string for this customer, currently:
4159 =item prospect - No packages have ever been ordered
4161 =item ordered - Recurring packages all are new (not yet billed).
4163 =item active - One or more recurring packages is active
4165 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4167 =item suspended - All non-cancelled recurring packages are suspended
4169 =item cancelled - All recurring packages are cancelled
4173 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4174 cust_main-status_module configuration option.
4178 sub status { shift->cust_status(@_); }
4182 for my $status ( FS::cust_main->statuses() ) {
4183 my $method = $status.'_sql';
4184 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4185 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4186 $sth->execute( ($self->custnum) x $numnum )
4187 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4188 return $status if $sth->fetchrow_arrayref->[0];
4192 =item ucfirst_cust_status
4194 =item ucfirst_status
4196 Returns the status with the first character capitalized.
4200 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4202 sub ucfirst_cust_status {
4204 ucfirst($self->cust_status);
4209 Returns a hex triplet color string for this customer's status.
4213 sub statuscolor { shift->cust_statuscolor(@_); }
4215 sub cust_statuscolor {
4217 __PACKAGE__->statuscolors->{$self->cust_status};
4220 =item tickets [ STATUS ]
4222 Returns an array of hashes representing the customer's RT tickets.
4224 An optional status (or arrayref or hashref of statuses) may be specified.
4230 my $status = ( @_ && $_[0] ) ? shift : '';
4232 my $num = $conf->config('cust_main-max_tickets') || 10;
4235 if ( $conf->config('ticket_system') ) {
4236 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4238 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4247 foreach my $priority (
4248 $conf->config('ticket_system-custom_priority_field-values'), ''
4250 last if scalar(@tickets) >= $num;
4252 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4253 $num - scalar(@tickets),
4264 # Return services representing svc_accts in customer support packages
4265 sub support_services {
4267 my %packages = map { $_ => 1 } $conf->config('support_packages');
4269 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4270 grep { $_->part_svc->svcdb eq 'svc_acct' }
4271 map { $_->cust_svc }
4272 grep { exists $packages{ $_->pkgpart } }
4273 $self->ncancelled_pkgs;
4277 # Return a list of latitude/longitude for one of the services (if any)
4278 sub service_coordinates {
4282 grep { $_->latitude && $_->longitude }
4284 map { $_->cust_svc }
4285 $self->ncancelled_pkgs;
4287 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4292 Returns a masked version of the named field
4297 my ($self,$field) = @_;
4301 'x'x(length($self->getfield($field))-4).
4302 substr($self->getfield($field), (length($self->getfield($field))-4));
4308 =head1 CLASS METHODS
4314 Class method that returns the list of possible status strings for customers
4315 (see L<the status method|/status>). For example:
4317 @statuses = FS::cust_main->statuses();
4323 keys %{ $self->statuscolors };
4326 =item cust_status_sql
4328 Returns an SQL fragment to determine the status of a cust_main record, as a
4333 sub cust_status_sql {
4335 for my $status ( FS::cust_main->statuses() ) {
4336 my $method = $status.'_sql';
4337 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4346 Returns an SQL expression identifying prospective cust_main records (customers
4347 with no packages ever ordered)
4351 use vars qw($select_count_pkgs);
4352 $select_count_pkgs =
4353 "SELECT COUNT(*) FROM cust_pkg
4354 WHERE cust_pkg.custnum = cust_main.custnum";
4356 sub select_count_pkgs_sql {
4361 " 0 = ( $select_count_pkgs ) ";
4366 Returns an SQL expression identifying ordered cust_main records (customers with
4367 no active packages, but recurring packages not yet setup or one time charges
4373 FS::cust_main->none_active_sql.
4374 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4379 Returns an SQL expression identifying active cust_main records (customers with
4380 active recurring packages).
4385 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4388 =item none_active_sql
4390 Returns an SQL expression identifying cust_main records with no active
4391 recurring packages. This includes customers of status prospect, ordered,
4392 inactive, and suspended.
4396 sub none_active_sql {
4397 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4402 Returns an SQL expression identifying inactive cust_main records (customers with
4403 no active recurring packages, but otherwise unsuspended/uncancelled).
4408 FS::cust_main->none_active_sql.
4409 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4415 Returns an SQL expression identifying suspended cust_main records.
4420 sub suspended_sql { susp_sql(@_); }
4422 FS::cust_main->none_active_sql.
4423 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4429 Returns an SQL expression identifying cancelled cust_main records.
4433 sub cancel_sql { shift->cancelled_sql(@_); }
4436 =item uncancelled_sql
4438 Returns an SQL expression identifying un-cancelled cust_main records.
4442 sub uncancelled_sql { uncancel_sql(@_); }
4443 sub uncancel_sql { "
4444 ( 0 < ( $select_count_pkgs
4445 AND ( cust_pkg.cancel IS NULL
4446 OR cust_pkg.cancel = 0
4449 OR 0 = ( $select_count_pkgs )
4455 Returns an SQL fragment to retreive the balance.
4460 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4461 WHERE cust_bill.custnum = cust_main.custnum )
4462 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4463 WHERE cust_pay.custnum = cust_main.custnum )
4464 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4465 WHERE cust_credit.custnum = cust_main.custnum )
4466 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4467 WHERE cust_refund.custnum = cust_main.custnum )
4470 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4472 Returns an SQL fragment to retreive the balance for this customer, optionally
4473 considering invoices with date earlier than START_TIME, and not
4474 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4475 total_unapplied_payments).
4477 Times are specified as SQL fragments or numeric
4478 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4479 L<Date::Parse> for conversion functions. The empty string can be passed
4480 to disable that time constraint completely.
4482 Available options are:
4486 =item unapplied_date
4488 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)
4493 set to true to remove all customer comparison clauses, for totals
4498 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4503 JOIN clause (typically used with the total option)
4507 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4508 time will be ignored. Note that START_TIME and END_TIME only limit the date
4509 range for invoices and I<unapplied> payments, credits, and refunds.
4515 sub balance_date_sql {
4516 my( $class, $start, $end, %opt ) = @_;
4518 my $cutoff = $opt{'cutoff'};
4520 my $owed = FS::cust_bill->owed_sql($cutoff);
4521 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4522 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4523 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4525 my $j = $opt{'join'} || '';
4527 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4528 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4529 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4530 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4532 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4533 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4534 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4535 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4540 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4542 Returns an SQL fragment to retreive the total unapplied payments for this
4543 customer, only considering payments with date earlier than START_TIME, and
4544 optionally not later than END_TIME.
4546 Times are specified as SQL fragments or numeric
4547 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4548 L<Date::Parse> for conversion functions. The empty string can be passed
4549 to disable that time constraint completely.
4551 Available options are:
4555 sub unapplied_payments_date_sql {
4556 my( $class, $start, $end, %opt ) = @_;
4558 my $cutoff = $opt{'cutoff'};
4560 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4562 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4563 'unapplied_date'=>1 );
4565 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4568 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4570 Helper method for balance_date_sql; name (and usage) subject to change
4571 (suggestions welcome).
4573 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4574 cust_refund, cust_credit or cust_pay).
4576 If TABLE is "cust_bill" or the unapplied_date option is true, only
4577 considers records with date earlier than START_TIME, and optionally not
4578 later than END_TIME .
4582 sub _money_table_where {
4583 my( $class, $table, $start, $end, %opt ) = @_;
4586 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4587 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4588 push @where, "$table._date <= $start" if defined($start) && length($start);
4589 push @where, "$table._date > $end" if defined($end) && length($end);
4591 push @where, @{$opt{'where'}} if $opt{'where'};
4592 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4598 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4599 use FS::cust_main::Search;
4602 FS::cust_main::Search->search(@_);
4611 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4613 Deprecated. Use event notification and message templates
4614 (L<FS::msg_template>) instead.
4616 Sends a templated email notification to the customer (see L<Text::Template>).
4618 OPTIONS is a hash and may include
4620 I<from> - the email sender (default is invoice_from)
4622 I<to> - comma-separated scalar or arrayref of recipients
4623 (default is invoicing_list)
4625 I<subject> - The subject line of the sent email notification
4626 (default is "Notice from company_name")
4628 I<extra_fields> - a hashref of name/value pairs which will be substituted
4631 The following variables are vavailable in the template.
4633 I<$first> - the customer first name
4634 I<$last> - the customer last name
4635 I<$company> - the customer company
4636 I<$payby> - a description of the method of payment for the customer
4637 # would be nice to use FS::payby::shortname
4638 I<$payinfo> - the account information used to collect for this customer
4639 I<$expdate> - the expiration of the customer payment in seconds from epoch
4644 my ($self, $template, %options) = @_;
4646 return unless $conf->exists($template);
4648 my $from = $conf->config('invoice_from', $self->agentnum)
4649 if $conf->exists('invoice_from', $self->agentnum);
4650 $from = $options{from} if exists($options{from});
4652 my $to = join(',', $self->invoicing_list_emailonly);
4653 $to = $options{to} if exists($options{to});
4655 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4656 if $conf->exists('company_name', $self->agentnum);
4657 $subject = $options{subject} if exists($options{subject});
4659 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4660 SOURCE => [ map "$_\n",
4661 $conf->config($template)]
4663 or die "can't create new Text::Template object: Text::Template::ERROR";
4664 $notify_template->compile()
4665 or die "can't compile template: Text::Template::ERROR";
4667 $FS::notify_template::_template::company_name =
4668 $conf->config('company_name', $self->agentnum);
4669 $FS::notify_template::_template::company_address =
4670 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4672 my $paydate = $self->paydate || '2037-12-31';
4673 $FS::notify_template::_template::first = $self->first;
4674 $FS::notify_template::_template::last = $self->last;
4675 $FS::notify_template::_template::company = $self->company;
4676 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4677 my $payby = $self->payby;
4678 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4679 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4681 #credit cards expire at the end of the month/year of their exp date
4682 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4683 $FS::notify_template::_template::payby = 'credit card';
4684 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4685 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4687 }elsif ($payby eq 'COMP') {
4688 $FS::notify_template::_template::payby = 'complimentary account';
4690 $FS::notify_template::_template::payby = 'current method';
4692 $FS::notify_template::_template::expdate = $expire_time;
4694 for (keys %{$options{extra_fields}}){
4696 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4699 send_email(from => $from,
4701 subject => $subject,
4702 body => $notify_template->fill_in( PACKAGE =>
4703 'FS::notify_template::_template' ),
4708 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4710 Generates a templated notification to the customer (see L<Text::Template>).
4712 OPTIONS is a hash and may include
4714 I<extra_fields> - a hashref of name/value pairs which will be substituted
4715 into the template. These values may override values mentioned below
4716 and those from the customer record.
4718 The following variables are available in the template instead of or in addition
4719 to the fields of the customer record.
4721 I<$payby> - a description of the method of payment for the customer
4722 # would be nice to use FS::payby::shortname
4723 I<$payinfo> - the masked account information used to collect for this customer
4724 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4725 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4729 # a lot like cust_bill::print_latex
4730 sub generate_letter {
4731 my ($self, $template, %options) = @_;
4733 return unless $conf->exists($template);
4735 my $letter_template = new Text::Template
4737 SOURCE => [ map "$_\n", $conf->config($template)],
4738 DELIMITERS => [ '[@--', '--@]' ],
4740 or die "can't create new Text::Template object: Text::Template::ERROR";
4742 $letter_template->compile()
4743 or die "can't compile template: Text::Template::ERROR";
4745 my %letter_data = map { $_ => $self->$_ } $self->fields;
4746 $letter_data{payinfo} = $self->mask_payinfo;
4748 #my $paydate = $self->paydate || '2037-12-31';
4749 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4751 my $payby = $self->payby;
4752 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4753 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4755 #credit cards expire at the end of the month/year of their exp date
4756 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4757 $letter_data{payby} = 'credit card';
4758 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4759 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4761 }elsif ($payby eq 'COMP') {
4762 $letter_data{payby} = 'complimentary account';
4764 $letter_data{payby} = 'current method';
4766 $letter_data{expdate} = $expire_time;
4768 for (keys %{$options{extra_fields}}){
4769 $letter_data{$_} = $options{extra_fields}->{$_};
4772 unless(exists($letter_data{returnaddress})){
4773 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4774 $self->agent_template)
4776 if ( length($retadd) ) {
4777 $letter_data{returnaddress} = $retadd;
4778 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4779 $letter_data{returnaddress} =
4780 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4784 ( $conf->config('company_name', $self->agentnum),
4785 $conf->config('company_address', $self->agentnum),
4789 $letter_data{returnaddress} = '~';
4793 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4795 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4797 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4799 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4803 ) or die "can't open temp file: $!\n";
4804 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4805 or die "can't write temp file: $!\n";
4807 $letter_data{'logo_file'} = $lh->filename;
4809 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4813 ) or die "can't open temp file: $!\n";
4815 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4817 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4818 return ($1, $letter_data{'logo_file'});
4822 =item print_ps TEMPLATE
4824 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4830 my($file, $lfile) = $self->generate_letter(@_);
4831 my $ps = FS::Misc::generate_ps($file);
4832 unlink($file.'.tex');
4838 =item print TEMPLATE
4840 Prints the filled in template.
4842 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4846 sub queueable_print {
4849 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4850 or die "invalid customer number: " . $opt{custnum};
4852 my $error = $self->print( { 'template' => $opt{template} } );
4853 die $error if $error;
4857 my ($self, $template) = (shift, shift);
4859 [ $self->print_ps($template) ],
4860 'agentnum' => $self->agentnum,
4864 #these three subs should just go away once agent stuff is all config overrides
4866 sub agent_template {
4868 $self->_agent_plandata('agent_templatename');
4871 sub agent_invoice_from {
4873 $self->_agent_plandata('agent_invoice_from');
4876 sub _agent_plandata {
4877 my( $self, $option ) = @_;
4879 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4880 #agent-specific Conf
4882 use FS::part_event::Condition;
4884 my $agentnum = $self->agentnum;
4886 my $regexp = regexp_sql();
4888 my $part_event_option =
4890 'select' => 'part_event_option.*',
4891 'table' => 'part_event_option',
4893 LEFT JOIN part_event USING ( eventpart )
4894 LEFT JOIN part_event_option AS peo_agentnum
4895 ON ( part_event.eventpart = peo_agentnum.eventpart
4896 AND peo_agentnum.optionname = 'agentnum'
4897 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4899 LEFT JOIN part_event_condition
4900 ON ( part_event.eventpart = part_event_condition.eventpart
4901 AND part_event_condition.conditionname = 'cust_bill_age'
4903 LEFT JOIN part_event_condition_option
4904 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4905 AND part_event_condition_option.optionname = 'age'
4908 #'hashref' => { 'optionname' => $option },
4909 #'hashref' => { 'part_event_option.optionname' => $option },
4911 " WHERE part_event_option.optionname = ". dbh->quote($option).
4912 " AND action = 'cust_bill_send_agent' ".
4913 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4914 " AND peo_agentnum.optionname = 'agentnum' ".
4915 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4917 CASE WHEN part_event_condition_option.optionname IS NULL
4919 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4921 , part_event.weight".
4925 unless ( $part_event_option ) {
4926 return $self->agent->invoice_template || ''
4927 if $option eq 'agent_templatename';
4931 $part_event_option->optionvalue;
4935 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4937 Subroutine (not a method), designed to be called from the queue.
4939 Takes a list of options and values.
4941 Pulls up the customer record via the custnum option and calls bill_and_collect.
4946 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4948 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4949 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4951 #without this errors don't get rolled back
4952 $args{'fatal'} = 1; # runs from job queue, will be caught
4954 $cust_main->bill_and_collect( %args );
4957 sub process_bill_and_collect {
4959 my $param = thaw(decode_base64(shift));
4960 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4961 or die "custnum '$param->{custnum}' not found!\n";
4962 $param->{'job'} = $job;
4963 $param->{'fatal'} = 1; # runs from job queue, will be caught
4964 $param->{'retry'} = 1;
4966 $cust_main->bill_and_collect( %$param );
4969 #starting to take quite a while for big dbs
4970 # (JRNL: journaled so it only happens once per database)
4971 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
4972 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
4973 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
4974 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
4975 # JRNL leading/trailing spaces in first, last, company
4976 # JRNL migrate to cust_payby
4977 # - otaker upgrade? journal and call it good? (double check to make sure
4978 # we're not still setting otaker here)
4980 #only going to get worse with new location stuff...
4982 sub _upgrade_data { #class method
4983 my ($class, %opts) = @_;
4986 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4989 #this seems to be the only expensive one.. why does it take so long?
4990 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
4992 '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';
4993 FS::upgrade_journal->set_done('cust_main__signupdate');
4996 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
4998 # fix yyyy-m-dd formatted paydates
4999 if ( driver_name =~ /^mysql/i ) {
5001 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5002 } else { # the SQL standard
5004 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5006 FS::upgrade_journal->set_done('cust_main__paydate');
5009 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5011 push @statements, #fix the weird BILL with a cc# in payinfo problem
5013 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5015 FS::upgrade_journal->set_done('cust_main__payinfo');
5020 foreach my $sql ( @statements ) {
5021 my $sth = dbh->prepare($sql) or die dbh->errstr;
5022 $sth->execute or die $sth->errstr;
5023 #warn ( (time - $t). " seconds\n" );
5027 local($ignore_expired_card) = 1;
5028 local($ignore_banned_card) = 1;
5029 local($skip_fuzzyfiles) = 1;
5030 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5032 FS::cust_main::Location->_upgrade_data(%opts);
5034 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5036 foreach my $cust_main ( qsearch({
5037 'table' => 'cust_main',
5039 'extra_sql' => 'WHERE '.
5041 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5042 qw( first last company )
5045 my $error = $cust_main->replace;
5046 die $error if $error;
5049 FS::upgrade_journal->set_done('cust_main__trimspaces');
5053 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5055 #we don't want to decrypt them, just stuff them as-is into cust_payby
5056 local(@encrypted_fields) = ();
5058 local($FS::cust_payby::ignore_expired_card) = 1;
5059 local($FS::cust_payby::ignore_banned_card) = 1;
5061 my @payfields = qw( payby payinfo paycvv paymask
5062 paydate paystart_month paystart_year payissue
5063 payname paystate paytype payip
5066 my $search = new FS::Cursor {
5067 'table' => 'cust_main',
5068 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5071 while (my $cust_main = $search->fetch) {
5073 my $cust_payby = new FS::cust_payby {
5074 'custnum' => $cust_main->custnum,
5076 map { $_ => $cust_main->$_(); } @payfields
5079 my $error = $cust_payby->insert;
5080 die $error if $error;
5082 $cust_main->setfield($_, '') foreach @payfields;
5083 $error = $cust_main->replace;
5084 die $error if $error;
5088 FS::upgrade_journal->set_done('cust_main__cust_payby');
5091 $class->_upgrade_otaker(%opts);
5101 The delete method should possibly take an FS::cust_main object reference
5102 instead of a scalar customer number.
5104 Bill and collect options should probably be passed as references instead of a
5107 There should probably be a configuration file with a list of allowed credit
5110 No multiple currency support (probably a larger project than just this module).
5112 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5114 Birthdates rely on negative epoch values.
5116 The payby for card/check batches is broken. With mixed batching, bad
5119 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5123 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5124 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5125 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.