2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
6 FS::cust_main::Billing_Realtime
7 FS::cust_main::Billing_Batch
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Billing_ThirdParty
10 FS::cust_main::Location
11 FS::cust_main::Credit_Limit
14 FS::otaker_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
83 # 1 is mostly method/subroutine entry and options
84 # 2 traces progress of some operations
85 # 3 is even more information including possibly sensitive data
87 our $me = '[FS::cust_main]';
90 our $ignore_expired_card = 0;
91 our $ignore_banned_card = 0;
92 our $ignore_invalid_card = 0;
94 our $skip_fuzzyfiles = 0;
96 our $ucfirst_nowarn = 0;
98 #this info is in cust_payby as of 4.x
99 #this and the fields themselves can be removed in 5.x
100 our @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
104 our $default_agent_custid;
105 our $custnum_display_length;
106 #ask FS::UID to run this stuff for us later
107 #$FS::UID::callback{'FS::cust_main'} = sub {
108 install_callback FS::UID sub {
109 $conf = new FS::Conf;
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
112 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
117 my ( $hashref, $cache ) = @_;
118 if ( exists $hashref->{'pkgnum'} ) {
119 #@{ $self->{'_pkgnum'} } = ();
120 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
121 $self->{'_pkgnum'} = $subcache;
122 #push @{ $self->{'_pkgnum'} },
123 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
129 FS::cust_main - Object methods for cust_main records
135 $record = new FS::cust_main \%hash;
136 $record = new FS::cust_main { 'column' => 'value' };
138 $error = $record->insert;
140 $error = $new_record->replace($old_record);
142 $error = $record->delete;
144 $error = $record->check;
146 @cust_pkg = $record->all_pkgs;
148 @cust_pkg = $record->ncancelled_pkgs;
150 @cust_pkg = $record->suspended_pkgs;
152 $error = $record->bill;
153 $error = $record->bill %options;
154 $error = $record->bill 'time' => $time;
156 $error = $record->collect;
157 $error = $record->collect %options;
158 $error = $record->collect 'invoice_time' => $time,
163 An FS::cust_main object represents a customer. FS::cust_main inherits from
164 FS::Record. The following fields are currently supported:
170 Primary key (assigned automatically for new customers)
174 Agent (see L<FS::agent>)
178 Advertising source (see L<FS::part_referral>)
190 Cocial security number (optional)
214 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
218 Payment Information (See L<FS::payinfo_Mixin> for data format)
222 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
226 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
230 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
234 Start date month (maestro/solo cards only)
238 Start date year (maestro/solo cards only)
242 Issue number (maestro/solo cards only)
246 Name on card or billing name
250 IP address from which payment information was received
254 Tax exempt, empty or `Y'
258 Order taker (see L<FS::access_user>)
264 =item referral_custnum
266 Referring customer number
270 Enable individual CDR spooling, empty or `Y'
274 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
278 Discourage individual CDR printing, empty or `Y'
282 Allow self-service editing of ticket subjects, empty or 'Y'
284 =item calling_list_exempt
286 Do not call, empty or 'Y'
288 =item invoice_ship_address
290 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
300 Creates a new customer. To add the customer to the database, see L<"insert">.
302 Note that this stores the hash reference, not a distinct copy of the hash it
303 points to. You can ask the object for a copy with the I<hash> method.
307 sub table { 'cust_main'; }
309 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
311 Adds this customer to the database. If there is an error, returns the error,
312 otherwise returns false.
314 Usually the customer's location will not yet exist in the database, and
315 the C<bill_location> and C<ship_location> pseudo-fields must be set to
316 uninserted L<FS::cust_location> objects. These will be inserted and linked
317 (in both directions) to the new customer record. If they're references
318 to the same object, they will become the same location.
320 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
321 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
322 are inserted atomicly, or the transaction is rolled back. Passing an empty
323 hash reference is equivalent to not supplying this parameter. There should be
324 a better explanation of this, but until then, here's an example:
327 tie %hash, 'Tie::RefHash'; #this part is important
329 $cust_pkg => [ $svc_acct ],
332 $cust_main->insert( \%hash );
334 INVOICING_LIST_ARYREF: No longer supported.
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
358 unset), inserts those new contacts with this new customer. Handles CGI
359 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
361 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
362 new stored payment records with this new customer. Handles CGI parameters
363 for an "m2" multiple entry field as passed by edit/cust_main.cgi
369 my $cust_pkgs = @_ ? shift : {};
371 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
372 warn "cust_main::insert using deprecated invoicing list argument";
373 $invoicing_list = shift;
376 warn "$me insert called with options ".
377 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380 return "You are not permitted to change customer invoicing terms."
381 if $self->invoice_terms #i.e. not the default
382 && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
384 local $SIG{HUP} = 'IGNORE';
385 local $SIG{INT} = 'IGNORE';
386 local $SIG{QUIT} = 'IGNORE';
387 local $SIG{TERM} = 'IGNORE';
388 local $SIG{TSTP} = 'IGNORE';
389 local $SIG{PIPE} = 'IGNORE';
391 my $oldAutoCommit = $FS::UID::AutoCommit;
392 local $FS::UID::AutoCommit = 0;
395 my $prepay_identifier = '';
396 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
398 if ( $self->payby eq 'PREPAY' ) {
400 $self->payby(''); #'BILL');
401 $prepay_identifier = $self->payinfo;
404 warn " looking up prepaid card $prepay_identifier\n"
407 my $error = $self->get_prepay( $prepay_identifier,
408 'amount_ref' => \$amount,
409 'seconds_ref' => \$seconds,
410 'upbytes_ref' => \$upbytes,
411 'downbytes_ref' => \$downbytes,
412 'totalbytes_ref' => \$totalbytes,
415 $dbh->rollback if $oldAutoCommit;
416 #return "error applying prepaid card (transaction rolled back): $error";
420 $payby = 'PREP' if $amount;
422 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
425 $self->payby(''); #'BILL');
426 $amount = $self->paid;
431 foreach my $l (qw(bill_location ship_location)) {
433 my $loc = delete $self->hashref->{$l} or next;
435 if ( !$loc->locationnum ) {
436 # warn the location that we're going to insert it with no custnum
437 $loc->set(custnum_pending => 1);
438 warn " inserting $l\n"
440 my $error = $loc->insert;
442 $dbh->rollback if $oldAutoCommit;
443 my $label = $l eq 'ship_location' ? 'service' : 'billing';
444 return "$error (in $label location)";
447 } elsif ( $loc->prospectnum ) {
449 $loc->prospectnum('');
450 $loc->set(custnum_pending => 1);
451 my $error = $loc->replace;
453 $dbh->rollback if $oldAutoCommit;
454 my $label = $l eq 'ship_location' ? 'service' : 'billing';
455 return "$error (moving $label location)";
458 } elsif ( ($loc->custnum || 0) > 0 ) {
459 # then it somehow belongs to another customer--shouldn't happen
460 $dbh->rollback if $oldAutoCommit;
461 return "$l belongs to customer ".$loc->custnum;
463 # else it already belongs to this customer
464 # (happens when ship_location is identical to bill_location)
466 $self->set($l.'num', $loc->locationnum);
468 if ( $self->get($l.'num') eq '' ) {
469 $dbh->rollback if $oldAutoCommit;
474 warn " inserting $self\n"
477 $self->signupdate(time) unless $self->signupdate;
479 $self->auto_agent_custid()
480 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
482 my $error = $self->check_payinfo_cardtype
483 || $self->SUPER::insert;
485 $dbh->rollback if $oldAutoCommit;
486 #return "inserting cust_main record (transaction rolled back): $error";
490 # now set cust_location.custnum
491 foreach my $l (qw(bill_location ship_location)) {
492 warn " setting $l.custnum\n"
494 my $loc = $self->$l or next;
495 unless ( $loc->custnum ) {
496 $loc->set(custnum => $self->custnum);
497 $error ||= $loc->replace;
501 $dbh->rollback if $oldAutoCommit;
502 return "error setting $l custnum: $error";
506 warn " setting customer tags\n"
509 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
510 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
511 'custnum' => $self->custnum };
512 my $error = $cust_tag->insert;
514 $dbh->rollback if $oldAutoCommit;
519 my $prospectnum = delete $options{'prospectnum'};
520 if ( $prospectnum ) {
522 warn " moving contacts and locations from prospect $prospectnum\n"
526 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
527 unless ( $prospect_main ) {
528 $dbh->rollback if $oldAutoCommit;
529 return "Unknown prospectnum $prospectnum";
531 $prospect_main->custnum($self->custnum);
532 $prospect_main->disabled('Y');
533 my $error = $prospect_main->replace;
535 $dbh->rollback if $oldAutoCommit;
539 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
540 my $cust_contact = new FS::cust_contact {
541 'custnum' => $self->custnum,
542 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
543 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
545 my $error = $cust_contact->insert
546 || $prospect_contact->delete;
548 $dbh->rollback if $oldAutoCommit;
553 my @cust_location = $prospect_main->cust_location;
554 my @qual = $prospect_main->qual;
556 foreach my $r ( @cust_location, @qual ) {
558 $r->custnum($self->custnum);
559 my $error = $r->replace;
561 $dbh->rollback if $oldAutoCommit;
565 # since we set invoice_dest on all migrated prospect contacts (for now),
566 # don't process invoicing_list.
567 delete $options{'invoicing_list'};
568 $invoicing_list = undef;
571 warn " setting contacts\n"
574 $invoicing_list ||= $options{'invoicing_list'};
575 if ( $invoicing_list ) {
577 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
580 foreach my $dest (@$invoicing_list ) {
581 if ($dest eq 'POST') {
582 $self->set('postal_invoice', 'Y');
585 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
586 if ( $contact_email ) {
587 my $cust_contact = FS::cust_contact->new({
588 contactnum => $contact_email->contactnum,
589 custnum => $self->custnum,
591 $cust_contact->set('invoice_dest', 'Y');
592 my $error = $cust_contact->insert;
594 $dbh->rollback if $oldAutoCommit;
595 return "$error (linking to email address $dest)";
599 # this email address is not yet linked to any contact
600 $email .= ',' if length($email);
608 my $contact = FS::contact->new({
609 'custnum' => $self->get('custnum'),
610 'last' => $self->get('last'),
611 'first' => $self->get('first'),
612 'emailaddress' => $email,
613 'invoice_dest' => 'Y', # yes, you can set this via the contact
615 my $error = $contact->insert;
617 $dbh->rollback if $oldAutoCommit;
625 if ( my $contact = delete $options{'contact'} ) {
627 foreach my $c ( @$contact ) {
628 $c->custnum($self->custnum);
629 my $error = $c->insert;
631 $dbh->rollback if $oldAutoCommit;
637 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
639 my $error = $self->process_o2m( 'table' => 'contact',
640 'fields' => FS::contact->cgi_contact_fields,
641 'params' => $contact_params,
644 $dbh->rollback if $oldAutoCommit;
649 warn " setting cust_payby\n"
652 if ( $options{cust_payby} ) {
654 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
655 $cust_payby->custnum($self->custnum);
656 my $error = $cust_payby->insert;
658 $dbh->rollback if $oldAutoCommit;
663 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
665 my $error = $self->process_o2m(
666 'table' => 'cust_payby',
667 'fields' => FS::cust_payby->cgi_cust_payby_fields,
668 'params' => $cust_payby_params,
669 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
672 $dbh->rollback if $oldAutoCommit;
678 warn " setting cust_main_exemption\n"
681 my $tax_exemption = delete $options{'tax_exemption'};
682 if ( $tax_exemption ) {
684 $tax_exemption = { map { $_ => '' } @$tax_exemption }
685 if ref($tax_exemption) eq 'ARRAY';
687 foreach my $taxname ( keys %$tax_exemption ) {
688 my $cust_main_exemption = new FS::cust_main_exemption {
689 'custnum' => $self->custnum,
690 'taxname' => $taxname,
691 'exempt_number' => $tax_exemption->{$taxname},
693 my $error = $cust_main_exemption->insert;
695 $dbh->rollback if $oldAutoCommit;
696 return "inserting cust_main_exemption (transaction rolled back): $error";
701 warn " ordering packages\n"
704 $error = $self->order_pkgs( $cust_pkgs,
706 'seconds_ref' => \$seconds,
707 'upbytes_ref' => \$upbytes,
708 'downbytes_ref' => \$downbytes,
709 'totalbytes_ref' => \$totalbytes,
712 $dbh->rollback if $oldAutoCommit;
717 $dbh->rollback if $oldAutoCommit;
718 return "No svc_acct record to apply pre-paid time";
720 if ( $upbytes || $downbytes || $totalbytes ) {
721 $dbh->rollback if $oldAutoCommit;
722 return "No svc_acct record to apply pre-paid data";
726 warn " inserting initial $payby payment of $amount\n"
728 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
730 $dbh->rollback if $oldAutoCommit;
731 return "inserting payment (transaction rolled back): $error";
735 unless ( $import || $skip_fuzzyfiles ) {
736 warn " queueing fuzzyfiles update\n"
738 $error = $self->queue_fuzzyfiles_update;
740 $dbh->rollback if $oldAutoCommit;
741 return "updating fuzzy search cache: $error";
745 # FS::geocode_Mixin::after_insert or something?
746 if ( $conf->config('tax_district_method') and !$import ) {
747 # if anything non-empty, try to look it up
748 my $queue = new FS::queue {
749 'job' => 'FS::geocode_Mixin::process_district_update',
750 'custnum' => $self->custnum,
752 my $error = $queue->insert( ref($self), $self->custnum );
754 $dbh->rollback if $oldAutoCommit;
755 return "queueing tax district update: $error";
760 warn " exporting\n" if $DEBUG > 1;
762 my $export_args = $options{'export_args'} || [];
765 map qsearch( 'part_export', {exportnum=>$_} ),
766 $conf->config('cust_main-exports'); #, $agentnum
768 foreach my $part_export ( @part_export ) {
769 my $error = $part_export->export_insert($self, @$export_args);
771 $dbh->rollback if $oldAutoCommit;
772 return "exporting to ". $part_export->exporttype.
773 " (transaction rolled back): $error";
777 #foreach my $depend_jobnum ( @$depend_jobnums ) {
778 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
780 # foreach my $jobnum ( @jobnums ) {
781 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
782 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
784 # my $error = $queue->depend_insert($depend_jobnum);
786 # $dbh->rollback if $oldAutoCommit;
787 # return "error queuing job dependancy: $error";
794 #if ( exists $options{'jobnums'} ) {
795 # push @{ $options{'jobnums'} }, @jobnums;
798 warn " insert complete; committing transaction\n"
801 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
806 use File::CounterFile;
807 sub auto_agent_custid {
810 my $format = $conf->config('cust_main-auto_agent_custid');
812 if ( $format eq '1YMMXXXXXXXX' ) {
814 my $counter = new File::CounterFile 'cust_main.agent_custid';
817 my $ym = 100000000000 + time2str('%y%m00000000', time);
818 if ( $ym > $counter->value ) {
819 $counter->{'value'} = $agent_custid = $ym;
820 $counter->{'updated'} = 1;
822 $agent_custid = $counter->inc;
828 die "Unknown cust_main-auto_agent_custid format: $format";
831 $self->agent_custid($agent_custid);
835 =item PACKAGE METHODS
837 Documentation on customer package methods has been moved to
838 L<FS::cust_main::Packages>.
840 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
842 Recharges this (existing) customer with the specified prepaid card (see
843 L<FS::prepay_credit>), specified either by I<identifier> or as an
844 FS::prepay_credit object. If there is an error, returns the error, otherwise
847 Optionally, five scalar references can be passed as well. They will have their
848 values filled in with the amount, number of seconds, and number of upload,
849 download, and total bytes applied by this prepaid card.
853 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
854 #the only place that uses these args
855 sub recharge_prepay {
856 my( $self, $prepay_credit, $amountref, $secondsref,
857 $upbytesref, $downbytesref, $totalbytesref ) = @_;
859 local $SIG{HUP} = 'IGNORE';
860 local $SIG{INT} = 'IGNORE';
861 local $SIG{QUIT} = 'IGNORE';
862 local $SIG{TERM} = 'IGNORE';
863 local $SIG{TSTP} = 'IGNORE';
864 local $SIG{PIPE} = 'IGNORE';
866 my $oldAutoCommit = $FS::UID::AutoCommit;
867 local $FS::UID::AutoCommit = 0;
870 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
872 my $error = $self->get_prepay( $prepay_credit,
873 'amount_ref' => \$amount,
874 'seconds_ref' => \$seconds,
875 'upbytes_ref' => \$upbytes,
876 'downbytes_ref' => \$downbytes,
877 'totalbytes_ref' => \$totalbytes,
879 || $self->increment_seconds($seconds)
880 || $self->increment_upbytes($upbytes)
881 || $self->increment_downbytes($downbytes)
882 || $self->increment_totalbytes($totalbytes)
883 || $self->insert_cust_pay_prepay( $amount,
885 ? $prepay_credit->identifier
890 $dbh->rollback if $oldAutoCommit;
894 if ( defined($amountref) ) { $$amountref = $amount; }
895 if ( defined($secondsref) ) { $$secondsref = $seconds; }
896 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
897 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
898 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
900 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
905 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
907 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
908 specified either by I<identifier> or as an FS::prepay_credit object.
910 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
911 incremented by the values of the prepaid card.
913 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
914 check or set this customer's I<agentnum>.
916 If there is an error, returns the error, otherwise returns false.
922 my( $self, $prepay_credit, %opt ) = @_;
924 local $SIG{HUP} = 'IGNORE';
925 local $SIG{INT} = 'IGNORE';
926 local $SIG{QUIT} = 'IGNORE';
927 local $SIG{TERM} = 'IGNORE';
928 local $SIG{TSTP} = 'IGNORE';
929 local $SIG{PIPE} = 'IGNORE';
931 my $oldAutoCommit = $FS::UID::AutoCommit;
932 local $FS::UID::AutoCommit = 0;
935 unless ( ref($prepay_credit) ) {
937 my $identifier = $prepay_credit;
939 $prepay_credit = qsearchs(
941 { 'identifier' => $identifier },
946 unless ( $prepay_credit ) {
947 $dbh->rollback if $oldAutoCommit;
948 return "Invalid prepaid card: ". $identifier;
953 if ( $prepay_credit->agentnum ) {
954 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
955 $dbh->rollback if $oldAutoCommit;
956 return "prepaid card not valid for agent ". $self->agentnum;
958 $self->agentnum($prepay_credit->agentnum);
961 my $error = $prepay_credit->delete;
963 $dbh->rollback if $oldAutoCommit;
964 return "removing prepay_credit (transaction rolled back): $error";
967 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
968 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
975 =item increment_upbytes SECONDS
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of upbytes. If there is an error, returns the error,
979 otherwise returns false.
983 sub increment_upbytes {
984 _increment_column( shift, 'upbytes', @_);
987 =item increment_downbytes SECONDS
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of downbytes. If there is an error, returns the error,
991 otherwise returns false.
995 sub increment_downbytes {
996 _increment_column( shift, 'downbytes', @_);
999 =item increment_totalbytes SECONDS
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of totalbytes. If there is an error, returns the error,
1003 otherwise returns false.
1007 sub increment_totalbytes {
1008 _increment_column( shift, 'totalbytes', @_);
1011 =item increment_seconds SECONDS
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds. If there is an error, returns the error,
1015 otherwise returns false.
1019 sub increment_seconds {
1020 _increment_column( shift, 'seconds', @_);
1023 =item _increment_column AMOUNT
1025 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1026 the specified number of seconds or bytes. If there is an error, returns
1027 the error, otherwise returns false.
1031 sub _increment_column {
1032 my( $self, $column, $amount ) = @_;
1033 warn "$me increment_column called: $column, $amount\n"
1036 return '' unless $amount;
1038 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1039 $self->ncancelled_pkgs;
1041 if ( ! @cust_pkg ) {
1042 return 'No packages with primary or single services found'.
1043 ' to apply pre-paid time';
1044 } elsif ( scalar(@cust_pkg) > 1 ) {
1045 #maybe have a way to specify the package/account?
1046 return 'Multiple packages found to apply pre-paid time';
1049 my $cust_pkg = $cust_pkg[0];
1050 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1054 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1056 if ( ! @cust_svc ) {
1057 return 'No account found to apply pre-paid time';
1058 } elsif ( scalar(@cust_svc) > 1 ) {
1059 return 'Multiple accounts found to apply pre-paid time';
1062 my $svc_acct = $cust_svc[0]->svc_x;
1063 warn " found service svcnum ". $svc_acct->pkgnum.
1064 ' ('. $svc_acct->email. ")\n"
1067 $column = "increment_$column";
1068 $svc_acct->$column($amount);
1072 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1074 Inserts a prepayment in the specified amount for this customer. An optional
1075 second argument can specify the prepayment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1080 sub insert_cust_pay_prepay {
1081 shift->insert_cust_pay('PREP', @_);
1084 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1086 Inserts a cash payment in the specified amount for this customer. An optional
1087 second argument can specify the payment identifier for tracking purposes.
1088 If there is an error, returns the error, otherwise returns false.
1092 sub insert_cust_pay_cash {
1093 shift->insert_cust_pay('CASH', @_);
1096 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1098 Inserts a Western Union payment in the specified amount for this customer. An
1099 optional second argument can specify the prepayment identifier for tracking
1100 purposes. If there is an error, returns the error, otherwise returns false.
1104 sub insert_cust_pay_west {
1105 shift->insert_cust_pay('WEST', @_);
1108 sub insert_cust_pay {
1109 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1110 my $payinfo = scalar(@_) ? shift : '';
1112 my $cust_pay = new FS::cust_pay {
1113 'custnum' => $self->custnum,
1114 'paid' => sprintf('%.2f', $amount),
1115 #'_date' => #date the prepaid card was purchased???
1117 'payinfo' => $payinfo,
1123 =item delete [ OPTION => VALUE ... ]
1125 This deletes the customer. If there is an error, returns the error, otherwise
1128 This will completely remove all traces of the customer record. This is not
1129 what you want when a customer cancels service; for that, cancel all of the
1130 customer's packages (see L</cancel>).
1132 If the customer has any uncancelled packages, you need to pass a new (valid)
1133 customer number for those packages to be transferred to, as the "new_customer"
1134 option. Cancelled packages will be deleted. Did I mention that this is NOT
1135 what you want when a customer cancels service and that you really should be
1136 looking at L<FS::cust_pkg/cancel>?
1138 You can't delete a customer with invoices (see L<FS::cust_bill>),
1139 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1140 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1141 set the "delete_financials" option to a true value.
1146 my( $self, %opt ) = @_;
1148 local $SIG{HUP} = 'IGNORE';
1149 local $SIG{INT} = 'IGNORE';
1150 local $SIG{QUIT} = 'IGNORE';
1151 local $SIG{TERM} = 'IGNORE';
1152 local $SIG{TSTP} = 'IGNORE';
1153 local $SIG{PIPE} = 'IGNORE';
1155 my $oldAutoCommit = $FS::UID::AutoCommit;
1156 local $FS::UID::AutoCommit = 0;
1159 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1160 $dbh->rollback if $oldAutoCommit;
1161 return "Can't delete a master agent customer";
1164 #use FS::access_user
1165 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1166 $dbh->rollback if $oldAutoCommit;
1167 return "Can't delete a master employee customer";
1170 tie my %financial_tables, 'Tie::IxHash',
1171 'cust_bill' => 'invoices',
1172 'cust_statement' => 'statements',
1173 'cust_credit' => 'credits',
1174 'cust_pay' => 'payments',
1175 'cust_refund' => 'refunds',
1178 foreach my $table ( keys %financial_tables ) {
1180 my @records = $self->$table();
1182 if ( @records && ! $opt{'delete_financials'} ) {
1183 $dbh->rollback if $oldAutoCommit;
1184 return "Can't delete a customer with ". $financial_tables{$table};
1187 foreach my $record ( @records ) {
1188 my $error = $record->delete;
1190 $dbh->rollback if $oldAutoCommit;
1191 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1197 my @cust_pkg = $self->ncancelled_pkgs;
1199 my $new_custnum = $opt{'new_custnum'};
1200 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1201 $dbh->rollback if $oldAutoCommit;
1202 return "Invalid new customer number: $new_custnum";
1204 foreach my $cust_pkg ( @cust_pkg ) {
1205 my %hash = $cust_pkg->hash;
1206 $hash{'custnum'} = $new_custnum;
1207 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1208 my $error = $new_cust_pkg->replace($cust_pkg,
1209 options => { $cust_pkg->options },
1212 $dbh->rollback if $oldAutoCommit;
1217 my @cancelled_cust_pkg = $self->all_pkgs;
1218 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1219 my $error = $cust_pkg->delete;
1221 $dbh->rollback if $oldAutoCommit;
1226 #cust_tax_adjustment in financials?
1227 #cust_pay_pending? ouch
1228 foreach my $table (qw(
1229 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1230 cust_payby cust_location cust_main_note cust_tax_adjustment
1231 cust_pay_void cust_pay_batch queue cust_tax_exempt
1233 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1234 my $error = $record->delete;
1236 $dbh->rollback if $oldAutoCommit;
1242 my $sth = $dbh->prepare(
1243 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1245 my $errstr = $dbh->errstr;
1246 $dbh->rollback if $oldAutoCommit;
1249 $sth->execute($self->custnum) or do {
1250 my $errstr = $sth->errstr;
1251 $dbh->rollback if $oldAutoCommit;
1257 my $ticket_dbh = '';
1258 if ($conf->config('ticket_system') eq 'RT_Internal') {
1260 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1261 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1262 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1263 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1266 if ( $ticket_dbh ) {
1268 my $ticket_sth = $ticket_dbh->prepare(
1269 'DELETE FROM Links WHERE Target = ?'
1271 my $errstr = $ticket_dbh->errstr;
1272 $dbh->rollback if $oldAutoCommit;
1275 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1277 my $errstr = $ticket_sth->errstr;
1278 $dbh->rollback if $oldAutoCommit;
1282 #check and see if the customer is the only link on the ticket, and
1283 #if so, set the ticket to deleted status in RT?
1284 #maybe someday, for now this will at least fix tickets not displaying
1288 #delete the customer record
1290 my $error = $self->SUPER::delete;
1292 $dbh->rollback if $oldAutoCommit;
1296 # cust_main exports!
1298 #my $export_args = $options{'export_args'} || [];
1301 map qsearch( 'part_export', {exportnum=>$_} ),
1302 $conf->config('cust_main-exports'); #, $agentnum
1304 foreach my $part_export ( @part_export ) {
1305 my $error = $part_export->export_delete( $self ); #, @$export_args);
1307 $dbh->rollback if $oldAutoCommit;
1308 return "exporting to ". $part_export->exporttype.
1309 " (transaction rolled back): $error";
1313 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1318 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1320 Replaces the OLD_RECORD with this one in the database. If there is an error,
1321 returns the error, otherwise returns false.
1323 To change the customer's address, set the pseudo-fields C<bill_location> and
1324 C<ship_location>. The address will still only change if at least one of the
1325 address fields differs from the existing values.
1327 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1328 set as the contact email address for a default contact with the same name as
1331 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1332 I<contact_params>, I<invoicing_list>, and I<move_pkgs>.
1334 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1335 of tax names and exemption numbers. FS::cust_main_exemption records will be
1336 deleted and inserted as appropriate.
1338 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1339 groups (describing the customer's payment methods and contacts, respectively)
1340 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1341 and L<FS::contact> for the fields these can contain.
1343 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1344 should be used instead if possible.
1346 If I<move_pkgs> is an arrayref, it will override the list of packages
1347 to be moved to the new address (see L<FS::cust_location/move_pkgs>.)
1354 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1356 : $self->replace_old;
1360 warn "$me replace called\n"
1363 my $curuser = $FS::CurrentUser::CurrentUser;
1364 return "You are not permitted to create complimentary accounts."
1365 if $self->complimentary eq 'Y'
1366 && $self->complimentary ne $old->complimentary
1367 && ! $curuser->access_right('Complimentary customer');
1369 local($ignore_expired_card) = 1
1370 if $old->payby =~ /^(CARD|DCRD)$/
1371 && $self->payby =~ /^(CARD|DCRD)$/
1372 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1374 local($ignore_banned_card) = 1
1375 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1376 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1377 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1379 if ( $self->payby =~ /^(CARD|DCRD)$/
1380 && $old->payinfo ne $self->payinfo
1381 && $old->paymask ne $self->paymask )
1383 my $error = $self->check_payinfo_cardtype;
1384 return $error if $error;
1387 return "Invoicing locale is required"
1390 && $conf->exists('cust_main-require_locale');
1392 return "You are not permitted to change customer invoicing terms."
1393 if $old->invoice_terms ne $self->invoice_terms
1394 && ! $curuser->access_right('Edit customer invoice terms');
1396 local $SIG{HUP} = 'IGNORE';
1397 local $SIG{INT} = 'IGNORE';
1398 local $SIG{QUIT} = 'IGNORE';
1399 local $SIG{TERM} = 'IGNORE';
1400 local $SIG{TSTP} = 'IGNORE';
1401 local $SIG{PIPE} = 'IGNORE';
1403 my $oldAutoCommit = $FS::UID::AutoCommit;
1404 local $FS::UID::AutoCommit = 0;
1407 for my $l (qw(bill_location ship_location)) {
1408 #my $old_loc = $old->$l;
1409 my $new_loc = $self->$l or next;
1411 # find the existing location if there is one
1412 $new_loc->set('custnum' => $self->custnum);
1413 my $error = $new_loc->find_or_insert;
1415 $dbh->rollback if $oldAutoCommit;
1418 $self->set($l.'num', $new_loc->locationnum);
1422 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1423 warn "cust_main::replace: using deprecated invoicing list argument";
1424 $invoicing_list = shift @param;
1427 my %options = @param;
1429 $invoicing_list ||= $options{invoicing_list};
1431 my @contacts = map { $_->contact } $self->cust_contact;
1432 # find a contact that matches the customer's name
1433 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1434 and $_->last eq $old->get('last') }
1436 $implicit_contact ||= FS::contact->new({
1437 'custnum' => $self->custnum,
1438 'locationnum' => $self->get('bill_locationnum'),
1441 # for any of these that are already contact emails, link to the existing
1443 if ( $invoicing_list ) {
1446 # kind of like process_m2m on these, except:
1447 # - the other side is two tables in a join
1448 # - and we might have to create new contact_emails
1449 # - and possibly a new contact
1451 # Find existing invoice emails that aren't on the implicit contact.
1452 # Any of these that are not on the new invoicing list will be removed.
1453 my %old_email_cust_contact;
1454 foreach my $cust_contact ($self->cust_contact) {
1455 next if !$cust_contact->invoice_dest;
1456 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1458 foreach my $contact_email ($cust_contact->contact->contact_email) {
1459 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1463 foreach my $dest (@$invoicing_list) {
1465 if ($dest eq 'POST') {
1467 $self->set('postal_invoice', 'Y');
1469 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1471 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1475 # See if it belongs to some other contact; if so, link it.
1476 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1478 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1479 my $cust_contact = qsearchs('cust_contact', {
1480 contactnum => $contact_email->contactnum,
1481 custnum => $self->custnum,
1482 }) || FS::cust_contact->new({
1483 contactnum => $contact_email->contactnum,
1484 custnum => $self->custnum,
1486 $cust_contact->set('invoice_dest', 'Y');
1487 my $error = $cust_contact->custcontactnum ?
1488 $cust_contact->replace : $cust_contact->insert;
1490 $dbh->rollback if $oldAutoCommit;
1491 return "$error (linking to email address $dest)";
1495 # This email address is not yet linked to any contact, so it will
1496 # be added to the implicit contact.
1497 $email .= ',' if length($email);
1503 foreach my $remove_dest (keys %old_email_cust_contact) {
1504 my $cust_contact = $old_email_cust_contact{$remove_dest};
1505 # These were not in the list of requested destinations, so take them off.
1506 $cust_contact->set('invoice_dest', '');
1507 my $error = $cust_contact->replace;
1509 $dbh->rollback if $oldAutoCommit;
1510 return "$error (unlinking email address $remove_dest)";
1514 # make sure it keeps up with the changed customer name, if any
1515 $implicit_contact->set('last', $self->get('last'));
1516 $implicit_contact->set('first', $self->get('first'));
1517 $implicit_contact->set('emailaddress', $email);
1518 $implicit_contact->set('invoice_dest', 'Y');
1519 $implicit_contact->set('custnum', $self->custnum);
1520 my $i_cust_contact =
1521 qsearchs('cust_contact', {
1522 contactnum => $implicit_contact->contactnum,
1523 custnum => $self->custnum,
1526 $implicit_contact->set($_, $i_cust_contact->$_)
1527 foreach qw( classnum selfservice_access comment );
1530 if ( $implicit_contact->contactnum ) {
1531 $error = $implicit_contact->replace;
1532 } elsif ( length($email) ) { # don't create a new contact if not needed
1533 $error = $implicit_contact->insert;
1537 $dbh->rollback if $oldAutoCommit;
1538 return "$error (adding email address $email)";
1543 # replace the customer record
1544 my $error = $self->SUPER::replace($old);
1547 $dbh->rollback if $oldAutoCommit;
1551 # now move packages to the new service location
1552 $self->set('ship_location', ''); #flush cache
1553 if ( $old->ship_locationnum and # should only be null during upgrade...
1554 $old->ship_locationnum != $self->ship_locationnum ) {
1555 $error = $old->ship_location->move_to($self->ship_location, move_pkgs => $options{'move_pkgs'});
1557 $dbh->rollback if $oldAutoCommit;
1561 # don't move packages based on the billing location, but
1562 # disable it if it's no longer in use
1563 if ( $old->bill_locationnum and
1564 $old->bill_locationnum != $self->bill_locationnum ) {
1565 $error = $old->bill_location->disable_if_unused;
1567 $dbh->rollback if $oldAutoCommit;
1572 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1574 #this could be more efficient than deleting and re-inserting, if it matters
1575 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1576 my $error = $cust_tag->delete;
1578 $dbh->rollback if $oldAutoCommit;
1582 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1583 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1584 'custnum' => $self->custnum };
1585 my $error = $cust_tag->insert;
1587 $dbh->rollback if $oldAutoCommit;
1594 my $tax_exemption = delete $options{'tax_exemption'};
1595 if ( $tax_exemption ) {
1597 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1598 if ref($tax_exemption) eq 'ARRAY';
1600 my %cust_main_exemption =
1601 map { $_->taxname => $_ }
1602 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1604 foreach my $taxname ( keys %$tax_exemption ) {
1606 if ( $cust_main_exemption{$taxname} &&
1607 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1610 delete $cust_main_exemption{$taxname};
1614 my $cust_main_exemption = new FS::cust_main_exemption {
1615 'custnum' => $self->custnum,
1616 'taxname' => $taxname,
1617 'exempt_number' => $tax_exemption->{$taxname},
1619 my $error = $cust_main_exemption->insert;
1621 $dbh->rollback if $oldAutoCommit;
1622 return "inserting cust_main_exemption (transaction rolled back): $error";
1626 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1627 my $error = $cust_main_exemption->delete;
1629 $dbh->rollback if $oldAutoCommit;
1630 return "deleting cust_main_exemption (transaction rolled back): $error";
1636 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1638 my $error = $self->process_o2m(
1639 'table' => 'cust_payby',
1640 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1641 'params' => $cust_payby_params,
1642 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1645 $dbh->rollback if $oldAutoCommit;
1651 if ( my $contact_params = delete $options{'contact_params'} ) {
1653 # this can potentially replace contacts that were created by the
1654 # invoicing list argument, but the UI shouldn't allow both of them
1657 my $error = $self->process_o2m(
1658 'table' => 'contact',
1659 'fields' => FS::contact->cgi_contact_fields,
1660 'params' => $contact_params,
1663 $dbh->rollback if $oldAutoCommit;
1669 unless ( $import || $skip_fuzzyfiles ) {
1670 $error = $self->queue_fuzzyfiles_update;
1672 $dbh->rollback if $oldAutoCommit;
1673 return "updating fuzzy search cache: $error";
1677 # tax district update in cust_location
1679 # cust_main exports!
1681 my $export_args = $options{'export_args'} || [];
1684 map qsearch( 'part_export', {exportnum=>$_} ),
1685 $conf->config('cust_main-exports'); #, $agentnum
1687 foreach my $part_export ( @part_export ) {
1688 my $error = $part_export->export_replace( $self, $old, @$export_args);
1690 $dbh->rollback if $oldAutoCommit;
1691 return "exporting to ". $part_export->exporttype.
1692 " (transaction rolled back): $error";
1696 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1701 =item queue_fuzzyfiles_update
1703 Used by insert & replace to update the fuzzy search cache
1707 use FS::cust_main::Search;
1708 sub queue_fuzzyfiles_update {
1711 local $SIG{HUP} = 'IGNORE';
1712 local $SIG{INT} = 'IGNORE';
1713 local $SIG{QUIT} = 'IGNORE';
1714 local $SIG{TERM} = 'IGNORE';
1715 local $SIG{TSTP} = 'IGNORE';
1716 local $SIG{PIPE} = 'IGNORE';
1718 my $oldAutoCommit = $FS::UID::AutoCommit;
1719 local $FS::UID::AutoCommit = 0;
1722 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1723 my $queue = new FS::queue {
1724 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1726 my @args = "cust_main.$field", $self->get($field);
1727 my $error = $queue->insert( @args );
1729 $dbh->rollback if $oldAutoCommit;
1730 return "queueing job (transaction rolled back): $error";
1735 push @locations, $self->bill_location if $self->bill_locationnum;
1736 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1737 foreach my $location (@locations) {
1738 my $queue = new FS::queue {
1739 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1741 my @args = 'cust_location.address1', $location->address1;
1742 my $error = $queue->insert( @args );
1744 $dbh->rollback if $oldAutoCommit;
1745 return "queueing job (transaction rolled back): $error";
1749 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1756 Checks all fields to make sure this is a valid customer record. If there is
1757 an error, returns the error, otherwise returns false. Called by the insert
1758 and replace methods.
1765 warn "$me check BEFORE: \n". $self->_dump
1769 $self->ut_numbern('custnum')
1770 || $self->ut_number('agentnum')
1771 || $self->ut_textn('agent_custid')
1772 || $self->ut_number('refnum')
1773 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1774 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1775 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1776 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1777 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1778 || $self->ut_textn('custbatch')
1779 || $self->ut_name('last')
1780 || $self->ut_name('first')
1781 || $self->ut_snumbern('signupdate')
1782 || $self->ut_snumbern('birthdate')
1783 || $self->ut_namen('spouse_last')
1784 || $self->ut_namen('spouse_first')
1785 || $self->ut_snumbern('spouse_birthdate')
1786 || $self->ut_snumbern('anniversary_date')
1787 || $self->ut_textn('company')
1788 || $self->ut_textn('ship_company')
1789 || $self->ut_anything('comments')
1790 || $self->ut_numbern('referral_custnum')
1791 || $self->ut_textn('stateid')
1792 || $self->ut_textn('stateid_state')
1793 || $self->ut_textn('invoice_terms')
1794 || $self->ut_floatn('cdr_termination_percentage')
1795 || $self->ut_floatn('credit_limit')
1796 || $self->ut_numbern('billday')
1797 || $self->ut_numbern('prorate_day')
1798 || $self->ut_flag('force_prorate_day')
1799 || $self->ut_flag('edit_subject')
1800 || $self->ut_flag('calling_list_exempt')
1801 || $self->ut_flag('invoice_noemail')
1802 || $self->ut_flag('message_noemail')
1803 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1804 || $self->ut_currencyn('currency')
1805 || $self->ut_textn('po_number')
1806 || $self->ut_enum('complimentary', [ '', 'Y' ])
1807 || $self->ut_flag('invoice_ship_address')
1808 || $self->ut_flag('invoice_dest')
1811 foreach (qw(company ship_company)) {
1812 my $company = $self->get($_);
1813 $company =~ s/^\s+//;
1814 $company =~ s/\s+$//;
1815 $company =~ s/\s+/ /g;
1816 $self->set($_, $company);
1819 #barf. need message catalogs. i18n. etc.
1820 $error .= "Please select an advertising source."
1821 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1822 return $error if $error;
1824 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1825 or return "Unknown agent";
1827 if ( $self->currency ) {
1828 my $agent_currency = qsearchs( 'agent_currency', {
1829 'agentnum' => $agent->agentnum,
1830 'currency' => $self->currency,
1832 or return "Agent ". $agent->agent.
1833 " not permitted to offer ". $self->currency. " invoicing";
1836 return "Unknown refnum"
1837 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1839 return "Unknown referring custnum: ". $self->referral_custnum
1840 unless ! $self->referral_custnum
1841 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1843 if ( $self->ss eq '' ) {
1848 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1849 or return "Illegal social security number: ". $self->ss;
1850 $self->ss("$1-$2-$3");
1853 #turn off invoice_ship_address if ship & bill are the same
1854 if ($self->bill_locationnum eq $self->ship_locationnum) {
1855 $self->invoice_ship_address('');
1858 # cust_main_county verification now handled by cust_location check
1861 $self->ut_phonen('daytime', $self->country)
1862 || $self->ut_phonen('night', $self->country)
1863 || $self->ut_phonen('fax', $self->country)
1864 || $self->ut_phonen('mobile', $self->country)
1866 return $error if $error;
1868 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1870 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1873 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1875 : FS::Msgcat::_gettext('daytime');
1876 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1878 : FS::Msgcat::_gettext('night');
1880 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1882 : FS::Msgcat::_gettext('mobile');
1884 return "$daytime_label, $night_label or $mobile_label is required"
1888 return "Please select an invoicing locale"
1891 && $conf->exists('cust_main-require_locale');
1893 return "Please select a customer class"
1894 if ! $self->classnum
1895 && $conf->exists('cust_main-require_classnum');
1897 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1898 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1902 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1904 warn "$me check AFTER: \n". $self->_dump
1907 $self->SUPER::check;
1910 sub check_payinfo_cardtype {
1913 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1915 my $payinfo = $self->payinfo;
1916 $payinfo =~ s/\D//g;
1918 return '' if $self->tokenized($payinfo); #token
1920 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1921 my $cardtype = cardtype($payinfo);
1923 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1931 Additional checks for replace only.
1936 my ($new,$old) = @_;
1937 #preserve old value if global config is set
1938 if ($old && $conf->exists('invoice-ship_address')) {
1939 $new->invoice_ship_address($old->invoice_ship_address);
1946 Returns a list of fields which have ship_ duplicates.
1951 qw( last first company
1953 address1 address2 city county state zip country
1955 daytime night fax mobile
1959 =item has_ship_address
1961 Returns true if this customer record has a separate shipping address.
1965 sub has_ship_address {
1967 $self->bill_locationnum != $self->ship_locationnum;
1972 Returns a list of key/value pairs, with the following keys: address1,
1973 adddress2, city, county, state, zip, country, district, and geocode. The
1974 shipping address is used if present.
1980 $self->ship_location->location_hash;
1985 Returns all locations (see L<FS::cust_location>) for this customer.
1992 'table' => 'cust_location',
1993 'hashref' => { 'custnum' => $self->custnum,
1994 'prospectnum' => '',
1996 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2002 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2008 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2011 =item cust_payby PAYBY
2013 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2015 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2016 Does not validate PAYBY.
2024 'table' => 'cust_payby',
2025 'hashref' => { 'custnum' => $self->custnum },
2026 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2028 $search->{'extra_sql'} = ' AND payby IN ( '.
2029 join(',', map dbh->quote($_), @payby).
2036 =item has_cust_payby_auto
2038 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2042 sub has_cust_payby_auto {
2045 'table' => 'cust_payby',
2046 'hashref' => { 'custnum' => $self->custnum, },
2047 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2048 'order_by' => 'LIMIT 1',
2055 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2056 and L<FS::cust_pkg>) for this customer, except those on hold.
2058 Returns a list: an empty list on success or a list of errors.
2064 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2069 Unsuspends all suspended packages in the on-hold state (those without setup
2070 dates) for this customer.
2076 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2081 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2083 Returns a list: an empty list on success or a list of errors.
2089 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2092 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2094 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2095 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2096 of a list of pkgparts; the hashref has the following keys:
2100 =item pkgparts - listref of pkgparts
2102 =item (other options are passed to the suspend method)
2107 Returns a list: an empty list on success or a list of errors.
2111 sub suspend_if_pkgpart {
2113 my (@pkgparts, %opt);
2114 if (ref($_[0]) eq 'HASH'){
2115 @pkgparts = @{$_[0]{pkgparts}};
2120 grep { $_->suspend(%opt) }
2121 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2122 $self->unsuspended_pkgs;
2125 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2127 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2128 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2129 instead of a list of pkgparts; the hashref has the following keys:
2133 =item pkgparts - listref of pkgparts
2135 =item (other options are passed to the suspend method)
2139 Returns a list: an empty list on success or a list of errors.
2143 sub suspend_unless_pkgpart {
2145 my (@pkgparts, %opt);
2146 if (ref($_[0]) eq 'HASH'){
2147 @pkgparts = @{$_[0]{pkgparts}};
2152 grep { $_->suspend(%opt) }
2153 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2154 $self->unsuspended_pkgs;
2157 =item cancel [ OPTION => VALUE ... ]
2159 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2160 The cancellation time will be now.
2164 Always returns a list: an empty list on success or a list of errors.
2171 warn "$me cancel called on customer ". $self->custnum. " with options ".
2172 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2174 my @pkgs = $self->ncancelled_pkgs;
2176 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2179 =item cancel_pkgs OPTIONS
2181 Cancels a specified list of packages. OPTIONS can include:
2185 =item cust_pkg - an arrayref of the packages. Required.
2187 =item time - the cancellation time, used to calculate final bills and
2188 unused-time credits if any. Will be passed through to the bill() and
2189 FS::cust_pkg::cancel() methods.
2191 =item quiet - can be set true to supress email cancellation notices.
2193 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2194 reasonnum of an existing reason, or passing a hashref will create a new reason.
2195 The hashref should have the following keys:
2196 typenum - Reason type (see L<FS::reason_type>)
2197 reason - Text of the new reason.
2199 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2200 for the individual packages, parallel to the C<cust_pkg> argument. The
2201 reason and reason_otaker arguments will be taken from those objects.
2203 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2205 =item nobill - can be set true to skip billing if it might otherwise be done.
2210 my( $self, %opt ) = @_;
2212 # we're going to cancel services, which is not reversible
2213 die "cancel_pkgs cannot be run inside a transaction"
2214 if $FS::UID::AutoCommit == 0;
2216 local $FS::UID::AutoCommit = 0;
2218 return ( 'access denied' )
2219 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2221 if ( $opt{'ban'} ) {
2223 foreach my $cust_payby ( $self->cust_payby ) {
2225 #well, if they didn't get decrypted on search, then we don't have to
2226 # try again... queue a job for the server that does have decryption
2227 # capability if we're in a paranoid multi-server implementation?
2228 return ( "Can't (yet) ban encrypted credit cards" )
2229 if $cust_payby->is_encrypted($cust_payby->payinfo);
2231 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2232 my $error = $ban->insert;
2242 my @pkgs = @{ delete $opt{'cust_pkg'} };
2243 my $cancel_time = $opt{'time'} || time;
2245 # bill all packages first, so we don't lose usage, service counts for
2246 # bulk billing, etc.
2247 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2249 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2251 'time' => $cancel_time );
2253 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2255 return ( "Error billing during cancellation: $error" );
2261 # try to cancel each service, the same way we would for individual packages,
2262 # but in cancel weight order.
2263 my @cust_svc = map { $_->cust_svc } @pkgs;
2264 my @sorted_cust_svc =
2266 sort { $a->[1] <=> $b->[1] }
2267 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2269 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2272 foreach my $cust_svc (@sorted_cust_svc) {
2273 my $part_svc = $cust_svc->part_svc;
2274 next if ( defined($part_svc) and $part_svc->preserve );
2275 # immediate cancel, no date option
2276 # transactionize individually
2277 my $error = try { $cust_svc->cancel } catch { $_ };
2280 push @errors, $error;
2289 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2290 $self->custnum. "\n"
2294 if ($opt{'cust_pkg_reason'}) {
2295 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2301 my $cpr = shift @cprs;
2303 $lopt{'reason'} = $cpr->reasonnum;
2304 $lopt{'reason_otaker'} = $cpr->otaker;
2306 warn "no reason found when canceling package ".$_->pkgnum."\n";
2307 # we're not actually required to pass a reason to cust_pkg::cancel,
2308 # but if we're getting to this point, something has gone awry.
2309 $null_reason ||= FS::reason->new_or_existing(
2310 reason => 'unknown reason',
2311 type => 'Cancel Reason',
2314 $lopt{'reason'} = $null_reason->reasonnum;
2315 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2318 my $error = $_->cancel(%lopt);
2321 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2330 sub _banned_pay_hashref {
2331 die 'cust_main->_banned_pay_hashref deprecated';
2343 'payby' => $payby2ban{$self->payby},
2344 'payinfo' => $self->payinfo,
2345 #don't ever *search* on reason! #'reason' =>
2351 Returns all notes (see L<FS::cust_main_note>) for this customer.
2356 my($self,$orderby_classnum) = (shift,shift);
2357 my $orderby = "sticky DESC, _date DESC";
2358 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2359 qsearch( 'cust_main_note',
2360 { 'custnum' => $self->custnum },
2362 "ORDER BY $orderby",
2368 Returns the agent (see L<FS::agent>) for this customer.
2372 Returns the agent name (see L<FS::agent>) for this customer.
2378 $self->agent->agent;
2383 Returns any tags associated with this customer, as FS::cust_tag objects,
2384 or an empty list if there are no tags.
2388 Returns any tags associated with this customer, as FS::part_tag objects,
2389 or an empty list if there are no tags.
2395 map $_->part_tag, $self->cust_tag;
2401 Returns the customer class, as an FS::cust_class object, or the empty string
2402 if there is no customer class.
2406 Returns the customer category name, or the empty string if there is no customer
2413 my $cust_class = $self->cust_class;
2415 ? $cust_class->categoryname
2421 Returns the customer class name, or the empty string if there is no customer
2428 my $cust_class = $self->cust_class;
2430 ? $cust_class->classname
2436 Returns the external tax status, as an FS::tax_status object, or the empty
2437 string if there is no tax status.
2443 if ( $self->taxstatusnum ) {
2444 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2452 Returns the tax status code if there is one.
2458 my $tax_status = $self->tax_status;
2460 ? $tax_status->taxstatus
2464 =item BILLING METHODS
2466 Documentation on billing methods has been moved to
2467 L<FS::cust_main::Billing>.
2469 =item REALTIME BILLING METHODS
2471 Documentation on realtime billing methods has been moved to
2472 L<FS::cust_main::Billing_Realtime>.
2476 Removes the I<paycvv> field from the database directly.
2478 If there is an error, returns the error, otherwise returns false.
2480 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2485 die 'cust_main->remove_cvv deprecated';
2487 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2488 or return dbh->errstr;
2489 $sth->execute($self->custnum)
2490 or return $sth->errstr;
2497 Returns the total owed for this customer on all invoices
2498 (see L<FS::cust_bill/owed>).
2504 $self->total_owed_date(2145859200); #12/31/2037
2507 =item total_owed_date TIME
2509 Returns the total owed for this customer on all invoices with date earlier than
2510 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2511 see L<Time::Local> and L<Date::Parse> for conversion functions.
2515 sub total_owed_date {
2519 my $custnum = $self->custnum;
2521 my $owed_sql = FS::cust_bill->owed_sql;
2524 SELECT SUM($owed_sql) FROM cust_bill
2525 WHERE custnum = $custnum
2529 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2533 =item total_owed_pkgnum PKGNUM
2535 Returns the total owed on all invoices for this customer's specific package
2536 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2540 sub total_owed_pkgnum {
2541 my( $self, $pkgnum ) = @_;
2542 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2545 =item total_owed_date_pkgnum TIME PKGNUM
2547 Returns the total owed for this customer's specific package when using
2548 experimental package balances on all invoices with date earlier than
2549 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2550 see L<Time::Local> and L<Date::Parse> for conversion functions.
2554 sub total_owed_date_pkgnum {
2555 my( $self, $time, $pkgnum ) = @_;
2558 foreach my $cust_bill (
2559 grep { $_->_date <= $time }
2560 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2562 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2564 sprintf( "%.2f", $total_bill );
2570 Returns the total amount of all payments.
2577 $total += $_->paid foreach $self->cust_pay;
2578 sprintf( "%.2f", $total );
2581 =item total_unapplied_credits
2583 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2584 customer. See L<FS::cust_credit/credited>.
2586 =item total_credited
2588 Old name for total_unapplied_credits. Don't use.
2592 sub total_credited {
2593 #carp "total_credited deprecated, use total_unapplied_credits";
2594 shift->total_unapplied_credits(@_);
2597 sub total_unapplied_credits {
2600 my $custnum = $self->custnum;
2602 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2605 SELECT SUM($unapplied_sql) FROM cust_credit
2606 WHERE custnum = $custnum
2609 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2613 =item total_unapplied_credits_pkgnum PKGNUM
2615 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2616 customer. See L<FS::cust_credit/credited>.
2620 sub total_unapplied_credits_pkgnum {
2621 my( $self, $pkgnum ) = @_;
2622 my $total_credit = 0;
2623 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2624 sprintf( "%.2f", $total_credit );
2628 =item total_unapplied_payments
2630 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2631 See L<FS::cust_pay/unapplied>.
2635 sub total_unapplied_payments {
2638 my $custnum = $self->custnum;
2640 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2643 SELECT SUM($unapplied_sql) FROM cust_pay
2644 WHERE custnum = $custnum
2647 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2651 =item total_unapplied_payments_pkgnum PKGNUM
2653 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2654 specific package when using experimental package balances. See
2655 L<FS::cust_pay/unapplied>.
2659 sub total_unapplied_payments_pkgnum {
2660 my( $self, $pkgnum ) = @_;
2661 my $total_unapplied = 0;
2662 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2663 sprintf( "%.2f", $total_unapplied );
2667 =item total_unapplied_refunds
2669 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2670 customer. See L<FS::cust_refund/unapplied>.
2674 sub total_unapplied_refunds {
2676 my $custnum = $self->custnum;
2678 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2681 SELECT SUM($unapplied_sql) FROM cust_refund
2682 WHERE custnum = $custnum
2685 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2691 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2692 total_unapplied_credits minus total_unapplied_payments).
2698 $self->balance_date_range;
2701 =item balance_date TIME
2703 Returns the balance for this customer, only considering invoices with date
2704 earlier than TIME (total_owed_date minus total_credited minus
2705 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2706 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2713 $self->balance_date_range(shift);
2716 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2718 Returns the balance for this customer, optionally considering invoices with
2719 date earlier than START_TIME, and not later than END_TIME
2720 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2722 Times are specified as SQL fragments or numeric
2723 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2724 L<Date::Parse> for conversion functions. The empty string can be passed
2725 to disable that time constraint completely.
2727 Accepts the same options as L<balance_date_sql>:
2731 =item unapplied_date
2733 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)
2737 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2738 time will be ignored. Note that START_TIME and END_TIME only limit the date
2739 range for invoices and I<unapplied> payments, credits, and refunds.
2745 sub balance_date_range {
2747 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2748 ') FROM cust_main WHERE custnum='. $self->custnum;
2749 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2752 =item balance_pkgnum PKGNUM
2754 Returns the balance for this customer's specific package when using
2755 experimental package balances (total_owed plus total_unrefunded, minus
2756 total_unapplied_credits minus total_unapplied_payments)
2760 sub balance_pkgnum {
2761 my( $self, $pkgnum ) = @_;
2764 $self->total_owed_pkgnum($pkgnum)
2765 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2766 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2767 - $self->total_unapplied_credits_pkgnum($pkgnum)
2768 - $self->total_unapplied_payments_pkgnum($pkgnum)
2774 Returns a hash of useful information for making a payment.
2784 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2785 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2786 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2790 For credit card transactions:
2802 For electronic check transactions:
2812 #XXX i need to be updated for 4.x+
2818 $return{balance} = $self->balance;
2820 $return{payname} = $self->payname
2821 || ( $self->first. ' '. $self->get('last') );
2823 $return{$_} = $self->bill_location->$_
2824 for qw(address1 address2 city state zip);
2826 $return{payby} = $self->payby;
2827 $return{stateid_state} = $self->stateid_state;
2829 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2830 $return{card_type} = cardtype($self->payinfo);
2831 $return{payinfo} = $self->paymask;
2833 @return{'month', 'year'} = $self->paydate_monthyear;
2837 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2838 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2839 $return{payinfo1} = $payinfo1;
2840 $return{payinfo2} = $payinfo2;
2841 $return{paytype} = $self->paytype;
2842 $return{paystate} = $self->paystate;
2846 #doubleclick protection
2848 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2856 Returns the next payment expiration date for this customer. If they have no
2857 payment methods that will expire, returns 0.
2863 # filter out the ones that individually return 0, but then return 0 if
2864 # there are no results
2865 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2866 min( @epochs ) || 0;
2869 =item paydate_epoch_sql
2871 Returns an SQL expression to get the next payment expiration date for a
2872 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2873 dates, so that it's safe to test for "will it expire before date X" for any
2878 sub paydate_epoch_sql {
2880 my $paydate = FS::cust_payby->paydate_epoch_sql;
2881 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2885 my( $self, $taxname ) = @_;
2887 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2888 'taxname' => $taxname,
2893 =item cust_main_exemption
2895 =item invoicing_list
2897 Returns a list of email addresses (with svcnum entries expanded), and the word
2898 'POST' if the customer receives postal invoices.
2902 sub invoicing_list {
2903 my( $self, $arrayref ) = @_;
2906 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2909 my @emails = $self->invoicing_list_emailonly;
2910 push @emails, 'POST' if $self->get('postal_invoice');
2915 =item check_invoicing_list ARRAYREF
2917 Checks these arguements as valid input for the invoicing_list method. If there
2918 is an error, returns the error, otherwise returns false.
2922 sub check_invoicing_list {
2923 my( $self, $arrayref ) = @_;
2925 foreach my $address ( @$arrayref ) {
2927 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2928 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2931 my $cust_main_invoice = new FS::cust_main_invoice ( {
2932 'custnum' => $self->custnum,
2935 my $error = $self->custnum
2936 ? $cust_main_invoice->check
2937 : $cust_main_invoice->checkdest
2939 return $error if $error;
2943 return "Email address required"
2944 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2945 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2952 Returns the email addresses of all accounts provisioned for this customer.
2959 foreach my $cust_pkg ( $self->all_pkgs ) {
2960 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2962 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2963 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2965 $list{$_}=1 foreach map { $_->email } @svc_acct;
2970 =item invoicing_list_addpost
2972 Adds postal invoicing to this customer. If this customer is already configured
2973 to receive postal invoices, does nothing.
2977 sub invoicing_list_addpost {
2979 if ( $self->get('postal_invoice') eq '' ) {
2980 $self->set('postal_invoice', 'Y');
2981 my $error = $self->replace;
2982 warn $error if $error; # should fail harder, but this is traditional
2986 =item invoicing_list_emailonly
2988 Returns the list of email invoice recipients (invoicing_list without non-email
2989 destinations such as POST and FAX).
2993 sub invoicing_list_emailonly {
2995 warn "$me invoicing_list_emailonly called"
2997 return () if !$self->custnum; # not yet inserted
2998 return map { $_->emailaddress }
3000 table => 'cust_contact',
3001 select => 'emailaddress',
3002 addl_from => ' JOIN contact USING (contactnum) '.
3003 ' JOIN contact_email USING (contactnum)',
3004 hashref => { 'custnum' => $self->custnum, },
3005 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3009 =item invoicing_list_emailonly_scalar
3011 Returns the list of email invoice recipients (invoicing_list without non-email
3012 destinations such as POST and FAX) as a comma-separated scalar.
3016 sub invoicing_list_emailonly_scalar {
3018 warn "$me invoicing_list_emailonly_scalar called"
3020 join(', ', $self->invoicing_list_emailonly);
3023 =item contact_list [ CLASSNUM, ... ]
3025 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3026 a list of contact classnums is given, returns only contacts in those
3027 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3028 are marked as invoice destinations. If '0' is given, also returns contacts
3031 If no arguments are given, returns all contacts for the customer.
3039 select => 'contact.*, cust_contact.invoice_dest',
3040 addl_from => ' JOIN cust_contact USING (contactnum)',
3041 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3047 if ( $_ eq 'invoice' ) {
3048 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3049 } elsif ( $_ eq '0' ) {
3050 push @orwhere, 'cust_contact.classnum is null';
3051 } elsif ( /^\d+$/ ) {
3052 push @classnums, $_;
3054 die "bad classnum argument '$_'";
3059 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3062 $search->{extra_sql} .= ' AND (' .
3063 join(' OR ', map "( $_ )", @orwhere) .
3070 =item contact_list_email [ CLASSNUM, ... ]
3072 Same as L</contact_list>, but returns email destinations instead of contact
3077 sub contact_list_email {
3079 my @contacts = $self->contact_list(@_);
3081 foreach my $contact (@contacts) {
3082 foreach my $contact_email ($contact->contact_email) {
3083 push @emails, Email::Address->new( $contact->firstlast,
3084 $contact_email->emailaddress
3091 =item referral_custnum_cust_main
3093 Returns the customer who referred this customer (or the empty string, if
3094 this customer was not referred).
3096 Note the difference with referral_cust_main method: This method,
3097 referral_custnum_cust_main returns the single customer (if any) who referred
3098 this customer, while referral_cust_main returns an array of customers referred
3103 sub referral_custnum_cust_main {
3105 return '' unless $self->referral_custnum;
3106 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3109 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3111 Returns an array of customers referred by this customer (referral_custnum set
3112 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3113 customers referred by customers referred by this customer and so on, inclusive.
3114 The default behavior is DEPTH 1 (no recursion).
3116 Note the difference with referral_custnum_cust_main method: This method,
3117 referral_cust_main, returns an array of customers referred BY this customer,
3118 while referral_custnum_cust_main returns the single customer (if any) who
3119 referred this customer.
3123 sub referral_cust_main {
3125 my $depth = @_ ? shift : 1;
3126 my $exclude = @_ ? shift : {};
3129 map { $exclude->{$_->custnum}++; $_; }
3130 grep { ! $exclude->{ $_->custnum } }
3131 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3135 map { $_->referral_cust_main($depth-1, $exclude) }
3142 =item referral_cust_main_ncancelled
3144 Same as referral_cust_main, except only returns customers with uncancelled
3149 sub referral_cust_main_ncancelled {
3151 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3154 =item referral_cust_pkg [ DEPTH ]
3156 Like referral_cust_main, except returns a flat list of all unsuspended (and
3157 uncancelled) packages for each customer. The number of items in this list may
3158 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3162 sub referral_cust_pkg {
3164 my $depth = @_ ? shift : 1;
3166 map { $_->unsuspended_pkgs }
3167 grep { $_->unsuspended_pkgs }
3168 $self->referral_cust_main($depth);
3171 =item referring_cust_main
3173 Returns the single cust_main record for the customer who referred this customer
3174 (referral_custnum), or false.
3178 sub referring_cust_main {
3180 return '' unless $self->referral_custnum;
3181 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3184 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3186 Applies a credit to this customer. If there is an error, returns the error,
3187 otherwise returns false.
3189 REASON can be a text string, an FS::reason object, or a scalar reference to
3190 a reasonnum. If a text string, it will be automatically inserted as a new
3191 reason, and a 'reason_type' option must be passed to indicate the
3192 FS::reason_type for the new reason.
3194 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3195 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3196 I<commission_pkgnum>.
3198 Any other options are passed to FS::cust_credit::insert.
3203 my( $self, $amount, $reason, %options ) = @_;
3205 my $cust_credit = new FS::cust_credit {
3206 'custnum' => $self->custnum,
3207 'amount' => $amount,
3210 if ( ref($reason) ) {
3212 if ( ref($reason) eq 'SCALAR' ) {
3213 $cust_credit->reasonnum( $$reason );
3215 $cust_credit->reasonnum( $reason->reasonnum );
3219 $cust_credit->set('reason', $reason)
3222 $cust_credit->$_( delete $options{$_} )
3223 foreach grep exists($options{$_}),
3224 qw( addlinfo eventnum ),
3225 map "commission_$_", qw( agentnum salesnum pkgnum );
3227 $cust_credit->insert(%options);
3231 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3233 Creates a one-time charge for this customer. If there is an error, returns
3234 the error, otherwise returns false.
3236 New-style, with a hashref of options:
3238 my $error = $cust_main->charge(
3242 'start_date' => str2time('7/4/2009'),
3243 'pkg' => 'Description',
3244 'comment' => 'Comment',
3245 'additional' => [], #extra invoice detail
3246 'classnum' => 1, #pkg_class
3248 'setuptax' => '', # or 'Y' for tax exempt
3250 'locationnum'=> 1234, # optional
3253 'taxclass' => 'Tax class',
3256 'taxproduct' => 2, #part_pkg_taxproduct
3257 'override' => {}, #XXX describe
3259 #will be filled in with the new object
3260 'cust_pkg_ref' => \$cust_pkg,
3262 #generate an invoice immediately
3264 'invoice_terms' => '', #with these terms
3270 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3274 #super false laziness w/quotation::charge
3277 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3278 my ( $pkg, $comment, $additional );
3279 my ( $setuptax, $taxclass ); #internal taxes
3280 my ( $taxproduct, $override ); #vendor (CCH) taxes
3282 my $separate_bill = '';
3283 my $cust_pkg_ref = '';
3284 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3286 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3287 if ( ref( $_[0] ) ) {
3288 $amount = $_[0]->{amount};
3289 $setup_cost = $_[0]->{setup_cost};
3290 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3291 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3292 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3293 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3294 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3295 : '$'. sprintf("%.2f",$amount);
3296 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3297 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3298 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3299 $additional = $_[0]->{additional} || [];
3300 $taxproduct = $_[0]->{taxproductnum};
3301 $override = { '' => $_[0]->{tax_override} };
3302 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3303 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3304 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3305 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3306 $separate_bill = $_[0]->{separate_bill} || '';
3307 $discountnum = $_[0]->{setup_discountnum};
3308 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3309 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3315 $pkg = @_ ? shift : 'One-time charge';
3316 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3318 $taxclass = @_ ? shift : '';
3322 local $SIG{HUP} = 'IGNORE';
3323 local $SIG{INT} = 'IGNORE';
3324 local $SIG{QUIT} = 'IGNORE';
3325 local $SIG{TERM} = 'IGNORE';
3326 local $SIG{TSTP} = 'IGNORE';
3327 local $SIG{PIPE} = 'IGNORE';
3329 my $oldAutoCommit = $FS::UID::AutoCommit;
3330 local $FS::UID::AutoCommit = 0;
3333 my $part_pkg = new FS::part_pkg ( {
3335 'comment' => $comment,
3339 'classnum' => ( $classnum ? $classnum : '' ),
3340 'setuptax' => $setuptax,
3341 'taxclass' => $taxclass,
3342 'taxproductnum' => $taxproduct,
3343 'setup_cost' => $setup_cost,
3346 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3347 ( 0 .. @$additional - 1 )
3349 'additional_count' => scalar(@$additional),
3350 'setup_fee' => $amount,
3353 my $error = $part_pkg->insert( options => \%options,
3354 tax_overrides => $override,
3357 $dbh->rollback if $oldAutoCommit;
3361 my $pkgpart = $part_pkg->pkgpart;
3362 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3363 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3364 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3365 $error = $type_pkgs->insert;
3367 $dbh->rollback if $oldAutoCommit;
3372 my $cust_pkg = new FS::cust_pkg ( {
3373 'custnum' => $self->custnum,
3374 'pkgpart' => $pkgpart,
3375 'quantity' => $quantity,
3376 'start_date' => $start_date,
3377 'no_auto' => $no_auto,
3378 'separate_bill' => $separate_bill,
3379 'locationnum' => $locationnum,
3380 'setup_discountnum' => $discountnum,
3381 'setup_discountnum_amount' => $discountnum_amount,
3382 'setup_discountnum_percent' => $discountnum_percent,
3385 $error = $cust_pkg->insert;
3387 $dbh->rollback if $oldAutoCommit;
3389 } elsif ( $cust_pkg_ref ) {
3390 ${$cust_pkg_ref} = $cust_pkg;
3394 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3395 'pkg_list' => [ $cust_pkg ],
3398 $dbh->rollback if $oldAutoCommit;
3403 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3408 #=item charge_postal_fee
3410 #Applies a one time charge this customer. If there is an error,
3411 #returns the error, returns the cust_pkg charge object or false
3412 #if there was no charge.
3416 # This should be a customer event. For that to work requires that bill
3417 # also be a customer event.
3419 sub charge_postal_fee {
3422 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3423 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3425 my $cust_pkg = new FS::cust_pkg ( {
3426 'custnum' => $self->custnum,
3427 'pkgpart' => $pkgpart,
3431 my $error = $cust_pkg->insert;
3432 $error ? $error : $cust_pkg;
3435 =item num_cust_attachment_deleted
3437 Returns the number of deleted attachments for this customer (see
3438 L<FS::num_cust_attachment>).
3442 sub num_cust_attachments_deleted {
3445 " SELECT COUNT(*) FROM cust_attachment ".
3446 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3453 Returns the most recent invnum (invoice number) for this customer.
3460 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3465 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3467 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3469 Optionally, a list or hashref of additional arguments to the qsearch call can
3476 my $opt = ref($_[0]) ? shift : { @_ };
3478 #return $self->num_cust_bill unless wantarray || keys %$opt;
3480 $opt->{'table'} = 'cust_bill';
3481 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3482 $opt->{'hashref'}{'custnum'} = $self->custnum;
3483 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3485 map { $_ } #behavior of sort undefined in scalar context
3486 sort { $a->_date <=> $b->_date }
3490 =item open_cust_bill
3492 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3497 sub open_cust_bill {
3501 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3507 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3509 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3513 sub legacy_cust_bill {
3516 #return $self->num_legacy_cust_bill unless wantarray;
3518 map { $_ } #behavior of sort undefined in scalar context
3519 sort { $a->_date <=> $b->_date }
3520 qsearch({ 'table' => 'legacy_cust_bill',
3521 'hashref' => { 'custnum' => $self->custnum, },
3522 'order_by' => 'ORDER BY _date ASC',
3526 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3528 Returns all the statements (see L<FS::cust_statement>) for this customer.
3530 Optionally, a list or hashref of additional arguments to the qsearch call can
3535 =item cust_bill_void
3537 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3541 sub cust_bill_void {
3544 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3545 sort { $a->_date <=> $b->_date }
3546 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3549 sub cust_statement {
3551 my $opt = ref($_[0]) ? shift : { @_ };
3553 #return $self->num_cust_statement unless wantarray || keys %$opt;
3555 $opt->{'table'} = 'cust_statement';
3556 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3557 $opt->{'hashref'}{'custnum'} = $self->custnum;
3558 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3560 map { $_ } #behavior of sort undefined in scalar context
3561 sort { $a->_date <=> $b->_date }
3565 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3567 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3569 Optionally, a list or hashref of additional arguments to the qsearch call can
3570 be passed following the SVCDB.
3577 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3578 warn "$me svc_x requires a svcdb";
3581 my $opt = ref($_[0]) ? shift : { @_ };
3583 $opt->{'table'} = $svcdb;
3584 $opt->{'addl_from'} =
3585 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3586 ($opt->{'addl_from'} || '');
3588 my $custnum = $self->custnum;
3589 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3590 my $where = "cust_pkg.custnum = $custnum";
3592 my $extra_sql = $opt->{'extra_sql'} || '';
3593 if ( keys %{ $opt->{'hashref'} } ) {
3594 $extra_sql = " AND $where $extra_sql";
3597 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3598 $extra_sql = "WHERE $where AND $1";
3601 $extra_sql = "WHERE $where $extra_sql";
3604 $opt->{'extra_sql'} = $extra_sql;
3609 # required for use as an eventtable;
3612 $self->svc_x('svc_acct', @_);
3617 Returns all the credits (see L<FS::cust_credit>) for this customer.
3624 #return $self->num_cust_credit unless wantarray;
3626 map { $_ } #behavior of sort undefined in scalar context
3627 sort { $a->_date <=> $b->_date }
3628 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3631 =item cust_credit_pkgnum
3633 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3634 package when using experimental package balances.
3638 sub cust_credit_pkgnum {
3639 my( $self, $pkgnum ) = @_;
3640 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3641 sort { $a->_date <=> $b->_date }
3642 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3643 'pkgnum' => $pkgnum,
3648 =item cust_credit_void
3650 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3654 sub cust_credit_void {
3657 sort { $a->_date <=> $b->_date }
3658 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3663 Returns all the payments (see L<FS::cust_pay>) for this customer.
3669 my $opt = ref($_[0]) ? shift : { @_ };
3671 return $self->num_cust_pay unless wantarray || keys %$opt;
3673 $opt->{'table'} = 'cust_pay';
3674 $opt->{'hashref'}{'custnum'} = $self->custnum;
3676 map { $_ } #behavior of sort undefined in scalar context
3677 sort { $a->_date <=> $b->_date }
3684 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3685 called automatically when the cust_pay method is used in a scalar context.
3691 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3692 my $sth = dbh->prepare($sql) or die dbh->errstr;
3693 $sth->execute($self->custnum) or die $sth->errstr;
3694 $sth->fetchrow_arrayref->[0];
3697 =item unapplied_cust_pay
3699 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3703 sub unapplied_cust_pay {
3707 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3713 =item cust_pay_pkgnum
3715 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3716 package when using experimental package balances.
3720 sub cust_pay_pkgnum {
3721 my( $self, $pkgnum ) = @_;
3722 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3723 sort { $a->_date <=> $b->_date }
3724 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3725 'pkgnum' => $pkgnum,
3732 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3738 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3739 sort { $a->_date <=> $b->_date }
3740 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3743 =item cust_pay_pending
3745 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3746 (without status "done").
3750 sub cust_pay_pending {
3752 return $self->num_cust_pay_pending unless wantarray;
3753 sort { $a->_date <=> $b->_date }
3754 qsearch( 'cust_pay_pending', {
3755 'custnum' => $self->custnum,
3756 'status' => { op=>'!=', value=>'done' },
3761 =item cust_pay_pending_attempt
3763 Returns all payment attempts / declined payments for this customer, as pending
3764 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3765 a corresponding payment (see L<FS::cust_pay>).
3769 sub cust_pay_pending_attempt {
3771 return $self->num_cust_pay_pending_attempt unless wantarray;
3772 sort { $a->_date <=> $b->_date }
3773 qsearch( 'cust_pay_pending', {
3774 'custnum' => $self->custnum,
3781 =item num_cust_pay_pending
3783 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3784 customer (without status "done"). Also called automatically when the
3785 cust_pay_pending method is used in a scalar context.
3789 sub num_cust_pay_pending {
3792 " SELECT COUNT(*) FROM cust_pay_pending ".
3793 " WHERE custnum = ? AND status != 'done' ",
3798 =item num_cust_pay_pending_attempt
3800 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3801 customer, with status "done" but without a corresp. Also called automatically when the
3802 cust_pay_pending method is used in a scalar context.
3806 sub num_cust_pay_pending_attempt {
3809 " SELECT COUNT(*) FROM cust_pay_pending ".
3810 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3817 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3823 map { $_ } #return $self->num_cust_refund unless wantarray;
3824 sort { $a->_date <=> $b->_date }
3825 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3828 =item display_custnum
3830 Returns the displayed customer number for this customer: agent_custid if
3831 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3835 sub display_custnum {
3838 return $self->agent_custid
3839 if $default_agent_custid && $self->agent_custid;
3841 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3845 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3846 } elsif ( $custnum_display_length ) {
3847 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3849 return $self->custnum;
3855 Returns a name string for this customer, either "Company (Last, First)" or
3862 my $name = $self->contact;
3863 $name = $self->company. " ($name)" if $self->company;
3867 =item service_contact
3869 Returns the L<FS::contact> object for this customer that has the 'Service'
3870 contact class, or undef if there is no such contact. Deprecated; don't use
3875 sub service_contact {
3877 if ( !exists($self->{service_contact}) ) {
3878 my $classnum = $self->scalar_sql(
3879 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3880 ) || 0; #if it's zero, qsearchs will return nothing
3881 my $cust_contact = qsearchs('cust_contact', {
3882 'classnum' => $classnum,
3883 'custnum' => $self->custnum,
3885 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3887 $self->{service_contact};
3892 Returns a name string for this (service/shipping) contact, either
3893 "Company (Last, First)" or "Last, First".
3900 my $name = $self->ship_contact;
3901 $name = $self->company. " ($name)" if $self->company;
3907 Returns a name string for this customer, either "Company" or "First Last".
3913 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3916 =item ship_name_short
3918 Returns a name string for this (service/shipping) contact, either "Company"
3923 sub ship_name_short {
3925 $self->service_contact
3926 ? $self->ship_contact_firstlast
3932 Returns this customer's full (billing) contact name only, "Last, First"
3938 $self->get('last'). ', '. $self->first;
3943 Returns this customer's full (shipping) contact name only, "Last, First"
3949 my $contact = $self->service_contact || $self;
3950 $contact->get('last') . ', ' . $contact->get('first');
3953 =item contact_firstlast
3955 Returns this customers full (billing) contact name only, "First Last".
3959 sub contact_firstlast {
3961 $self->first. ' '. $self->get('last');
3964 =item ship_contact_firstlast
3966 Returns this customer's full (shipping) contact name only, "First Last".
3970 sub ship_contact_firstlast {
3972 my $contact = $self->service_contact || $self;
3973 $contact->get('first') . ' '. $contact->get('last');
3976 sub bill_country_full {
3978 $self->bill_location->country_full;
3981 sub ship_country_full {
3983 $self->ship_location->country_full;
3986 =item county_state_county [ PREFIX ]
3988 Returns a string consisting of just the county, state and country.
3992 sub county_state_country {
3995 if ( @_ && $_[0] && $self->has_ship_address ) {
3996 $locationnum = $self->ship_locationnum;
3998 $locationnum = $self->bill_locationnum;
4000 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4001 $cust_location->county_state_country;
4004 =item geocode DATA_VENDOR
4006 Returns a value for the customer location as encoded by DATA_VENDOR.
4007 Currently this only makes sense for "CCH" as DATA_VENDOR.
4015 Returns a status string for this customer, currently:
4021 No packages have ever been ordered. Displayed as "No packages".
4025 Recurring packages all are new (not yet billed).
4029 One or more recurring packages is active.
4033 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4037 All non-cancelled recurring packages are suspended.
4041 All recurring packages are cancelled.
4045 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4046 cust_main-status_module configuration option.
4050 sub status { shift->cust_status(@_); }
4054 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4055 for my $status ( FS::cust_main->statuses() ) {
4056 my $method = $status.'_sql';
4057 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4058 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4059 $sth->execute( ($self->custnum) x $numnum )
4060 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4061 if ( $sth->fetchrow_arrayref->[0] ) {
4062 $self->hashref->{cust_status} = $status;
4068 =item is_status_delay_cancel
4070 Returns true if customer status is 'suspended'
4071 and all suspended cust_pkg return true for
4072 cust_pkg->is_status_delay_cancel.
4074 This is not a real status, this only meant for hacking display
4075 values, because otherwise treating the customer as suspended is
4076 really the whole point of the delay_cancel option.
4080 sub is_status_delay_cancel {
4082 return 0 unless $self->status eq 'suspended';
4083 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4084 return 0 unless $cust_pkg->is_status_delay_cancel;
4089 =item ucfirst_cust_status
4091 =item ucfirst_status
4093 Deprecated, use the cust_status_label method instead.
4095 Returns the status with the first character capitalized.
4099 sub ucfirst_status {
4100 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4101 local($ucfirst_nowarn) = 1;
4102 shift->ucfirst_cust_status(@_);
4105 sub ucfirst_cust_status {
4106 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4108 ucfirst($self->cust_status);
4111 =item cust_status_label
4115 Returns the display label for this status.
4119 sub status_label { shift->cust_status_label(@_); }
4121 sub cust_status_label {
4123 __PACKAGE__->statuslabels->{$self->cust_status};
4128 Returns a hex triplet color string for this customer's status.
4132 sub statuscolor { shift->cust_statuscolor(@_); }
4134 sub cust_statuscolor {
4136 __PACKAGE__->statuscolors->{$self->cust_status};
4139 =item tickets [ STATUS ]
4141 Returns an array of hashes representing the customer's RT tickets.
4143 An optional status (or arrayref or hashref of statuses) may be specified.
4149 my $status = ( @_ && $_[0] ) ? shift : '';
4151 my $num = $conf->config('cust_main-max_tickets') || 10;
4154 if ( $conf->config('ticket_system') ) {
4155 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4157 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4166 foreach my $priority (
4167 $conf->config('ticket_system-custom_priority_field-values'), ''
4169 last if scalar(@tickets) >= $num;
4171 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4172 $num - scalar(@tickets),
4183 =item appointments [ STATUS ]
4185 Returns an array of hashes representing the customer's RT tickets which
4192 my $status = ( @_ && $_[0] ) ? shift : '';
4194 return () unless $conf->config('ticket_system');
4196 my $queueid = $conf->config('ticket_system-appointment-queueid');
4198 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4207 # Return services representing svc_accts in customer support packages
4208 sub support_services {
4210 my %packages = map { $_ => 1 } $conf->config('support_packages');
4212 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4213 grep { $_->part_svc->svcdb eq 'svc_acct' }
4214 map { $_->cust_svc }
4215 grep { exists $packages{ $_->pkgpart } }
4216 $self->ncancelled_pkgs;
4220 # Return a list of latitude/longitude for one of the services (if any)
4221 sub service_coordinates {
4225 grep { $_->latitude && $_->longitude }
4227 map { $_->cust_svc }
4228 $self->ncancelled_pkgs;
4230 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4235 Returns a masked version of the named field
4240 my ($self,$field) = @_;
4244 'x'x(length($self->getfield($field))-4).
4245 substr($self->getfield($field), (length($self->getfield($field))-4));
4249 =item payment_history
4251 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4252 cust_credit and cust_refund objects. Each hashref has the following fields:
4254 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4256 I<date> - value of _date field, unix timestamp
4258 I<date_pretty> - user-friendly date
4260 I<description> - user-friendly description of item
4262 I<amount> - impact of item on user's balance
4263 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4264 Not to be confused with the native 'amount' field in cust_credit, see below.
4266 I<amount_pretty> - includes money char
4268 I<balance> - customer balance, chronologically as of this item
4270 I<balance_pretty> - includes money char
4272 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4274 I<paid> - amount paid for cust_pay records, undef for other types
4276 I<credit> - amount credited for cust_credit records, undef for other types.
4277 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4279 I<refund> - amount refunded for cust_refund records, undef for other types
4281 The four table-specific keys always have positive values, whether they reflect charges or payments.
4283 The following options may be passed to this method:
4285 I<line_items> - if true, returns charges ('Line item') rather than invoices
4287 I<start_date> - unix timestamp, only include records on or after.
4288 If specified, an item of type 'Previous' will also be included.
4289 It does not have table-specific fields.
4291 I<end_date> - unix timestamp, only include records before
4293 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4295 I<conf> - optional already-loaded FS::Conf object.
4299 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4300 # and also for sending customer statements, which should both be kept customer-friendly.
4301 # If you add anything that shouldn't be passed on through the API or exposed
4302 # to customers, add a new option to include it, don't include it by default
4303 sub payment_history {
4305 my $opt = ref($_[0]) ? $_[0] : { @_ };
4307 my $conf = $$opt{'conf'} || new FS::Conf;
4308 my $money_char = $conf->config("money_char") || '$',
4310 #first load entire history,
4311 #need previous to calculate previous balance
4312 #loading after end_date shouldn't hurt too much?
4314 if ( $$opt{'line_items'} ) {
4316 foreach my $cust_bill ( $self->cust_bill ) {
4319 'type' => 'Line item',
4320 'description' => $_->desc( $self->locale ).
4321 ( $_->sdate && $_->edate
4322 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4323 ' To '. time2str('%d-%b-%Y', $_->edate)
4326 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4327 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4328 'date' => $cust_bill->_date,
4329 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4331 foreach $cust_bill->cust_bill_pkg;
4338 'type' => 'Invoice',
4339 'description' => 'Invoice #'. $_->display_invnum,
4340 'amount' => sprintf('%.2f', $_->charged ),
4341 'charged' => sprintf('%.2f', $_->charged ),
4342 'date' => $_->_date,
4343 'date_pretty' => $self->time2str_local('short', $_->_date ),
4345 foreach $self->cust_bill;
4350 'type' => 'Payment',
4351 'description' => 'Payment', #XXX type
4352 'amount' => sprintf('%.2f', 0 - $_->paid ),
4353 'paid' => sprintf('%.2f', $_->paid ),
4354 'date' => $_->_date,
4355 'date_pretty' => $self->time2str_local('short', $_->_date ),
4357 foreach $self->cust_pay;
4361 'description' => 'Credit', #more info?
4362 'amount' => sprintf('%.2f', 0 -$_->amount ),
4363 'credit' => sprintf('%.2f', $_->amount ),
4364 'date' => $_->_date,
4365 'date_pretty' => $self->time2str_local('short', $_->_date ),
4367 foreach $self->cust_credit;
4371 'description' => 'Refund', #more info? type, like payment?
4372 'amount' => $_->refund,
4373 'refund' => $_->refund,
4374 'date' => $_->_date,
4375 'date_pretty' => $self->time2str_local('short', $_->_date ),
4377 foreach $self->cust_refund;
4379 #put it all in chronological order
4380 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4382 #calculate balance, filter items outside date range
4386 foreach my $item (@history) {
4387 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4388 $balance += $$item{'amount'};
4389 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4390 $previous += $$item{'amount'};
4393 $$item{'balance'} = sprintf("%.2f",$balance);
4394 foreach my $key ( qw(amount balance) ) {
4395 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4400 # start with previous balance, if there was one
4403 'type' => 'Previous',
4404 'description' => 'Previous balance',
4405 'amount' => sprintf("%.2f",$previous),
4406 'balance' => sprintf("%.2f",$previous),
4407 'date' => $$opt{'start_date'},
4408 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4410 #false laziness with above
4411 foreach my $key ( qw(amount balance) ) {
4412 $$item{$key.'_pretty'} = $$item{$key};
4413 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4415 unshift(@out,$item);
4418 @out = reverse @history if $$opt{'reverse_sort'};
4423 =item save_cust_payby
4425 Saves a new cust_payby for this customer, replacing an existing entry only
4426 in select circumstances. Does not validate input.
4428 If auto is specified, marks this as the customer's primary method, or the
4429 specified weight. Existing payment methods have their weight incremented as
4432 If bill_location is specified with auto, also sets location in cust_main.
4434 Will not insert complete duplicates of existing records, or records in which the
4435 only difference from an existing record is to turn off automatic payment (will
4436 return without error.) Will replace existing records in which the only difference
4437 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4438 Fields marked as preserved are optional, and existing values will not be overwritten with
4439 blanks when replacing.
4441 Accepts the following named parameters:
4451 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4455 optional, set higher than 1 for secondary, etc.
4463 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4471 optional, will be preserved when replacing
4479 CARD only, required, FS::cust_location object
4481 =item paystart_month
4483 CARD only, optional, will be preserved when replacing
4487 CARD only, optional, will be preserved when replacing
4491 CARD only, optional, will be preserved when replacing
4495 CARD only, only used if conf cvv-save is set appropriately
4505 =item saved_cust_payby
4507 scalar reference, for returning saved object
4513 #The code for this option is in place, but it's not currently used
4517 # existing cust_payby object to be replaced (must match custnum)
4519 # stateid/stateid_state/ss are not currently supported in cust_payby,
4520 # might not even work properly in 4.x, but will need to work here if ever added
4522 sub save_cust_payby {
4526 my $old = $opt{'replace'};
4527 my $new = new FS::cust_payby { $old ? $old->hash : () };
4528 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4529 $new->set( 'custnum' => $self->custnum );
4531 my $payby = $opt{'payment_payby'};
4532 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4534 # don't allow turning off auto when replacing
4535 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4537 my @check_existing; # payby relevant to this payment_payby
4539 # set payby based on auto
4540 if ( $payby eq 'CARD' ) {
4541 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4542 @check_existing = qw( CARD DCRD );
4543 } elsif ( $payby eq 'CHEK' ) {
4544 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4545 @check_existing = qw( CHEK DCHK );
4548 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4551 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4552 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4553 $new->set( 'payname' => $opt{'payname'} );
4554 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4556 my $conf = new FS::Conf;
4558 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4559 if ( $payby eq 'CARD' &&
4560 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4561 || $conf->exists('business-onlinepayment-verification')
4564 $new->set( 'paycvv' => $opt{'paycvv'} );
4566 $new->set( 'paycvv' => '');
4569 local $SIG{HUP} = 'IGNORE';
4570 local $SIG{INT} = 'IGNORE';
4571 local $SIG{QUIT} = 'IGNORE';
4572 local $SIG{TERM} = 'IGNORE';
4573 local $SIG{TSTP} = 'IGNORE';
4574 local $SIG{PIPE} = 'IGNORE';
4576 my $oldAutoCommit = $FS::UID::AutoCommit;
4577 local $FS::UID::AutoCommit = 0;
4580 # set fields specific to payment_payby
4581 if ( $payby eq 'CARD' ) {
4582 if ($opt{'bill_location'}) {
4583 $opt{'bill_location'}->set('custnum' => $self->custnum);
4584 my $error = $opt{'bill_location'}->find_or_insert;
4586 $dbh->rollback if $oldAutoCommit;
4589 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4591 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4592 $new->set( $field => $opt{$field} );
4595 foreach my $field ( qw(paytype paystate) ) {
4596 $new->set( $field => $opt{$field} );
4600 # other cust_payby to compare this to
4601 my @existing = $self->cust_payby(@check_existing);
4603 # fields that can overwrite blanks with values, but not values with blanks
4604 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4606 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4608 # generally, we don't want to overwrite existing cust_payby with this,
4609 # but we can replace if we're only marking it auto or adding a preserved field
4610 # and we can avoid saving a total duplicate or merely turning off auto
4612 foreach my $cust_payby (@existing) {
4613 # check fields that absolutely should not change
4614 foreach my $field ($new->fields) {
4615 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4616 next if grep(/^$field$/, @preserve );
4617 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4619 # now check fields that can replace if one value is blank
4621 foreach my $field (@preserve) {
4623 ( $new->get($field) and !$cust_payby->get($field) ) or
4624 ( $cust_payby->get($field) and !$new->get($field) )
4626 # prevention of overwriting values with blanks happens farther below
4628 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4632 unless ( $replace ) {
4633 # nearly identical, now check weight
4634 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4635 # ignore identical cust_payby, and ignore attempts to turn off auto
4636 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4637 $skip_cust_payby = 1;
4640 # otherwise, only change is to mark this as primary
4642 # if we got this far, we're definitely replacing
4649 $new->set( 'custpaybynum' => $old->custpaybynum );
4650 # don't turn off automatic payment (but allow it to be turned on)
4651 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4653 $new->set( 'payby' => $old->payby );
4654 $new->set( 'weight' => 1 );
4656 # make sure we're not overwriting values with blanks
4657 foreach my $field (@preserve) {
4658 if ( $old->get($field) and !$new->get($field) ) {
4659 $new->set( $field => $old->get($field) );
4664 # only overwrite cust_main bill_location if auto
4665 if ($opt{'auto'} && $opt{'bill_location'}) {
4666 $self->set('bill_location' => $opt{'bill_location'});
4667 my $error = $self->replace;
4669 $dbh->rollback if $oldAutoCommit;
4674 # done with everything except reweighting and saving cust_payby
4675 # still need to commit changes to cust_main and cust_location
4676 if ($skip_cust_payby) {
4677 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4681 # re-weight existing primary cust_pay for this payby
4683 foreach my $cust_payby (@existing) {
4684 # relies on cust_payby return order
4685 last unless $cust_payby->payby !~ /^D/;
4686 last if $cust_payby->weight > 1;
4687 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4688 next if $cust_payby->weight < ($opt{'weight'} || 1);
4689 $cust_payby->weight( $cust_payby->weight + 1 );
4690 my $error = $cust_payby->replace;
4692 $dbh->rollback if $oldAutoCommit;
4693 return "Error reweighting cust_payby: $error";
4698 # finally, save cust_payby
4699 my $error = $old ? $new->replace($old) : $new->insert;
4701 $dbh->rollback if $oldAutoCommit;
4705 ${$opt{'saved_cust_payby'}} = $new
4706 if $opt{'saved_cust_payby'};
4708 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4713 =item remove_cvv_from_cust_payby PAYINFO
4715 Removes paycvv from associated cust_payby with matching PAYINFO.
4719 sub remove_cvv_from_cust_payby {
4720 my ($self,$payinfo) = @_;
4722 my $oldAutoCommit = $FS::UID::AutoCommit;
4723 local $FS::UID::AutoCommit = 0;
4726 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4727 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4728 $cust_payby->paycvv('');
4729 my $error = $cust_payby->replace;
4731 $dbh->rollback if $oldAutoCommit;
4736 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4742 =head1 CLASS METHODS
4748 Class method that returns the list of possible status strings for customers
4749 (see L<the status method|/status>). For example:
4751 @statuses = FS::cust_main->statuses();
4757 keys %{ $self->statuscolors };
4760 =item cust_status_sql
4762 Returns an SQL fragment to determine the status of a cust_main record, as a
4767 sub cust_status_sql {
4769 for my $status ( FS::cust_main->statuses() ) {
4770 my $method = $status.'_sql';
4771 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4780 Returns an SQL expression identifying prospective cust_main records (customers
4781 with no packages ever ordered)
4785 use vars qw($select_count_pkgs);
4786 $select_count_pkgs =
4787 "SELECT COUNT(*) FROM cust_pkg
4788 WHERE cust_pkg.custnum = cust_main.custnum";
4790 sub select_count_pkgs_sql {
4795 " 0 = ( $select_count_pkgs ) ";
4800 Returns an SQL expression identifying ordered cust_main records (customers with
4801 no active packages, but recurring packages not yet setup or one time charges
4807 FS::cust_main->none_active_sql.
4808 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4813 Returns an SQL expression identifying active cust_main records (customers with
4814 active recurring packages).
4819 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4822 =item none_active_sql
4824 Returns an SQL expression identifying cust_main records with no active
4825 recurring packages. This includes customers of status prospect, ordered,
4826 inactive, and suspended.
4830 sub none_active_sql {
4831 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4836 Returns an SQL expression identifying inactive cust_main records (customers with
4837 no active recurring packages, but otherwise unsuspended/uncancelled).
4842 FS::cust_main->none_active_sql.
4843 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4849 Returns an SQL expression identifying suspended cust_main records.
4854 sub suspended_sql { susp_sql(@_); }
4856 FS::cust_main->none_active_sql.
4857 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4863 Returns an SQL expression identifying cancelled cust_main records.
4867 sub cancel_sql { shift->cancelled_sql(@_); }
4870 =item uncancelled_sql
4872 Returns an SQL expression identifying un-cancelled cust_main records.
4876 sub uncancelled_sql { uncancel_sql(@_); }
4879 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
4884 Returns an SQL fragment to retreive the balance.
4889 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4890 WHERE cust_bill.custnum = cust_main.custnum )
4891 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4892 WHERE cust_pay.custnum = cust_main.custnum )
4893 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4894 WHERE cust_credit.custnum = cust_main.custnum )
4895 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4896 WHERE cust_refund.custnum = cust_main.custnum )
4899 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4901 Returns an SQL fragment to retreive the balance for this customer, optionally
4902 considering invoices with date earlier than START_TIME, and not
4903 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4904 total_unapplied_payments).
4906 Times are specified as SQL fragments or numeric
4907 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4908 L<Date::Parse> for conversion functions. The empty string can be passed
4909 to disable that time constraint completely.
4911 Available options are:
4915 =item unapplied_date
4917 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)
4922 set to true to remove all customer comparison clauses, for totals
4927 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4932 JOIN clause (typically used with the total option)
4936 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4937 time will be ignored. Note that START_TIME and END_TIME only limit the date
4938 range for invoices and I<unapplied> payments, credits, and refunds.
4944 sub balance_date_sql {
4945 my( $class, $start, $end, %opt ) = @_;
4947 my $cutoff = $opt{'cutoff'};
4949 my $owed = FS::cust_bill->owed_sql($cutoff);
4950 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4951 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4952 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4954 my $j = $opt{'join'} || '';
4956 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4957 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4958 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4959 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4961 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4962 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4963 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4964 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4969 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4971 Returns an SQL fragment to retreive the total unapplied payments for this
4972 customer, only considering payments with date earlier than START_TIME, and
4973 optionally not later than END_TIME.
4975 Times are specified as SQL fragments or numeric
4976 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4977 L<Date::Parse> for conversion functions. The empty string can be passed
4978 to disable that time constraint completely.
4980 Available options are:
4984 sub unapplied_payments_date_sql {
4985 my( $class, $start, $end, %opt ) = @_;
4987 my $cutoff = $opt{'cutoff'};
4989 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4991 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4992 'unapplied_date'=>1 );
4994 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4997 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4999 Helper method for balance_date_sql; name (and usage) subject to change
5000 (suggestions welcome).
5002 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5003 cust_refund, cust_credit or cust_pay).
5005 If TABLE is "cust_bill" or the unapplied_date option is true, only
5006 considers records with date earlier than START_TIME, and optionally not
5007 later than END_TIME .
5011 sub _money_table_where {
5012 my( $class, $table, $start, $end, %opt ) = @_;
5015 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5016 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5017 push @where, "$table._date <= $start" if defined($start) && length($start);
5018 push @where, "$table._date > $end" if defined($end) && length($end);
5020 push @where, @{$opt{'where'}} if $opt{'where'};
5021 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5027 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5028 use FS::cust_main::Search;
5031 FS::cust_main::Search->search(@_);
5040 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5042 Generates a templated notification to the customer (see L<Text::Template>).
5044 OPTIONS is a hash and may include
5046 I<extra_fields> - a hashref of name/value pairs which will be substituted
5047 into the template. These values may override values mentioned below
5048 and those from the customer record.
5050 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5052 The following variables are available in the template instead of or in addition
5053 to the fields of the customer record.
5055 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5059 # a lot like cust_bill::print_latex
5060 sub generate_letter {
5061 my ($self, $template, %options) = @_;
5063 warn "Template $template does not exist" && return
5064 unless $conf->exists($template) || $options{'template_text'};
5066 my $template_source = $options{'template_text'}
5067 ? [ $options{'template_text'} ]
5068 : [ map "$_\n", $conf->config($template) ];
5070 my $letter_template = new Text::Template
5072 SOURCE => $template_source,
5073 DELIMITERS => [ '[@--', '--@]' ],
5075 or die "can't create new Text::Template object: Text::Template::ERROR";
5077 $letter_template->compile()
5078 or die "can't compile template: Text::Template::ERROR";
5080 my %letter_data = map { $_ => $self->$_ } $self->fields;
5082 for (keys %{$options{extra_fields}}){
5083 $letter_data{$_} = $options{extra_fields}->{$_};
5086 unless(exists($letter_data{returnaddress})){
5087 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5088 $self->agent_template)
5090 if ( length($retadd) ) {
5091 $letter_data{returnaddress} = $retadd;
5092 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5093 $letter_data{returnaddress} =
5094 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5098 ( $conf->config('company_name', $self->agentnum),
5099 $conf->config('company_address', $self->agentnum),
5103 $letter_data{returnaddress} = '~';
5107 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5109 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5111 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5113 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5117 ) or die "can't open temp file: $!\n";
5118 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5119 or die "can't write temp file: $!\n";
5121 $letter_data{'logo_file'} = $lh->filename;
5123 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5127 ) or die "can't open temp file: $!\n";
5129 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5131 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5132 return ($1, $letter_data{'logo_file'});
5136 =item print_ps TEMPLATE
5138 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5144 my($file, $lfile) = $self->generate_letter(@_);
5145 my $ps = FS::Misc::generate_ps($file);
5146 unlink($file.'.tex');
5152 =item print TEMPLATE
5154 Prints the filled in template.
5156 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5160 sub queueable_print {
5163 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5164 or die "invalid customer number: " . $opt{custnum};
5166 #do not backport this change to 3.x
5167 # my $error = $self->print( { 'template' => $opt{template} } );
5168 my $error = $self->print( $opt{'template'} );
5169 die $error if $error;
5173 my ($self, $template) = (shift, shift);
5175 [ $self->print_ps($template) ],
5176 'agentnum' => $self->agentnum,
5180 #these three subs should just go away once agent stuff is all config overrides
5182 sub agent_template {
5184 $self->_agent_plandata('agent_templatename');
5187 sub agent_invoice_from {
5189 $self->_agent_plandata('agent_invoice_from');
5192 sub _agent_plandata {
5193 my( $self, $option ) = @_;
5195 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5196 #agent-specific Conf
5198 use FS::part_event::Condition;
5200 my $agentnum = $self->agentnum;
5202 my $regexp = regexp_sql();
5204 my $part_event_option =
5206 'select' => 'part_event_option.*',
5207 'table' => 'part_event_option',
5209 LEFT JOIN part_event USING ( eventpart )
5210 LEFT JOIN part_event_option AS peo_agentnum
5211 ON ( part_event.eventpart = peo_agentnum.eventpart
5212 AND peo_agentnum.optionname = 'agentnum'
5213 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5215 LEFT JOIN part_event_condition
5216 ON ( part_event.eventpart = part_event_condition.eventpart
5217 AND part_event_condition.conditionname = 'cust_bill_age'
5219 LEFT JOIN part_event_condition_option
5220 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5221 AND part_event_condition_option.optionname = 'age'
5224 #'hashref' => { 'optionname' => $option },
5225 #'hashref' => { 'part_event_option.optionname' => $option },
5227 " WHERE part_event_option.optionname = ". dbh->quote($option).
5228 " AND action = 'cust_bill_send_agent' ".
5229 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5230 " AND peo_agentnum.optionname = 'agentnum' ".
5231 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5233 CASE WHEN part_event_condition_option.optionname IS NULL
5235 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5237 , part_event.weight".
5241 unless ( $part_event_option ) {
5242 return $self->agent->invoice_template || ''
5243 if $option eq 'agent_templatename';
5247 $part_event_option->optionvalue;
5251 sub process_o2m_qsearch {
5254 return qsearch($table, @_) unless $table eq 'contact';
5256 my $hashref = shift;
5257 my %hash = %$hashref;
5258 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5259 or die 'guru meditation #4343';
5261 qsearch({ 'table' => 'contact',
5262 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5263 'hashref' => \%hash,
5264 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5265 " cust_contact.custnum = $custnum "
5269 sub process_o2m_qsearchs {
5272 return qsearchs($table, @_) unless $table eq 'contact';
5274 my $hashref = shift;
5275 my %hash = %$hashref;
5276 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5277 or die 'guru meditation #2121';
5279 qsearchs({ 'table' => 'contact',
5280 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5281 'hashref' => \%hash,
5282 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5283 " cust_contact.custnum = $custnum "
5287 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5289 Subroutine (not a method), designed to be called from the queue.
5291 Takes a list of options and values.
5293 Pulls up the customer record via the custnum option and calls bill_and_collect.
5298 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5300 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5301 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5303 #without this errors don't get rolled back
5304 $args{'fatal'} = 1; # runs from job queue, will be caught
5306 $cust_main->bill_and_collect( %args );
5309 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5311 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5312 C<collect> part. This is used in batch tax calculation, where invoice
5313 generation and collection events have to be completely separated.
5317 sub queued_collect {
5319 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5321 $cust_main->collect(%args);
5324 sub process_bill_and_collect {
5327 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5328 or die "custnum '$param->{custnum}' not found!\n";
5329 $param->{'job'} = $job;
5330 $param->{'fatal'} = 1; # runs from job queue, will be caught
5331 $param->{'retry'} = 1;
5333 $cust_main->bill_and_collect( %$param );
5336 #starting to take quite a while for big dbs
5337 # (JRNL: journaled so it only happens once per database)
5338 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5339 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5340 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5341 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5342 # JRNL leading/trailing spaces in first, last, company
5343 # JRNL migrate to cust_payby
5344 # - otaker upgrade? journal and call it good? (double check to make sure
5345 # we're not still setting otaker here)
5347 #only going to get worse with new location stuff...
5349 sub _upgrade_data { #class method
5350 my ($class, %opts) = @_;
5352 my @statements = ();
5354 #this seems to be the only expensive one.. why does it take so long?
5355 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5357 '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';
5358 FS::upgrade_journal->set_done('cust_main__signupdate');
5362 foreach my $sql ( @statements ) {
5363 my $sth = dbh->prepare($sql) or die dbh->errstr;
5364 $sth->execute or die $sth->errstr;
5365 #warn ( (time - $t). " seconds\n" );
5369 local($ignore_expired_card) = 1;
5370 local($ignore_banned_card) = 1;
5371 local($skip_fuzzyfiles) = 1;
5372 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5374 FS::cust_main::Location->_upgrade_data(%opts);
5376 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5378 foreach my $cust_main ( qsearch({
5379 'table' => 'cust_main',
5381 'extra_sql' => 'WHERE '.
5383 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5384 qw( first last company )
5387 my $error = $cust_main->replace;
5388 die $error if $error;
5391 FS::upgrade_journal->set_done('cust_main__trimspaces');
5395 $class->_upgrade_otaker(%opts);
5397 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5398 # existing records will be encrypted in queueable_upgrade (below)
5399 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5400 eval "use FS::Setup";
5402 FS::Setup::enable_encryption();
5407 sub queueable_upgrade {
5410 ### encryption gets turned on in _upgrade_data, above
5412 eval "use FS::upgrade_journal";
5415 # prior to 2013 (commit f16665c9) payinfo was stored in history if not
5416 # encrypted, clear that out before encrypting/tokenizing anything else
5417 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5418 foreach my $table (qw(
5419 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5422 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5423 my $sth = dbh->prepare($sql) or die dbh->errstr;
5424 $sth->execute or die $sth->errstr;
5426 FS::upgrade_journal->set_done('clear_payinfo_history');
5429 # fix Tokenized paycardtype and encrypt old records
5430 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5431 || ! FS::upgrade_journal->is_done('encryption_check')
5435 # allow replacement of closed cust_pay/cust_refund records
5436 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5438 # because it looks like nothing's changing
5439 local $FS::Record::no_update_diff = 1;
5441 # commit everything immediately
5442 local $FS::UID::AutoCommit = 1;
5444 # encrypt what's there
5445 foreach my $table (qw(
5446 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5448 my $tclass = 'FS::'.$table;
5452 my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)
5454 my $record = $tclass->by_key($recnum);
5455 next unless $record; # small chance it's been deleted, that's ok
5456 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5457 # window for possible conflict is practically nonexistant,
5458 # but just in case...
5459 $record = $record->select_for_update;
5460 if (!$record->custnum && $table eq 'cust_pay_pending') {
5461 $record->set('custnum_pending',1);
5463 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5465 local($ignore_expired_card) = 1;
5466 local($ignore_banned_card) = 1;
5467 local($skip_fuzzyfiles) = 1;
5468 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5470 my $error = $record->replace;
5471 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5475 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5476 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5479 # now that everything's encrypted, tokenize...
5480 FS::cust_main::Billing_Realtime::token_check(@_);
5483 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5484 # cust_payby might get deleted while this runs
5486 sub _upgrade_next_recnum {
5487 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5488 my $recnum = shift @$recnums;
5489 return $recnum if $recnum;
5490 my $tclass = 'FS::'.$table;
5491 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5492 my $sql = 'SELECT '.$tclass->primary_key.
5494 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5495 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5496 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5497 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5498 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5499 $sth->execute() or die $sth->errstr;
5501 while (my $rec = $sth->fetchrow_hashref) {
5502 push @$recnums, $rec->{$tclass->primary_key};
5505 $$lastrecnum = $$recnums[-1];
5506 return shift @$recnums;
5515 The delete method should possibly take an FS::cust_main object reference
5516 instead of a scalar customer number.
5518 Bill and collect options should probably be passed as references instead of a
5521 There should probably be a configuration file with a list of allowed credit
5524 No multiple currency support (probably a larger project than just this module).
5526 Birthdates rely on negative epoch values.
5528 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5532 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5533 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5534 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.