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;
82 use FS::Misc::Savepoint;
85 # 1 is mostly method/subroutine entry and options
86 # 2 traces progress of some operations
87 # 3 is even more information including possibly sensitive data
89 our $me = '[FS::cust_main]';
92 our $ignore_expired_card = 0;
93 our $ignore_banned_card = 0;
94 our $ignore_invalid_card = 0;
96 our $skip_fuzzyfiles = 0;
98 our $ucfirst_nowarn = 0;
100 #this info is in cust_payby as of 4.x
101 #this and the fields themselves can be removed in 5.x
102 our @encrypted_fields = ('payinfo', 'paycvv');
103 sub nohistory_fields { ('payinfo', 'paycvv'); }
106 our $default_agent_custid;
107 our $custnum_display_length;
108 #ask FS::UID to run this stuff for us later
109 #$FS::UID::callback{'FS::cust_main'} = sub {
110 install_callback FS::UID sub {
111 $conf = new FS::Conf;
112 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
113 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
114 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
119 my ( $hashref, $cache ) = @_;
120 if ( exists $hashref->{'pkgnum'} ) {
121 #@{ $self->{'_pkgnum'} } = ();
122 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
123 $self->{'_pkgnum'} = $subcache;
124 #push @{ $self->{'_pkgnum'} },
125 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
131 FS::cust_main - Object methods for cust_main records
137 $record = new FS::cust_main \%hash;
138 $record = new FS::cust_main { 'column' => 'value' };
140 $error = $record->insert;
142 $error = $new_record->replace($old_record);
144 $error = $record->delete;
146 $error = $record->check;
148 @cust_pkg = $record->all_pkgs;
150 @cust_pkg = $record->ncancelled_pkgs;
152 @cust_pkg = $record->suspended_pkgs;
154 $error = $record->bill;
155 $error = $record->bill %options;
156 $error = $record->bill 'time' => $time;
158 $error = $record->collect;
159 $error = $record->collect %options;
160 $error = $record->collect 'invoice_time' => $time,
165 An FS::cust_main object represents a customer. FS::cust_main inherits from
166 FS::Record. The following fields are currently supported:
172 Primary key (assigned automatically for new customers)
176 Agent (see L<FS::agent>)
180 Advertising source (see L<FS::part_referral>)
192 Cocial security number (optional)
216 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
220 Payment Information (See L<FS::payinfo_Mixin> for data format)
224 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
228 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
232 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
236 Start date month (maestro/solo cards only)
240 Start date year (maestro/solo cards only)
244 Issue number (maestro/solo cards only)
248 Name on card or billing name
252 IP address from which payment information was received
256 Tax exempt, empty or `Y'
260 Order taker (see L<FS::access_user>)
266 =item referral_custnum
268 Referring customer number
272 Enable individual CDR spooling, empty or `Y'
276 A suggestion to events (see L<FS::part_bill_event>) to delay until this unix timestamp
280 Discourage individual CDR printing, empty or `Y'
284 Allow self-service editing of ticket subjects, empty or 'Y'
286 =item calling_list_exempt
288 Do not call, empty or 'Y'
290 =item invoice_ship_address
292 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
302 Creates a new customer. To add the customer to the database, see L<"insert">.
304 Note that this stores the hash reference, not a distinct copy of the hash it
305 points to. You can ask the object for a copy with the I<hash> method.
309 sub table { 'cust_main'; }
311 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
313 Adds this customer to the database. If there is an error, returns the error,
314 otherwise returns false.
316 Usually the customer's location will not yet exist in the database, and
317 the C<bill_location> and C<ship_location> pseudo-fields must be set to
318 uninserted L<FS::cust_location> objects. These will be inserted and linked
319 (in both directions) to the new customer record. If they're references
320 to the same object, they will become the same location.
322 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
323 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
324 are inserted atomicly, or the transaction is rolled back. Passing an empty
325 hash reference is equivalent to not supplying this parameter. There should be
326 a better explanation of this, but until then, here's an example:
329 tie %hash, 'Tie::RefHash'; #this part is important
331 $cust_pkg => [ $svc_acct ],
334 $cust_main->insert( \%hash );
336 INVOICING_LIST_ARYREF: No longer supported.
338 Currently available options are: I<depend_jobnum>, I<noexport>,
339 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
341 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
342 on the supplied jobnum (they will not run until the specific job completes).
343 This can be used to defer provisioning until some action completes (such
344 as running the customer's credit card successfully).
346 The I<noexport> option is deprecated. If I<noexport> is set true, no
347 provisioning jobs (exports) are scheduled. (You can schedule them later with
348 the B<reexport> method.)
350 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
351 of tax names and exemption numbers. FS::cust_main_exemption records will be
352 created and inserted.
354 If I<prospectnum> is set, moves contacts and locations from that prospect.
356 If I<contact> is set to an arrayref of FS::contact objects, those will be
359 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
360 unset), inserts those new contacts with this new customer. Handles CGI
361 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
363 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
364 new stored payment records with this new customer. Handles CGI parameters
365 for an "m2" multiple entry field as passed by edit/cust_main.cgi
371 my $cust_pkgs = @_ ? shift : {};
373 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
374 warn "cust_main::insert using deprecated invoicing list argument";
375 $invoicing_list = shift;
378 warn "$me insert called with options ".
379 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
382 return "You are not permitted to change customer invoicing terms."
383 if $self->invoice_terms #i.e. not the default
384 && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
386 local $SIG{HUP} = 'IGNORE';
387 local $SIG{INT} = 'IGNORE';
388 local $SIG{QUIT} = 'IGNORE';
389 local $SIG{TERM} = 'IGNORE';
390 local $SIG{TSTP} = 'IGNORE';
391 local $SIG{PIPE} = 'IGNORE';
393 my $oldAutoCommit = $FS::UID::AutoCommit;
394 local $FS::UID::AutoCommit = 0;
397 my $prepay_identifier = '';
398 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
400 if ( $self->payby eq 'PREPAY' ) {
402 $self->payby(''); #'BILL');
403 $prepay_identifier = $self->payinfo;
406 warn " looking up prepaid card $prepay_identifier\n"
409 my $error = $self->get_prepay( $prepay_identifier,
410 'amount_ref' => \$amount,
411 'seconds_ref' => \$seconds,
412 'upbytes_ref' => \$upbytes,
413 'downbytes_ref' => \$downbytes,
414 'totalbytes_ref' => \$totalbytes,
417 $dbh->rollback if $oldAutoCommit;
418 #return "error applying prepaid card (transaction rolled back): $error";
422 $payby = 'PREP' if $amount;
424 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
427 $self->payby(''); #'BILL');
428 $amount = $self->paid;
433 foreach my $l (qw(bill_location ship_location)) {
435 my $loc = delete $self->hashref->{$l} or next;
437 if ( !$loc->locationnum ) {
438 # warn the location that we're going to insert it with no custnum
439 $loc->set(custnum_pending => 1);
440 warn " inserting $l\n"
442 my $error = $loc->insert;
444 $dbh->rollback if $oldAutoCommit;
445 my $label = $l eq 'ship_location' ? 'service' : 'billing';
446 return "$error (in $label location)";
449 } elsif ( $loc->prospectnum ) {
451 $loc->prospectnum('');
452 $loc->set(custnum_pending => 1);
453 my $error = $loc->replace;
455 $dbh->rollback if $oldAutoCommit;
456 my $label = $l eq 'ship_location' ? 'service' : 'billing';
457 return "$error (moving $label location)";
460 } elsif ( ($loc->custnum || 0) > 0 ) {
461 # then it somehow belongs to another customer--shouldn't happen
462 $dbh->rollback if $oldAutoCommit;
463 return "$l belongs to customer ".$loc->custnum;
465 # else it already belongs to this customer
466 # (happens when ship_location is identical to bill_location)
468 $self->set($l.'num', $loc->locationnum);
470 if ( $self->get($l.'num') eq '' ) {
471 $dbh->rollback if $oldAutoCommit;
476 warn " inserting $self\n"
479 $self->signupdate(time) unless $self->signupdate;
481 $self->auto_agent_custid()
482 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
484 my $error = $self->check_payinfo_cardtype
485 || $self->SUPER::insert;
487 $dbh->rollback if $oldAutoCommit;
488 #return "inserting cust_main record (transaction rolled back): $error";
492 # now set cust_location.custnum
493 foreach my $l (qw(bill_location ship_location)) {
494 warn " setting $l.custnum\n"
496 my $loc = $self->$l or next;
497 unless ( $loc->custnum ) {
498 $loc->set(custnum => $self->custnum);
499 $error ||= $loc->replace;
503 $dbh->rollback if $oldAutoCommit;
504 return "error setting $l custnum: $error";
508 warn " setting customer tags\n"
511 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
512 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
513 'custnum' => $self->custnum };
514 my $error = $cust_tag->insert;
516 $dbh->rollback if $oldAutoCommit;
521 my $prospectnum = delete $options{'prospectnum'};
522 if ( $prospectnum ) {
524 warn " moving contacts and locations from prospect $prospectnum\n"
528 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
529 unless ( $prospect_main ) {
530 $dbh->rollback if $oldAutoCommit;
531 return "Unknown prospectnum $prospectnum";
533 $prospect_main->custnum($self->custnum);
534 $prospect_main->disabled('Y');
535 my $error = $prospect_main->replace;
537 $dbh->rollback if $oldAutoCommit;
541 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
542 my $cust_contact = new FS::cust_contact {
543 'custnum' => $self->custnum,
544 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
545 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
547 my $error = $cust_contact->insert
548 || $prospect_contact->delete;
550 $dbh->rollback if $oldAutoCommit;
555 my @cust_location = $prospect_main->cust_location;
556 my @qual = $prospect_main->qual;
558 foreach my $r ( @cust_location, @qual ) {
560 $r->custnum($self->custnum);
561 my $error = $r->replace;
563 $dbh->rollback if $oldAutoCommit;
567 # since we set invoice_dest on all migrated prospect contacts (for now),
568 # don't process invoicing_list.
569 delete $options{'invoicing_list'};
570 $invoicing_list = undef;
573 warn " setting contacts\n"
576 $invoicing_list ||= $options{'invoicing_list'};
577 if ( $invoicing_list ) {
579 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
582 foreach my $dest (@$invoicing_list ) {
583 if ($dest eq 'POST') {
584 $self->set('postal_invoice', 'Y');
587 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
588 if ( $contact_email ) {
589 my $cust_contact = FS::cust_contact->new({
590 contactnum => $contact_email->contactnum,
591 custnum => $self->custnum,
593 $cust_contact->set('invoice_dest', 'Y');
594 my $error = $cust_contact->insert;
596 $dbh->rollback if $oldAutoCommit;
597 return "$error (linking to email address $dest)";
601 # this email address is not yet linked to any contact
602 $email .= ',' if length($email);
610 my $contact = FS::contact->new({
611 'custnum' => $self->get('custnum'),
612 'last' => $self->get('last'),
613 'first' => $self->get('first'),
614 'emailaddress' => $email,
615 'invoice_dest' => 'Y', # yes, you can set this via the contact
617 my $error = $contact->insert;
619 $dbh->rollback if $oldAutoCommit;
627 if ( my $contact = delete $options{'contact'} ) {
629 foreach my $c ( @$contact ) {
630 $c->custnum($self->custnum);
631 my $error = $c->insert;
633 $dbh->rollback if $oldAutoCommit;
639 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
641 my $error = $self->process_o2m( 'table' => 'contact',
642 'fields' => FS::contact->cgi_contact_fields,
643 'params' => $contact_params,
646 $dbh->rollback if $oldAutoCommit;
651 warn " setting cust_payby\n"
654 if ( $options{cust_payby} ) {
656 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
657 $cust_payby->custnum($self->custnum);
658 my $error = $cust_payby->insert;
660 $dbh->rollback if $oldAutoCommit;
665 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
667 my $error = $self->process_o2m(
668 'table' => 'cust_payby',
669 'fields' => FS::cust_payby->cgi_cust_payby_fields,
670 'params' => $cust_payby_params,
671 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
674 $dbh->rollback if $oldAutoCommit;
680 warn " setting cust_main_exemption\n"
683 my $tax_exemption = delete $options{'tax_exemption'};
684 if ( $tax_exemption ) {
686 $tax_exemption = { map { $_ => '' } @$tax_exemption }
687 if ref($tax_exemption) eq 'ARRAY';
689 foreach my $taxname ( keys %$tax_exemption ) {
690 my $cust_main_exemption = new FS::cust_main_exemption {
691 'custnum' => $self->custnum,
692 'taxname' => $taxname,
693 'exempt_number' => $tax_exemption->{$taxname},
695 my $error = $cust_main_exemption->insert;
697 $dbh->rollback if $oldAutoCommit;
698 return "inserting cust_main_exemption (transaction rolled back): $error";
703 warn " ordering packages\n"
706 $error = $self->order_pkgs( $cust_pkgs,
708 'seconds_ref' => \$seconds,
709 'upbytes_ref' => \$upbytes,
710 'downbytes_ref' => \$downbytes,
711 'totalbytes_ref' => \$totalbytes,
714 $dbh->rollback if $oldAutoCommit;
719 $dbh->rollback if $oldAutoCommit;
720 return "No svc_acct record to apply pre-paid time";
722 if ( $upbytes || $downbytes || $totalbytes ) {
723 $dbh->rollback if $oldAutoCommit;
724 return "No svc_acct record to apply pre-paid data";
728 warn " inserting initial $payby payment of $amount\n"
730 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
732 $dbh->rollback if $oldAutoCommit;
733 return "inserting payment (transaction rolled back): $error";
737 unless ( $import || $skip_fuzzyfiles ) {
738 warn " queueing fuzzyfiles update\n"
740 $error = $self->queue_fuzzyfiles_update;
742 $dbh->rollback if $oldAutoCommit;
743 return "updating fuzzy search cache: $error";
748 warn " exporting\n" if $DEBUG > 1;
750 my $export_args = $options{'export_args'} || [];
753 map qsearch( 'part_export', {exportnum=>$_} ),
754 $conf->config('cust_main-exports'); #, $agentnum
756 foreach my $part_export ( @part_export ) {
757 my $error = $part_export->export_insert($self, @$export_args);
759 $dbh->rollback if $oldAutoCommit;
760 return "exporting to ". $part_export->exporttype.
761 " (transaction rolled back): $error";
765 #foreach my $depend_jobnum ( @$depend_jobnums ) {
766 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
768 # foreach my $jobnum ( @jobnums ) {
769 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
770 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
772 # my $error = $queue->depend_insert($depend_jobnum);
774 # $dbh->rollback if $oldAutoCommit;
775 # return "error queuing job dependancy: $error";
782 #if ( exists $options{'jobnums'} ) {
783 # push @{ $options{'jobnums'} }, @jobnums;
786 warn " insert complete; committing transaction\n"
789 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
794 use File::CounterFile;
795 sub auto_agent_custid {
798 my $format = $conf->config('cust_main-auto_agent_custid');
800 if ( $format eq '1YMMXXXXXXXX' ) {
802 my $counter = new File::CounterFile 'cust_main.agent_custid';
805 my $ym = 100000000000 + time2str('%y%m00000000', time);
806 if ( $ym > $counter->value ) {
807 $counter->{'value'} = $agent_custid = $ym;
808 $counter->{'updated'} = 1;
810 $agent_custid = $counter->inc;
816 die "Unknown cust_main-auto_agent_custid format: $format";
819 $self->agent_custid($agent_custid);
823 =item PACKAGE METHODS
825 Documentation on customer package methods has been moved to
826 L<FS::cust_main::Packages>.
828 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
830 Recharges this (existing) customer with the specified prepaid card (see
831 L<FS::prepay_credit>), specified either by I<identifier> or as an
832 FS::prepay_credit object. If there is an error, returns the error, otherwise
835 Optionally, five scalar references can be passed as well. They will have their
836 values filled in with the amount, number of seconds, and number of upload,
837 download, and total bytes applied by this prepaid card.
841 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
842 #the only place that uses these args
843 sub recharge_prepay {
844 my( $self, $prepay_credit, $amountref, $secondsref,
845 $upbytesref, $downbytesref, $totalbytesref ) = @_;
847 local $SIG{HUP} = 'IGNORE';
848 local $SIG{INT} = 'IGNORE';
849 local $SIG{QUIT} = 'IGNORE';
850 local $SIG{TERM} = 'IGNORE';
851 local $SIG{TSTP} = 'IGNORE';
852 local $SIG{PIPE} = 'IGNORE';
854 my $oldAutoCommit = $FS::UID::AutoCommit;
855 local $FS::UID::AutoCommit = 0;
858 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
860 my $error = $self->get_prepay( $prepay_credit,
861 'amount_ref' => \$amount,
862 'seconds_ref' => \$seconds,
863 'upbytes_ref' => \$upbytes,
864 'downbytes_ref' => \$downbytes,
865 'totalbytes_ref' => \$totalbytes,
867 || $self->increment_seconds($seconds)
868 || $self->increment_upbytes($upbytes)
869 || $self->increment_downbytes($downbytes)
870 || $self->increment_totalbytes($totalbytes)
871 || $self->insert_cust_pay_prepay( $amount,
873 ? $prepay_credit->identifier
878 $dbh->rollback if $oldAutoCommit;
882 if ( defined($amountref) ) { $$amountref = $amount; }
883 if ( defined($secondsref) ) { $$secondsref = $seconds; }
884 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
885 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
886 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
888 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
893 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
895 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
896 specified either by I<identifier> or as an FS::prepay_credit object.
898 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
899 incremented by the values of the prepaid card.
901 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
902 check or set this customer's I<agentnum>.
904 If there is an error, returns the error, otherwise returns false.
910 my( $self, $prepay_credit, %opt ) = @_;
912 local $SIG{HUP} = 'IGNORE';
913 local $SIG{INT} = 'IGNORE';
914 local $SIG{QUIT} = 'IGNORE';
915 local $SIG{TERM} = 'IGNORE';
916 local $SIG{TSTP} = 'IGNORE';
917 local $SIG{PIPE} = 'IGNORE';
919 my $oldAutoCommit = $FS::UID::AutoCommit;
920 local $FS::UID::AutoCommit = 0;
923 unless ( ref($prepay_credit) ) {
925 my $identifier = $prepay_credit;
927 $prepay_credit = qsearchs(
929 { 'identifier' => $identifier },
934 unless ( $prepay_credit ) {
935 $dbh->rollback if $oldAutoCommit;
936 return "Invalid prepaid card: ". $identifier;
941 if ( $prepay_credit->agentnum ) {
942 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
943 $dbh->rollback if $oldAutoCommit;
944 return "prepaid card not valid for agent ". $self->agentnum;
946 $self->agentnum($prepay_credit->agentnum);
949 my $error = $prepay_credit->delete;
951 $dbh->rollback if $oldAutoCommit;
952 return "removing prepay_credit (transaction rolled back): $error";
955 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
956 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
958 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
963 =item increment_upbytes SECONDS
965 Updates this customer's single or primary account (see L<FS::svc_acct>) by
966 the specified number of upbytes. If there is an error, returns the error,
967 otherwise returns false.
971 sub increment_upbytes {
972 _increment_column( shift, 'upbytes', @_);
975 =item increment_downbytes SECONDS
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of downbytes. If there is an error, returns the error,
979 otherwise returns false.
983 sub increment_downbytes {
984 _increment_column( shift, 'downbytes', @_);
987 =item increment_totalbytes SECONDS
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of totalbytes. If there is an error, returns the error,
991 otherwise returns false.
995 sub increment_totalbytes {
996 _increment_column( shift, 'totalbytes', @_);
999 =item increment_seconds SECONDS
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of seconds. If there is an error, returns the error,
1003 otherwise returns false.
1007 sub increment_seconds {
1008 _increment_column( shift, 'seconds', @_);
1011 =item _increment_column AMOUNT
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds or bytes. If there is an error, returns
1015 the error, otherwise returns false.
1019 sub _increment_column {
1020 my( $self, $column, $amount ) = @_;
1021 warn "$me increment_column called: $column, $amount\n"
1024 return '' unless $amount;
1026 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1027 $self->ncancelled_pkgs;
1029 if ( ! @cust_pkg ) {
1030 return 'No packages with primary or single services found'.
1031 ' to apply pre-paid time';
1032 } elsif ( scalar(@cust_pkg) > 1 ) {
1033 #maybe have a way to specify the package/account?
1034 return 'Multiple packages found to apply pre-paid time';
1037 my $cust_pkg = $cust_pkg[0];
1038 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1042 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1044 if ( ! @cust_svc ) {
1045 return 'No account found to apply pre-paid time';
1046 } elsif ( scalar(@cust_svc) > 1 ) {
1047 return 'Multiple accounts found to apply pre-paid time';
1050 my $svc_acct = $cust_svc[0]->svc_x;
1051 warn " found service svcnum ". $svc_acct->pkgnum.
1052 ' ('. $svc_acct->email. ")\n"
1055 $column = "increment_$column";
1056 $svc_acct->$column($amount);
1060 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1062 Inserts a prepayment in the specified amount for this customer. An optional
1063 second argument can specify the prepayment identifier for tracking purposes.
1064 If there is an error, returns the error, otherwise returns false.
1068 sub insert_cust_pay_prepay {
1069 shift->insert_cust_pay('PREP', @_);
1072 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1074 Inserts a cash payment in the specified amount for this customer. An optional
1075 second argument can specify the payment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1080 sub insert_cust_pay_cash {
1081 shift->insert_cust_pay('CASH', @_);
1084 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1086 Inserts a Western Union payment in the specified amount for this customer. An
1087 optional second argument can specify the prepayment identifier for tracking
1088 purposes. If there is an error, returns the error, otherwise returns false.
1092 sub insert_cust_pay_west {
1093 shift->insert_cust_pay('WEST', @_);
1096 sub insert_cust_pay {
1097 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1098 my $payinfo = scalar(@_) ? shift : '';
1100 my $cust_pay = new FS::cust_pay {
1101 'custnum' => $self->custnum,
1102 'paid' => sprintf('%.2f', $amount),
1103 #'_date' => #date the prepaid card was purchased???
1105 'payinfo' => $payinfo,
1111 =item delete [ OPTION => VALUE ... ]
1113 This deletes the customer. If there is an error, returns the error, otherwise
1116 This will completely remove all traces of the customer record. This is not
1117 what you want when a customer cancels service; for that, cancel all of the
1118 customer's packages (see L</cancel>).
1120 If the customer has any uncancelled packages, you need to pass a new (valid)
1121 customer number for those packages to be transferred to, as the "new_customer"
1122 option. Cancelled packages will be deleted. Did I mention that this is NOT
1123 what you want when a customer cancels service and that you really should be
1124 looking at L<FS::cust_pkg/cancel>?
1126 You can't delete a customer with invoices (see L<FS::cust_bill>),
1127 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1128 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1129 set the "delete_financials" option to a true value.
1134 my( $self, %opt ) = @_;
1136 local $SIG{HUP} = 'IGNORE';
1137 local $SIG{INT} = 'IGNORE';
1138 local $SIG{QUIT} = 'IGNORE';
1139 local $SIG{TERM} = 'IGNORE';
1140 local $SIG{TSTP} = 'IGNORE';
1141 local $SIG{PIPE} = 'IGNORE';
1143 my $oldAutoCommit = $FS::UID::AutoCommit;
1144 local $FS::UID::AutoCommit = 0;
1147 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1148 $dbh->rollback if $oldAutoCommit;
1149 return "Can't delete a master agent customer";
1152 #use FS::access_user
1153 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1154 $dbh->rollback if $oldAutoCommit;
1155 return "Can't delete a master employee customer";
1158 tie my %financial_tables, 'Tie::IxHash',
1159 'cust_bill' => 'invoices',
1160 'cust_statement' => 'statements',
1161 'cust_credit' => 'credits',
1162 'cust_pay' => 'payments',
1163 'cust_refund' => 'refunds',
1166 foreach my $table ( keys %financial_tables ) {
1168 my @records = $self->$table();
1170 if ( @records && ! $opt{'delete_financials'} ) {
1171 $dbh->rollback if $oldAutoCommit;
1172 return "Can't delete a customer with ". $financial_tables{$table};
1175 foreach my $record ( @records ) {
1176 my $error = $record->delete;
1178 $dbh->rollback if $oldAutoCommit;
1179 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1185 my @cust_pkg = $self->ncancelled_pkgs;
1187 my $new_custnum = $opt{'new_custnum'};
1188 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1189 $dbh->rollback if $oldAutoCommit;
1190 return "Invalid new customer number: $new_custnum";
1192 foreach my $cust_pkg ( @cust_pkg ) {
1193 my %hash = $cust_pkg->hash;
1194 $hash{'custnum'} = $new_custnum;
1195 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1196 my $error = $new_cust_pkg->replace($cust_pkg,
1197 options => { $cust_pkg->options },
1200 $dbh->rollback if $oldAutoCommit;
1205 my @cancelled_cust_pkg = $self->all_pkgs;
1206 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1207 my $error = $cust_pkg->delete;
1209 $dbh->rollback if $oldAutoCommit;
1214 #cust_tax_adjustment in financials?
1215 #cust_pay_pending? ouch
1216 foreach my $table (qw(
1217 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1218 cust_payby cust_location cust_main_note cust_tax_adjustment
1219 cust_pay_void cust_pay_batch queue cust_tax_exempt
1221 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1222 my $error = $record->delete;
1224 $dbh->rollback if $oldAutoCommit;
1230 my $sth = $dbh->prepare(
1231 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1233 my $errstr = $dbh->errstr;
1234 $dbh->rollback if $oldAutoCommit;
1237 $sth->execute($self->custnum) or do {
1238 my $errstr = $sth->errstr;
1239 $dbh->rollback if $oldAutoCommit;
1245 my $ticket_dbh = '';
1246 if ($conf->config('ticket_system') eq 'RT_Internal') {
1248 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1249 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1250 $ticket_dbh = FS::DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1251 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1254 if ( $ticket_dbh ) {
1256 my $ticket_sth = $ticket_dbh->prepare(
1257 'DELETE FROM Links WHERE Target = ?'
1259 my $errstr = $ticket_dbh->errstr;
1260 $dbh->rollback if $oldAutoCommit;
1263 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1265 my $errstr = $ticket_sth->errstr;
1266 $dbh->rollback if $oldAutoCommit;
1270 #check and see if the customer is the only link on the ticket, and
1271 #if so, set the ticket to deleted status in RT?
1272 #maybe someday, for now this will at least fix tickets not displaying
1276 #delete the customer record
1278 my $error = $self->SUPER::delete;
1280 $dbh->rollback if $oldAutoCommit;
1284 # cust_main exports!
1286 #my $export_args = $options{'export_args'} || [];
1289 map qsearch( 'part_export', {exportnum=>$_} ),
1290 $conf->config('cust_main-exports'); #, $agentnum
1292 foreach my $part_export ( @part_export ) {
1293 my $error = $part_export->export_delete( $self ); #, @$export_args);
1295 $dbh->rollback if $oldAutoCommit;
1296 return "exporting to ". $part_export->exporttype.
1297 " (transaction rolled back): $error";
1301 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1306 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1308 Replaces the OLD_RECORD with this one in the database. If there is an error,
1309 returns the error, otherwise returns false.
1311 To change the customer's address, set the pseudo-fields C<bill_location> and
1312 C<ship_location>. The address will still only change if at least one of the
1313 address fields differs from the existing values.
1315 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1316 set as the contact email address for a default contact with the same name as
1319 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1320 I<contact_params>, I<invoicing_list>, and I<move_pkgs>.
1322 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1323 of tax names and exemption numbers. FS::cust_main_exemption records will be
1324 deleted and inserted as appropriate.
1326 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1327 groups (describing the customer's payment methods and contacts, respectively)
1328 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1329 and L<FS::contact> for the fields these can contain.
1331 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1332 should be used instead if possible.
1334 If I<move_pkgs> is an arrayref, it will override the list of packages
1335 to be moved to the new address (see L<FS::cust_location/move_pkgs>.)
1342 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1344 : $self->replace_old;
1348 warn "$me replace called\n"
1351 my $curuser = $FS::CurrentUser::CurrentUser;
1352 return "You are not permitted to create complimentary accounts."
1353 if $self->complimentary eq 'Y'
1354 && $self->complimentary ne $old->complimentary
1355 && ! $curuser->access_right('Complimentary customer');
1357 local($ignore_expired_card) = 1
1358 if $old->payby =~ /^(CARD|DCRD)$/
1359 && $self->payby =~ /^(CARD|DCRD)$/
1360 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1362 local($ignore_banned_card) = 1
1363 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1364 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1365 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1367 if ( $self->payby =~ /^(CARD|DCRD)$/
1368 && $old->payinfo ne $self->payinfo
1369 && $old->paymask ne $self->paymask )
1371 my $error = $self->check_payinfo_cardtype;
1372 return $error if $error;
1375 return "Invoicing locale is required"
1378 && $conf->exists('cust_main-require_locale');
1380 return "You are not permitted to change customer invoicing terms."
1381 if $old->invoice_terms ne $self->invoice_terms
1382 && ! $curuser->access_right('Edit customer invoice terms');
1384 local $SIG{HUP} = 'IGNORE';
1385 local $SIG{INT} = 'IGNORE';
1386 local $SIG{QUIT} = 'IGNORE';
1387 local $SIG{TERM} = 'IGNORE';
1388 local $SIG{TSTP} = 'IGNORE';
1389 local $SIG{PIPE} = 'IGNORE';
1391 my $oldAutoCommit = $FS::UID::AutoCommit;
1392 local $FS::UID::AutoCommit = 0;
1395 for my $l (qw(bill_location ship_location)) {
1396 #my $old_loc = $old->$l;
1397 my $new_loc = $self->$l or next;
1399 # find the existing location if there is one
1400 $new_loc->set('custnum' => $self->custnum);
1401 my $error = $new_loc->find_or_insert;
1403 $dbh->rollback if $oldAutoCommit;
1406 $self->set($l.'num', $new_loc->locationnum);
1410 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1411 warn "cust_main::replace: using deprecated invoicing list argument";
1412 $invoicing_list = shift @param;
1415 my %options = @param;
1417 $invoicing_list ||= $options{invoicing_list};
1419 my @contacts = map { $_->contact } $self->cust_contact;
1420 # find a contact that matches the customer's name
1421 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1422 and $_->last eq $old->get('last') }
1424 $implicit_contact ||= FS::contact->new({
1425 'custnum' => $self->custnum,
1426 'locationnum' => $self->get('bill_locationnum'),
1429 # for any of these that are already contact emails, link to the existing
1431 if ( $invoicing_list ) {
1434 # kind of like process_m2m on these, except:
1435 # - the other side is two tables in a join
1436 # - and we might have to create new contact_emails
1437 # - and possibly a new contact
1439 # Find existing invoice emails that aren't on the implicit contact.
1440 # Any of these that are not on the new invoicing list will be removed.
1441 my %old_email_cust_contact;
1442 foreach my $cust_contact ($self->cust_contact) {
1443 next if !$cust_contact->invoice_dest;
1444 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1446 foreach my $contact_email ($cust_contact->contact->contact_email) {
1447 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1451 foreach my $dest (@$invoicing_list) {
1453 if ($dest eq 'POST') {
1455 $self->set('postal_invoice', 'Y');
1457 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1459 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1463 # See if it belongs to some other contact; if so, link it.
1464 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1466 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1467 my $cust_contact = qsearchs('cust_contact', {
1468 contactnum => $contact_email->contactnum,
1469 custnum => $self->custnum,
1470 }) || FS::cust_contact->new({
1471 contactnum => $contact_email->contactnum,
1472 custnum => $self->custnum,
1474 $cust_contact->set('invoice_dest', 'Y');
1475 my $error = $cust_contact->custcontactnum ?
1476 $cust_contact->replace : $cust_contact->insert;
1478 $dbh->rollback if $oldAutoCommit;
1479 return "$error (linking to email address $dest)";
1483 # This email address is not yet linked to any contact, so it will
1484 # be added to the implicit contact.
1485 $email .= ',' if length($email);
1491 foreach my $remove_dest (keys %old_email_cust_contact) {
1492 my $cust_contact = $old_email_cust_contact{$remove_dest};
1493 # These were not in the list of requested destinations, so take them off.
1494 $cust_contact->set('invoice_dest', '');
1495 my $error = $cust_contact->replace;
1497 $dbh->rollback if $oldAutoCommit;
1498 return "$error (unlinking email address $remove_dest)";
1502 # make sure it keeps up with the changed customer name, if any
1503 $implicit_contact->set('last', $self->get('last'));
1504 $implicit_contact->set('first', $self->get('first'));
1505 $implicit_contact->set('emailaddress', $email);
1506 $implicit_contact->set('invoice_dest', 'Y');
1507 $implicit_contact->set('custnum', $self->custnum);
1508 my $i_cust_contact =
1509 qsearchs('cust_contact', {
1510 contactnum => $implicit_contact->contactnum,
1511 custnum => $self->custnum,
1514 if ( $i_cust_contact ) {
1515 $implicit_contact->set($_, $i_cust_contact->$_)
1516 foreach qw( classnum selfservice_access comment );
1520 if ( $implicit_contact->contactnum ) {
1521 $error = $implicit_contact->replace;
1522 } elsif ( length($email) ) { # don't create a new contact if not needed
1523 $error = $implicit_contact->insert;
1527 $dbh->rollback if $oldAutoCommit;
1528 return "$error (adding email address $email)";
1533 # replace the customer record
1534 my $error = $self->SUPER::replace($old);
1537 $dbh->rollback if $oldAutoCommit;
1541 # now move packages to the new service location
1542 $self->set('ship_location', ''); #flush cache
1543 if ( $old->ship_locationnum and # should only be null during upgrade...
1544 $old->ship_locationnum != $self->ship_locationnum ) {
1545 $error = $old->ship_location->move_to($self->ship_location, move_pkgs => $options{'move_pkgs'});
1547 $dbh->rollback if $oldAutoCommit;
1551 # don't move packages based on the billing location, but
1552 # disable it if it's no longer in use
1553 if ( $old->bill_locationnum and
1554 $old->bill_locationnum != $self->bill_locationnum ) {
1555 $error = $old->bill_location->disable_if_unused;
1557 $dbh->rollback if $oldAutoCommit;
1562 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1564 #this could be more efficient than deleting and re-inserting, if it matters
1565 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1566 my $error = $cust_tag->delete;
1568 $dbh->rollback if $oldAutoCommit;
1572 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1573 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1574 'custnum' => $self->custnum };
1575 my $error = $cust_tag->insert;
1577 $dbh->rollback if $oldAutoCommit;
1584 my $tax_exemption = delete $options{'tax_exemption'};
1585 if ( $tax_exemption ) {
1587 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1588 if ref($tax_exemption) eq 'ARRAY';
1590 my %cust_main_exemption =
1591 map { $_->taxname => $_ }
1592 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1594 foreach my $taxname ( keys %$tax_exemption ) {
1596 if ( $cust_main_exemption{$taxname} &&
1597 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1600 delete $cust_main_exemption{$taxname};
1604 my $cust_main_exemption = new FS::cust_main_exemption {
1605 'custnum' => $self->custnum,
1606 'taxname' => $taxname,
1607 'exempt_number' => $tax_exemption->{$taxname},
1609 my $error = $cust_main_exemption->insert;
1611 $dbh->rollback if $oldAutoCommit;
1612 return "inserting cust_main_exemption (transaction rolled back): $error";
1616 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1617 my $error = $cust_main_exemption->delete;
1619 $dbh->rollback if $oldAutoCommit;
1620 return "deleting cust_main_exemption (transaction rolled back): $error";
1626 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1628 my $error = $self->process_o2m(
1629 'table' => 'cust_payby',
1630 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1631 'params' => $cust_payby_params,
1632 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1635 $dbh->rollback if $oldAutoCommit;
1641 if ( my $contact_params = delete $options{'contact_params'} ) {
1643 # this can potentially replace contacts that were created by the
1644 # invoicing list argument, but the UI shouldn't allow both of them
1647 my $error = $self->process_o2m(
1648 'table' => 'contact',
1649 'fields' => FS::contact->cgi_contact_fields,
1650 'params' => $contact_params,
1653 $dbh->rollback if $oldAutoCommit;
1659 unless ( $import || $skip_fuzzyfiles ) {
1660 $error = $self->queue_fuzzyfiles_update;
1662 $dbh->rollback if $oldAutoCommit;
1663 return "updating fuzzy search cache: $error";
1667 # tax district update in cust_location
1669 # cust_main exports!
1671 my $export_args = $options{'export_args'} || [];
1674 map qsearch( 'part_export', {exportnum=>$_} ),
1675 $conf->config('cust_main-exports'); #, $agentnum
1677 foreach my $part_export ( @part_export ) {
1678 my $error = $part_export->export_replace( $self, $old, @$export_args);
1680 $dbh->rollback if $oldAutoCommit;
1681 return "exporting to ". $part_export->exporttype.
1682 " (transaction rolled back): $error";
1686 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1691 =item queue_fuzzyfiles_update
1693 Used by insert & replace to update the fuzzy search cache
1697 use FS::cust_main::Search;
1698 sub queue_fuzzyfiles_update {
1701 local $SIG{HUP} = 'IGNORE';
1702 local $SIG{INT} = 'IGNORE';
1703 local $SIG{QUIT} = 'IGNORE';
1704 local $SIG{TERM} = 'IGNORE';
1705 local $SIG{TSTP} = 'IGNORE';
1706 local $SIG{PIPE} = 'IGNORE';
1708 my $oldAutoCommit = $FS::UID::AutoCommit;
1709 local $FS::UID::AutoCommit = 0;
1712 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1713 my $queue = new FS::queue {
1714 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1716 my @args = "cust_main.$field", $self->get($field);
1717 my $error = $queue->insert( @args );
1719 $dbh->rollback if $oldAutoCommit;
1720 return "queueing job (transaction rolled back): $error";
1725 push @locations, $self->bill_location if $self->bill_locationnum;
1726 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1727 foreach my $location (@locations) {
1728 my $queue = new FS::queue {
1729 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1731 my @args = 'cust_location.address1', $location->address1;
1732 my $error = $queue->insert( @args );
1734 $dbh->rollback if $oldAutoCommit;
1735 return "queueing job (transaction rolled back): $error";
1739 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1746 Checks all fields to make sure this is a valid customer record. If there is
1747 an error, returns the error, otherwise returns false. Called by the insert
1748 and replace methods.
1755 warn "$me check BEFORE: \n". $self->_dump
1759 $self->ut_numbern('custnum')
1760 || $self->ut_number('agentnum')
1761 || $self->ut_textn('agent_custid')
1762 || $self->ut_number('refnum')
1763 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1764 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1765 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1766 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1767 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1768 || $self->ut_textn('custbatch')
1769 || $self->ut_name('last')
1770 || $self->ut_name('first')
1771 || $self->ut_snumbern('signupdate')
1772 || $self->ut_snumbern('birthdate')
1773 || $self->ut_namen('spouse_last')
1774 || $self->ut_namen('spouse_first')
1775 || $self->ut_snumbern('spouse_birthdate')
1776 || $self->ut_snumbern('anniversary_date')
1777 || $self->ut_textn('company')
1778 || $self->ut_textn('ship_company')
1779 || $self->ut_anything('comments')
1780 || $self->ut_numbern('referral_custnum')
1781 || $self->ut_textn('stateid')
1782 || $self->ut_textn('stateid_state')
1783 || $self->ut_textn('invoice_terms')
1784 || $self->ut_floatn('cdr_termination_percentage')
1785 || $self->ut_floatn('credit_limit')
1786 || $self->ut_numbern('billday')
1787 || $self->ut_numbern('prorate_day')
1788 || $self->ut_flag('force_prorate_day')
1789 || $self->ut_flag('edit_subject')
1790 || $self->ut_flag('calling_list_exempt')
1791 || $self->ut_flag('invoice_noemail')
1792 || $self->ut_flag('message_noemail')
1793 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1794 || $self->ut_currencyn('currency')
1795 || $self->ut_textn('po_number')
1796 || $self->ut_enum('complimentary', [ '', 'Y' ])
1797 || $self->ut_flag('invoice_ship_address')
1798 || $self->ut_flag('invoice_dest')
1801 foreach (qw(company ship_company)) {
1802 my $company = $self->get($_);
1803 $company =~ s/^\s+//;
1804 $company =~ s/\s+$//;
1805 $company =~ s/\s+/ /g;
1806 $self->set($_, $company);
1809 #barf. need message catalogs. i18n. etc.
1810 $error .= "Please select an advertising source."
1811 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1812 return $error if $error;
1814 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1815 or return "Unknown agent";
1817 if ( $self->currency ) {
1818 my $agent_currency = qsearchs( 'agent_currency', {
1819 'agentnum' => $agent->agentnum,
1820 'currency' => $self->currency,
1822 or return "Agent ". $agent->agent.
1823 " not permitted to offer ". $self->currency. " invoicing";
1826 return "Unknown refnum"
1827 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1829 return "Unknown referring custnum: ". $self->referral_custnum
1830 unless ! $self->referral_custnum
1831 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1833 if ( $self->ss eq '' ) {
1838 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1839 or return "Illegal social security number: ". $self->ss;
1840 $self->ss("$1-$2-$3");
1843 #turn off invoice_ship_address if ship & bill are the same
1844 if ($self->bill_locationnum eq $self->ship_locationnum) {
1845 $self->invoice_ship_address('');
1848 # cust_main_county verification now handled by cust_location check
1851 $self->ut_phonen('daytime', $self->country)
1852 || $self->ut_phonen('night', $self->country)
1853 || $self->ut_phonen('fax', $self->country)
1854 || $self->ut_phonen('mobile', $self->country)
1856 return $error if $error;
1858 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1860 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1863 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1865 : FS::Msgcat::_gettext('daytime');
1866 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1868 : FS::Msgcat::_gettext('night');
1870 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1872 : FS::Msgcat::_gettext('mobile');
1874 return "$daytime_label, $night_label or $mobile_label is required"
1878 return "Please select an invoicing locale"
1881 && $conf->exists('cust_main-require_locale');
1883 return "Please select a customer class"
1884 if ! $self->classnum
1885 && $conf->exists('cust_main-require_classnum');
1887 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1888 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1892 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1894 warn "$me check AFTER: \n". $self->_dump
1897 $self->SUPER::check;
1900 sub check_payinfo_cardtype {
1903 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1905 my $payinfo = $self->payinfo;
1906 $payinfo =~ s/\D//g;
1908 return '' if $self->tokenized($payinfo); #token
1910 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1911 my $cardtype = cardtype($payinfo);
1913 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1921 Additional checks for replace only.
1926 my ($new,$old) = @_;
1927 #preserve old value if global config is set
1928 if ($old && $conf->exists('invoice-ship_address')) {
1929 $new->invoice_ship_address($old->invoice_ship_address);
1936 Returns a list of fields which have ship_ duplicates.
1941 qw( last first company
1943 address1 address2 city county state zip country
1945 daytime night fax mobile
1949 =item has_ship_address
1951 Returns true if this customer record has a separate shipping address.
1955 sub has_ship_address {
1957 $self->bill_locationnum != $self->ship_locationnum;
1962 Returns a list of key/value pairs, with the following keys: address1,
1963 adddress2, city, county, state, zip, country, district, and geocode. The
1964 shipping address is used if present.
1970 $self->ship_location->location_hash;
1975 Returns all locations (see L<FS::cust_location>) for this customer.
1982 'table' => 'cust_location',
1983 'hashref' => { 'custnum' => $self->custnum,
1984 'prospectnum' => '',
1986 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1992 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1998 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2001 =item cust_payby PAYBY
2003 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2005 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2006 Does not validate PAYBY.
2014 'table' => 'cust_payby',
2015 'hashref' => { 'custnum' => $self->custnum },
2016 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2018 $search->{'extra_sql'} = ' AND payby IN ( '.
2019 join(',', map dbh->quote($_), @payby).
2026 =item has_cust_payby_auto
2028 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2032 sub has_cust_payby_auto {
2035 'table' => 'cust_payby',
2036 'hashref' => { 'custnum' => $self->custnum, },
2037 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2038 'order_by' => 'LIMIT 1',
2045 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2046 and L<FS::cust_pkg>) for this customer, except those on hold.
2048 Returns a list: an empty list on success or a list of errors.
2054 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs(@_);
2059 Unsuspends all suspended packages in the on-hold state (those without setup
2060 dates) for this customer.
2066 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2071 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2073 Returns a list: an empty list on success or a list of errors.
2079 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2082 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2084 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2085 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2086 of a list of pkgparts; the hashref has the following keys:
2090 =item pkgparts - listref of pkgparts
2092 =item (other options are passed to the suspend method)
2097 Returns a list: an empty list on success or a list of errors.
2101 sub suspend_if_pkgpart {
2103 my (@pkgparts, %opt);
2104 if (ref($_[0]) eq 'HASH'){
2105 @pkgparts = @{$_[0]{pkgparts}};
2110 grep { $_->suspend(%opt) }
2111 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2112 $self->unsuspended_pkgs;
2115 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2117 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2118 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2119 instead of a list of pkgparts; the hashref has the following keys:
2123 =item pkgparts - listref of pkgparts
2125 =item (other options are passed to the suspend method)
2129 Returns a list: an empty list on success or a list of errors.
2133 sub suspend_unless_pkgpart {
2135 my (@pkgparts, %opt);
2136 if (ref($_[0]) eq 'HASH'){
2137 @pkgparts = @{$_[0]{pkgparts}};
2142 grep { $_->suspend(%opt) }
2143 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2144 $self->unsuspended_pkgs;
2147 =item cancel [ OPTION => VALUE ... ]
2149 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2150 The cancellation time will be now.
2154 Always returns a list: an empty list on success or a list of errors.
2161 warn "$me cancel called on customer ". $self->custnum. " with options ".
2162 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2164 my @pkgs = $self->ncancelled_pkgs;
2166 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2169 =item cancel_pkgs OPTIONS
2171 Cancels a specified list of packages. OPTIONS can include:
2175 =item cust_pkg - an arrayref of the packages. Required.
2177 =item time - the cancellation time, used to calculate final bills and
2178 unused-time credits if any. Will be passed through to the bill() and
2179 FS::cust_pkg::cancel() methods.
2181 =item quiet - can be set true to supress email cancellation notices.
2183 =item reason - can be set to a cancellation reason (see L<FS::reason>), either a
2184 reasonnum of an existing reason, or passing a hashref will create a new reason.
2185 The hashref should have the following keys:
2186 typenum - Reason type (see L<FS::reason_type>)
2187 reason - Text of the new reason.
2189 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2190 for the individual packages, parallel to the C<cust_pkg> argument. The
2191 reason and reason_otaker arguments will be taken from those objects.
2193 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2195 =item nobill - can be set true to skip billing if it might otherwise be done.
2200 my( $self, %opt ) = @_;
2202 # we're going to cancel services, which is not reversible
2203 # unless exports are suppressed
2204 die "cancel_pkgs cannot be run inside a transaction"
2205 if !$FS::UID::AutoCommit && !$FS::svc_Common::noexport_hack;
2207 my $oldAutoCommit = $FS::UID::AutoCommit;
2208 local $FS::UID::AutoCommit = 0;
2210 savepoint_create('cancel_pkgs');
2212 return ( 'access denied' )
2213 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2215 if ( $opt{'ban'} ) {
2217 foreach my $cust_payby ( $self->cust_payby ) {
2219 #well, if they didn't get decrypted on search, then we don't have to
2220 # try again... queue a job for the server that does have decryption
2221 # capability if we're in a paranoid multi-server implementation?
2222 return ( "Can't (yet) ban encrypted credit cards" )
2223 if $cust_payby->is_encrypted($cust_payby->payinfo);
2225 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2226 my $error = $ban->insert;
2228 savepoint_rollback_and_release('cancel_pkgs');
2229 dbh->rollback if $oldAutoCommit;
2237 my @pkgs = @{ delete $opt{'cust_pkg'} };
2238 my $cancel_time = $opt{'time'} || time;
2240 # bill all packages first, so we don't lose usage, service counts for
2241 # bulk billing, etc.
2242 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2244 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2246 'time' => $cancel_time );
2248 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2249 savepoint_rollback_and_release('cancel_pkgs');
2250 dbh->rollback if $oldAutoCommit;
2251 return ( "Error billing during cancellation: $error" );
2254 savepoint_release('cancel_pkgs');
2255 dbh->commit if $oldAutoCommit;
2258 # try to cancel each service, the same way we would for individual packages,
2259 # but in cancel weight order.
2260 my @cust_svc = map { $_->cust_svc } @pkgs;
2261 my @sorted_cust_svc =
2263 sort { $a->[1] <=> $b->[1] }
2264 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2266 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2270 foreach my $cust_svc (@sorted_cust_svc) {
2271 my $savepoint = 'cancel_pkgs_'.$i++;
2272 savepoint_create( $savepoint );
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 { $_ };
2279 savepoint_rollback_and_release( $savepoint );
2280 dbh->rollback if $oldAutoCommit;
2281 push @errors, $error;
2283 savepoint_release( $savepoint );
2284 dbh->commit if $oldAutoCommit;
2291 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2292 $self->custnum. "\n"
2296 if ($opt{'cust_pkg_reason'}) {
2297 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2303 my $savepoint = 'cancel_pkgs_'.$i++;
2304 savepoint_create( $savepoint );
2306 my $cpr = shift @cprs;
2308 $lopt{'reason'} = $cpr->reasonnum;
2309 $lopt{'reason_otaker'} = $cpr->otaker;
2311 warn "no reason found when canceling package ".$_->pkgnum."\n";
2312 # we're not actually required to pass a reason to cust_pkg::cancel,
2313 # but if we're getting to this point, something has gone awry.
2314 $null_reason ||= FS::reason->new_or_existing(
2315 reason => 'unknown reason',
2316 type => 'Cancel Reason',
2319 $lopt{'reason'} = $null_reason->reasonnum;
2320 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2323 my $error = $_->cancel(%lopt);
2325 savepoint_rollback_and_release( $savepoint );
2326 dbh->rollback if $oldAutoCommit;
2327 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2329 savepoint_release( $savepoint );
2330 dbh->commit if $oldAutoCommit;
2337 sub _banned_pay_hashref {
2338 die 'cust_main->_banned_pay_hashref deprecated';
2350 'payby' => $payby2ban{$self->payby},
2351 'payinfo' => $self->payinfo,
2352 #don't ever *search* on reason! #'reason' =>
2358 Returns all notes (see L<FS::cust_main_note>) for this customer.
2363 my($self,$orderby_classnum) = (shift,shift);
2364 my $orderby = "sticky DESC, _date DESC";
2365 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2366 qsearch( 'cust_main_note',
2367 { 'custnum' => $self->custnum },
2369 "ORDER BY $orderby",
2375 Returns the agent (see L<FS::agent>) for this customer.
2379 Returns the agent name (see L<FS::agent>) for this customer.
2385 $self->agent->agent;
2390 Returns any tags associated with this customer, as FS::cust_tag objects,
2391 or an empty list if there are no tags.
2395 Returns any tags associated with this customer, as FS::part_tag objects,
2396 or an empty list if there are no tags.
2402 map $_->part_tag, $self->cust_tag;
2408 Returns the customer class, as an FS::cust_class object, or the empty string
2409 if there is no customer class.
2413 Returns the customer category name, or the empty string if there is no customer
2420 my $cust_class = $self->cust_class;
2422 ? $cust_class->categoryname
2428 Returns the customer class name, or the empty string if there is no customer
2435 my $cust_class = $self->cust_class;
2437 ? $cust_class->classname
2443 Returns the external tax status, as an FS::tax_status object, or the empty
2444 string if there is no tax status.
2450 if ( $self->taxstatusnum ) {
2451 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2459 Returns the tax status code if there is one.
2465 my $tax_status = $self->tax_status;
2467 ? $tax_status->taxstatus
2471 =item BILLING METHODS
2473 Documentation on billing methods has been moved to
2474 L<FS::cust_main::Billing>.
2476 =item REALTIME BILLING METHODS
2478 Documentation on realtime billing methods has been moved to
2479 L<FS::cust_main::Billing_Realtime>.
2483 Removes the I<paycvv> field from the database directly.
2485 If there is an error, returns the error, otherwise returns false.
2487 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2492 die 'cust_main->remove_cvv deprecated';
2494 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2495 or return dbh->errstr;
2496 $sth->execute($self->custnum)
2497 or return $sth->errstr;
2504 Returns the total owed for this customer on all invoices
2505 (see L<FS::cust_bill/owed>).
2511 $self->total_owed_date(2145859200); #12/31/2037
2514 =item total_owed_date TIME
2516 Returns the total owed for this customer on all invoices with date earlier than
2517 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2518 see L<Time::Local> and L<Date::Parse> for conversion functions.
2522 sub total_owed_date {
2526 my $custnum = $self->custnum;
2528 my $owed_sql = FS::cust_bill->owed_sql;
2531 SELECT SUM($owed_sql) FROM cust_bill
2532 WHERE custnum = $custnum
2536 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2540 =item total_owed_pkgnum PKGNUM
2542 Returns the total owed on all invoices for this customer's specific package
2543 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2547 sub total_owed_pkgnum {
2548 my( $self, $pkgnum ) = @_;
2549 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2552 =item total_owed_date_pkgnum TIME PKGNUM
2554 Returns the total owed for this customer's specific package when using
2555 experimental package balances on all invoices with date earlier than
2556 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2557 see L<Time::Local> and L<Date::Parse> for conversion functions.
2561 sub total_owed_date_pkgnum {
2562 my( $self, $time, $pkgnum ) = @_;
2565 foreach my $cust_bill (
2566 grep { $_->_date <= $time }
2567 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2569 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2571 sprintf( "%.2f", $total_bill );
2577 Returns the total amount of all payments.
2584 $total += $_->paid foreach $self->cust_pay;
2585 sprintf( "%.2f", $total );
2588 =item total_unapplied_credits
2590 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2591 customer. See L<FS::cust_credit/credited>.
2593 =item total_credited
2595 Old name for total_unapplied_credits. Don't use.
2599 sub total_credited {
2600 #carp "total_credited deprecated, use total_unapplied_credits";
2601 shift->total_unapplied_credits(@_);
2604 sub total_unapplied_credits {
2607 my $custnum = $self->custnum;
2609 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2612 SELECT SUM($unapplied_sql) FROM cust_credit
2613 WHERE custnum = $custnum
2616 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2620 =item total_unapplied_credits_pkgnum PKGNUM
2622 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2623 customer. See L<FS::cust_credit/credited>.
2627 sub total_unapplied_credits_pkgnum {
2628 my( $self, $pkgnum ) = @_;
2629 my $total_credit = 0;
2630 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2631 sprintf( "%.2f", $total_credit );
2635 =item total_unapplied_payments
2637 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2638 See L<FS::cust_pay/unapplied>.
2642 sub total_unapplied_payments {
2645 my $custnum = $self->custnum;
2647 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2650 SELECT SUM($unapplied_sql) FROM cust_pay
2651 WHERE custnum = $custnum
2654 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2658 =item total_unapplied_payments_pkgnum PKGNUM
2660 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2661 specific package when using experimental package balances. See
2662 L<FS::cust_pay/unapplied>.
2666 sub total_unapplied_payments_pkgnum {
2667 my( $self, $pkgnum ) = @_;
2668 my $total_unapplied = 0;
2669 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2670 sprintf( "%.2f", $total_unapplied );
2674 =item total_unapplied_refunds
2676 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2677 customer. See L<FS::cust_refund/unapplied>.
2681 sub total_unapplied_refunds {
2683 my $custnum = $self->custnum;
2685 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2688 SELECT SUM($unapplied_sql) FROM cust_refund
2689 WHERE custnum = $custnum
2692 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2698 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2699 total_unapplied_credits minus total_unapplied_payments).
2705 $self->balance_date_range;
2708 =item balance_date TIME
2710 Returns the balance for this customer, only considering invoices with date
2711 earlier than TIME (total_owed_date minus total_credited minus
2712 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2713 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2720 $self->balance_date_range(shift);
2723 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2725 Returns the balance for this customer, optionally considering invoices with
2726 date earlier than START_TIME, and not later than END_TIME
2727 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2729 Times are specified as SQL fragments or numeric
2730 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2731 L<Date::Parse> for conversion functions. The empty string can be passed
2732 to disable that time constraint completely.
2734 Accepts the same options as L</balance_date_sql>:
2738 =item unapplied_date
2740 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)
2744 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2745 time will be ignored. Note that START_TIME and END_TIME only limit the date
2746 range for invoices and I<unapplied> payments, credits, and refunds.
2752 sub balance_date_range {
2754 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2755 ') FROM cust_main WHERE custnum='. $self->custnum;
2756 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2759 =item balance_pkgnum PKGNUM
2761 Returns the balance for this customer's specific package when using
2762 experimental package balances (total_owed plus total_unrefunded, minus
2763 total_unapplied_credits minus total_unapplied_payments)
2767 sub balance_pkgnum {
2768 my( $self, $pkgnum ) = @_;
2771 $self->total_owed_pkgnum($pkgnum)
2772 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2773 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2774 - $self->total_unapplied_credits_pkgnum($pkgnum)
2775 - $self->total_unapplied_payments_pkgnum($pkgnum)
2781 Returns a hash of useful information for making a payment.
2791 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2792 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2793 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2797 For credit card transactions:
2809 For electronic check transactions:
2819 #XXX i need to be updated for 4.x+
2825 $return{balance} = $self->balance;
2827 $return{payname} = $self->payname
2828 || ( $self->first. ' '. $self->get('last') );
2830 $return{$_} = $self->bill_location->$_
2831 for qw(address1 address2 city state zip);
2833 $return{payby} = $self->payby;
2834 $return{stateid_state} = $self->stateid_state;
2836 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2837 $return{card_type} = cardtype($self->payinfo);
2838 $return{payinfo} = $self->paymask;
2840 @return{'month', 'year'} = $self->paydate_monthyear;
2844 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2845 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2846 $return{payinfo1} = $payinfo1;
2847 $return{payinfo2} = $payinfo2;
2848 $return{paytype} = $self->paytype;
2849 $return{paystate} = $self->paystate;
2853 #doubleclick protection
2855 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2863 Returns the next payment expiration date for this customer. If they have no
2864 payment methods that will expire, returns 0.
2870 # filter out the ones that individually return 0, but then return 0 if
2871 # there are no results
2872 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2873 min( @epochs ) || 0;
2876 =item paydate_epoch_sql
2878 Returns an SQL expression to get the next payment expiration date for a
2879 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2880 dates, so that it's safe to test for "will it expire before date X" for any
2885 sub paydate_epoch_sql {
2887 my $paydate = FS::cust_payby->paydate_epoch_sql;
2888 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2892 my( $self, $taxname ) = @_;
2894 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2895 'taxname' => $taxname,
2900 =item cust_main_exemption
2902 =item invoicing_list
2904 Returns a list of email addresses (with svcnum entries expanded), and the word
2905 'POST' if the customer receives postal invoices.
2909 sub invoicing_list {
2910 my( $self, $arrayref ) = @_;
2913 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2916 my @emails = $self->invoicing_list_emailonly;
2917 push @emails, 'POST' if $self->get('postal_invoice');
2922 =item check_invoicing_list ARRAYREF
2924 Checks these arguements as valid input for the invoicing_list method. If there
2925 is an error, returns the error, otherwise returns false.
2929 sub check_invoicing_list {
2930 my( $self, $arrayref ) = @_;
2932 foreach my $address ( @$arrayref ) {
2934 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2935 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2938 my $cust_main_invoice = new FS::cust_main_invoice ( {
2939 'custnum' => $self->custnum,
2942 my $error = $self->custnum
2943 ? $cust_main_invoice->check
2944 : $cust_main_invoice->checkdest
2946 return $error if $error;
2950 return "Email address required"
2951 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2952 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2959 Returns the email addresses of all accounts provisioned for this customer.
2966 foreach my $cust_pkg ( $self->all_pkgs ) {
2967 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2969 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2970 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2972 $list{$_}=1 foreach map { $_->email } @svc_acct;
2977 =item invoicing_list_addpost
2979 Adds postal invoicing to this customer. If this customer is already configured
2980 to receive postal invoices, does nothing.
2984 sub invoicing_list_addpost {
2986 if ( $self->get('postal_invoice') eq '' ) {
2987 $self->set('postal_invoice', 'Y');
2988 my $error = $self->replace;
2989 warn $error if $error; # should fail harder, but this is traditional
2993 =item invoicing_list_emailonly
2995 Returns the list of email invoice recipients (invoicing_list without non-email
2996 destinations such as POST and FAX).
3000 sub invoicing_list_emailonly {
3002 warn "$me invoicing_list_emailonly called"
3004 return () if !$self->custnum; # not yet inserted
3005 return map { $_->emailaddress }
3007 table => 'cust_contact',
3008 select => 'emailaddress',
3009 addl_from => ' JOIN contact USING (contactnum) '.
3010 ' JOIN contact_email USING (contactnum)',
3011 hashref => { 'custnum' => $self->custnum, },
3012 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3016 =item invoicing_list_emailonly_scalar
3018 Returns the list of email invoice recipients (invoicing_list without non-email
3019 destinations such as POST and FAX) as a comma-separated scalar.
3023 sub invoicing_list_emailonly_scalar {
3025 warn "$me invoicing_list_emailonly_scalar called"
3027 join(', ', $self->invoicing_list_emailonly);
3030 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3032 Returns a list of contacts (L<FS::contact> objects) for the customer.
3034 If no arguments are given, returns all contacts for the customer.
3036 Arguments may contain classnums. When classnums are specified, only
3037 contacts with a matching cust_contact.classnum are returned. When a
3038 classnum of 0 is given, contacts with a null classnum are also included.
3040 Arguments may also contain the dest flag names 'invoice' or 'message'.
3041 If given, contacts who's invoice_dest and/or message_dest flags are
3042 not set to 'Y' will be excluded.
3050 select => join(', ',(
3052 'cust_contact.invoice_dest',
3053 'cust_contact.message_dest',
3055 addl_from => ' JOIN cust_contact USING (contactnum)',
3056 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3060 # Calling methods were relying on this method to use invoice_dest to
3061 # block e-mail messages. Depending on parameters, this may or may not
3062 # have actually happened.
3064 # The bug could cause this SQL to be used to filter e-mail addresses:
3067 # cust_contact.classnums IN (1,2,3)
3068 # OR cust_contact.invoice_dest = 'Y'
3071 # improperly including everybody with the opt-in flag AND everybody
3072 # in the contact classes
3074 # Possibility to introduce new bugs:
3075 # If callers of this method called it incorrectly, and didn't notice
3076 # because it seemed to send the e-mails they wanted.
3081 # cust_contact.classnum IN (1,2,3)
3083 # cust_contact.classnum IS NULL
3086 # cust_contact.invoice_dest = 'Y'
3088 # cust_contact.message_dest = 'Y'
3096 if ($_ eq 'invoice' || $_ eq 'message') {
3097 push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3098 } elsif ($_ eq '0') {
3099 push @or_classnum, ' cust_contact.classnum IS NULL ';
3100 } elsif ( /^\d+$/ ) {
3101 push @classnums, $_;
3103 croak "bad classnum argument '$_'";
3107 push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3110 if (@or_classnum || @and_dest) { # catch, no arguments given
3111 $search->{extra_sql} .= ' AND ( ';
3114 $search->{extra_sql} .= ' ( ';
3115 $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3116 $search->{extra_sql} .= ' ) ';
3117 $search->{extra_sql} .= ' AND ( ' if @and_dest;
3121 $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3122 $search->{extra_sql} .= ' ) ' if @or_classnum;
3125 $search->{extra_sql} .= ' ) ';
3127 warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3133 =item contact_list_email [ CLASSNUM, ... ]
3135 Same as L</contact_list>, but returns email destinations instead of contact
3140 sub contact_list_email {
3142 my @contacts = $self->contact_list(@_);
3144 foreach my $contact (@contacts) {
3145 foreach my $contact_email ($contact->contact_email) {
3146 push @emails, Email::Address->new( $contact->firstlast,
3147 $contact_email->emailaddress
3154 =item contact_list_email_destinations
3156 Returns a list of emails and whether they receive invoices or messages destinations.
3157 { emailaddress => 'email.com', invoice => 'Y', message => '', }
3161 sub contact_list_email_destinations {
3163 warn "$me contact_list_email_destinations"
3165 return () if !$self->custnum; # not yet inserted
3168 table => 'cust_contact',
3169 select => 'emailaddress, cust_contact.invoice_dest as invoice, cust_contact.message_dest as message',
3170 addl_from => ' JOIN contact USING (contactnum) '.
3171 ' JOIN contact_email USING (contactnum)',
3172 hashref => { 'custnum' => $self->custnum, },
3173 order_by => 'ORDER BY custcontactnum DESC',
3178 =item contact_list_emailonly
3180 Returns an array of hashes containing the emails. Used for displaying contact email field in advanced customer reports.
3181 [ { data => 'email.com', }, ]
3185 sub contact_list_emailonly {
3187 warn "$me contact_list_emailonly called"
3190 foreach ($self->contact_list_email_destinations) {
3193 'data' => $_->emailaddress,
3196 push @emails, $data;
3201 =item contact_list_cust_invoice_only
3203 Returns an array of hashes containing cust_contact.invoice_dest. Does this email receive invoices. Used for displaying email Invoice field in advanced customer reports.
3204 [ { data => 'Yes', }, ]
3208 sub contact_list_cust_invoice_only {
3210 warn "$me contact_list_cust_invoice_only called"
3213 foreach ($self->contact_list_email_destinations) {
3214 my $invoice = $_->invoice ? 'Yes' : 'No';
3220 push @emails, $data;
3225 =item contact_list_cust_message_only
3227 Returns an array of hashes containing cust_contact.message_dest. Does this email receive message notifications. Used for displaying email Message field in advanced customer reports.
3228 [ { data => 'Yes', }, ]
3232 sub contact_list_cust_message_only {
3234 warn "$me contact_list_cust_message_only called"
3237 foreach ($self->contact_list_email_destinations) {
3238 my $message = $_->message ? 'Yes' : 'No';
3244 push @emails, $data;
3249 =item referral_custnum_cust_main
3251 Returns the customer who referred this customer (or the empty string, if
3252 this customer was not referred).
3254 Note the difference with referral_cust_main method: This method,
3255 referral_custnum_cust_main returns the single customer (if any) who referred
3256 this customer, while referral_cust_main returns an array of customers referred
3261 sub referral_custnum_cust_main {
3263 return '' unless $self->referral_custnum;
3264 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3267 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3269 Returns an array of customers referred by this customer (referral_custnum set
3270 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3271 customers referred by customers referred by this customer and so on, inclusive.
3272 The default behavior is DEPTH 1 (no recursion).
3274 Note the difference with referral_custnum_cust_main method: This method,
3275 referral_cust_main, returns an array of customers referred BY this customer,
3276 while referral_custnum_cust_main returns the single customer (if any) who
3277 referred this customer.
3281 sub referral_cust_main {
3283 my $depth = @_ ? shift : 1;
3284 my $exclude = @_ ? shift : {};
3287 map { $exclude->{$_->custnum}++; $_; }
3288 grep { ! $exclude->{ $_->custnum } }
3289 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3293 map { $_->referral_cust_main($depth-1, $exclude) }
3300 =item referral_cust_main_ncancelled
3302 Same as referral_cust_main, except only returns customers with uncancelled
3307 sub referral_cust_main_ncancelled {
3309 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3312 =item referral_cust_pkg [ DEPTH ]
3314 Like referral_cust_main, except returns a flat list of all unsuspended (and
3315 uncancelled) packages for each customer. The number of items in this list may
3316 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3320 sub referral_cust_pkg {
3322 my $depth = @_ ? shift : 1;
3324 map { $_->unsuspended_pkgs }
3325 grep { $_->unsuspended_pkgs }
3326 $self->referral_cust_main($depth);
3329 =item referring_cust_main
3331 Returns the single cust_main record for the customer who referred this customer
3332 (referral_custnum), or false.
3336 sub referring_cust_main {
3338 return '' unless $self->referral_custnum;
3339 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3342 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3344 Applies a credit to this customer. If there is an error, returns the error,
3345 otherwise returns false.
3347 REASON can be a text string, an FS::reason object, or a scalar reference to
3348 a reasonnum. If a text string, it will be automatically inserted as a new
3349 reason, and a 'reason_type' option must be passed to indicate the
3350 FS::reason_type for the new reason.
3352 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3353 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3354 I<commission_pkgnum>.
3356 Any other options are passed to FS::cust_credit::insert.
3361 my( $self, $amount, $reason, %options ) = @_;
3363 my $cust_credit = new FS::cust_credit {
3364 'custnum' => $self->custnum,
3365 'amount' => $amount,
3368 if ( ref($reason) ) {
3370 if ( ref($reason) eq 'SCALAR' ) {
3371 $cust_credit->reasonnum( $$reason );
3373 $cust_credit->reasonnum( $reason->reasonnum );
3377 $cust_credit->set('reason', $reason)
3380 $cust_credit->$_( delete $options{$_} )
3381 foreach grep exists($options{$_}),
3382 qw( addlinfo eventnum ),
3383 map "commission_$_", qw( agentnum salesnum pkgnum );
3385 $cust_credit->insert(%options);
3389 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3391 Creates a one-time charge for this customer. If there is an error, returns
3392 the error, otherwise returns false.
3394 New-style, with a hashref of options:
3396 my $error = $cust_main->charge(
3400 'start_date' => str2time('7/4/2009'),
3401 'pkg' => 'Description',
3402 'comment' => 'Comment',
3403 'additional' => [], #extra invoice detail
3404 'classnum' => 1, #pkg_class
3406 'setuptax' => '', # or 'Y' for tax exempt
3408 'locationnum'=> 1234, # optional
3411 'taxclass' => 'Tax class',
3414 'taxproduct' => 2, #part_pkg_taxproduct
3415 'override' => {}, #XXX describe
3417 #will be filled in with the new object
3418 'cust_pkg_ref' => \$cust_pkg,
3420 #generate an invoice immediately
3422 'invoice_terms' => '', #with these terms
3428 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3432 #super false laziness w/quotation::charge
3435 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3436 my ( $pkg, $comment, $additional );
3437 my ( $setuptax, $taxclass ); #internal taxes
3438 my ( $taxproduct, $override ); #vendor (CCH) taxes
3440 my $separate_bill = '';
3441 my $cust_pkg_ref = '';
3442 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3444 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3445 if ( ref( $_[0] ) ) {
3446 $amount = $_[0]->{amount};
3447 $setup_cost = $_[0]->{setup_cost};
3448 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3449 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3450 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3451 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3452 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3453 : '$'. sprintf("%.2f",$amount);
3454 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3455 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3456 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3457 $additional = $_[0]->{additional} || [];
3458 $taxproduct = $_[0]->{taxproductnum};
3459 $override = { '' => $_[0]->{tax_override} };
3460 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3461 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3462 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3463 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3464 $separate_bill = $_[0]->{separate_bill} || '';
3465 $discountnum = $_[0]->{setup_discountnum};
3466 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3467 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3473 $pkg = @_ ? shift : 'One-time charge';
3474 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3476 $taxclass = @_ ? shift : '';
3480 local $SIG{HUP} = 'IGNORE';
3481 local $SIG{INT} = 'IGNORE';
3482 local $SIG{QUIT} = 'IGNORE';
3483 local $SIG{TERM} = 'IGNORE';
3484 local $SIG{TSTP} = 'IGNORE';
3485 local $SIG{PIPE} = 'IGNORE';
3487 my $oldAutoCommit = $FS::UID::AutoCommit;
3488 local $FS::UID::AutoCommit = 0;
3491 my $part_pkg = new FS::part_pkg ( {
3493 'comment' => $comment,
3497 'classnum' => ( $classnum ? $classnum : '' ),
3498 'setuptax' => $setuptax,
3499 'taxclass' => $taxclass,
3500 'taxproductnum' => $taxproduct,
3501 'setup_cost' => $setup_cost,
3504 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3505 ( 0 .. @$additional - 1 )
3507 'additional_count' => scalar(@$additional),
3508 'setup_fee' => $amount,
3511 my $error = $part_pkg->insert( options => \%options,
3512 tax_overrides => $override,
3515 $dbh->rollback if $oldAutoCommit;
3519 my $pkgpart = $part_pkg->pkgpart;
3520 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3521 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3522 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3523 $error = $type_pkgs->insert;
3525 $dbh->rollback if $oldAutoCommit;
3530 my $cust_pkg = new FS::cust_pkg ( {
3531 'custnum' => $self->custnum,
3532 'pkgpart' => $pkgpart,
3533 'quantity' => $quantity,
3534 'start_date' => $start_date,
3535 'no_auto' => $no_auto,
3536 'separate_bill' => $separate_bill,
3537 'locationnum' => $locationnum,
3538 'setup_discountnum' => $discountnum,
3539 'setup_discountnum_amount' => $discountnum_amount,
3540 'setup_discountnum_percent' => $discountnum_percent,
3543 $error = $cust_pkg->insert;
3545 $dbh->rollback if $oldAutoCommit;
3547 } elsif ( $cust_pkg_ref ) {
3548 ${$cust_pkg_ref} = $cust_pkg;
3552 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3553 'pkg_list' => [ $cust_pkg ],
3556 $dbh->rollback if $oldAutoCommit;
3561 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3566 #=item charge_postal_fee
3568 #Applies a one time charge this customer. If there is an error,
3569 #returns the error, returns the cust_pkg charge object or false
3570 #if there was no charge.
3574 # This should be a customer event. For that to work requires that bill
3575 # also be a customer event.
3577 sub charge_postal_fee {
3580 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3581 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3583 my $cust_pkg = new FS::cust_pkg ( {
3584 'custnum' => $self->custnum,
3585 'pkgpart' => $pkgpart,
3589 my $error = $cust_pkg->insert;
3590 $error ? $error : $cust_pkg;
3593 =item num_cust_attachment_deleted
3595 Returns the number of deleted attachments for this customer (see
3596 L<FS::num_cust_attachment>).
3600 sub num_cust_attachments_deleted {
3603 " SELECT COUNT(*) FROM cust_attachment ".
3604 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3611 Returns the most recent invnum (invoice number) for this customer.
3618 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3623 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3625 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3627 Optionally, a list or hashref of additional arguments to the qsearch call can
3634 my $opt = ref($_[0]) ? shift : { @_ };
3636 #return $self->num_cust_bill unless wantarray || keys %$opt;
3638 $opt->{'table'} = 'cust_bill';
3639 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3640 $opt->{'hashref'}{'custnum'} = $self->custnum;
3641 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3643 map { $_ } #behavior of sort undefined in scalar context
3644 sort { $a->_date <=> $b->_date }
3648 =item open_cust_bill
3650 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3655 sub open_cust_bill {
3659 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3665 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3667 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3671 sub legacy_cust_bill {
3674 #return $self->num_legacy_cust_bill unless wantarray;
3676 map { $_ } #behavior of sort undefined in scalar context
3677 sort { $a->_date <=> $b->_date }
3678 qsearch({ 'table' => 'legacy_cust_bill',
3679 'hashref' => { 'custnum' => $self->custnum, },
3680 'order_by' => 'ORDER BY _date ASC',
3684 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3686 Returns all the statements (see L<FS::cust_statement>) for this customer.
3688 Optionally, a list or hashref of additional arguments to the qsearch call can
3693 =item cust_bill_void
3695 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3699 sub cust_bill_void {
3702 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3703 sort { $a->_date <=> $b->_date }
3704 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3707 sub cust_statement {
3709 my $opt = ref($_[0]) ? shift : { @_ };
3711 #return $self->num_cust_statement unless wantarray || keys %$opt;
3713 $opt->{'table'} = 'cust_statement';
3714 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3715 $opt->{'hashref'}{'custnum'} = $self->custnum;
3716 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3718 map { $_ } #behavior of sort undefined in scalar context
3719 sort { $a->_date <=> $b->_date }
3723 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3725 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3727 Optionally, a list or hashref of additional arguments to the qsearch call can
3728 be passed following the SVCDB.
3735 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3736 warn "$me svc_x requires a svcdb";
3739 my $opt = ref($_[0]) ? shift : { @_ };
3741 $opt->{'table'} = $svcdb;
3742 $opt->{'addl_from'} =
3743 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3744 ($opt->{'addl_from'} || '');
3746 my $custnum = $self->custnum;
3747 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3748 my $where = "cust_pkg.custnum = $custnum";
3750 my $extra_sql = $opt->{'extra_sql'} || '';
3751 if ( keys %{ $opt->{'hashref'} } ) {
3752 $extra_sql = " AND $where $extra_sql";
3755 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3756 $extra_sql = "WHERE $where AND $1";
3759 $extra_sql = "WHERE $where $extra_sql";
3762 $opt->{'extra_sql'} = $extra_sql;
3767 # required for use as an eventtable;
3770 $self->svc_x('svc_acct', @_);
3775 Returns all the credits (see L<FS::cust_credit>) for this customer.
3782 #return $self->num_cust_credit unless wantarray;
3784 map { $_ } #behavior of sort undefined in scalar context
3785 sort { $a->_date <=> $b->_date }
3786 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3789 =item cust_credit_pkgnum
3791 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3792 package when using experimental package balances.
3796 sub cust_credit_pkgnum {
3797 my( $self, $pkgnum ) = @_;
3798 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3799 sort { $a->_date <=> $b->_date }
3800 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3801 'pkgnum' => $pkgnum,
3806 =item cust_credit_void
3808 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3812 sub cust_credit_void {
3815 sort { $a->_date <=> $b->_date }
3816 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3821 Returns all the payments (see L<FS::cust_pay>) for this customer.
3827 my $opt = ref($_[0]) ? shift : { @_ };
3829 return $self->num_cust_pay unless wantarray || keys %$opt;
3831 $opt->{'table'} = 'cust_pay';
3832 $opt->{'hashref'}{'custnum'} = $self->custnum;
3834 map { $_ } #behavior of sort undefined in scalar context
3835 sort { $a->_date <=> $b->_date }
3842 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3843 called automatically when the cust_pay method is used in a scalar context.
3849 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3850 my $sth = dbh->prepare($sql) or die dbh->errstr;
3851 $sth->execute($self->custnum) or die $sth->errstr;
3852 $sth->fetchrow_arrayref->[0];
3855 =item unapplied_cust_pay
3857 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3861 sub unapplied_cust_pay {
3865 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3871 =item cust_pay_pkgnum
3873 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3874 package when using experimental package balances.
3878 sub cust_pay_pkgnum {
3879 my( $self, $pkgnum ) = @_;
3880 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3881 sort { $a->_date <=> $b->_date }
3882 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3883 'pkgnum' => $pkgnum,
3890 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3896 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3897 sort { $a->_date <=> $b->_date }
3898 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3901 =item cust_pay_pending
3903 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3904 (without status "done").
3908 sub cust_pay_pending {
3910 return $self->num_cust_pay_pending unless wantarray;
3911 sort { $a->_date <=> $b->_date }
3912 qsearch( 'cust_pay_pending', {
3913 'custnum' => $self->custnum,
3914 'status' => { op=>'!=', value=>'done' },
3919 =item cust_pay_pending_attempt
3921 Returns all payment attempts / declined payments for this customer, as pending
3922 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3923 a corresponding payment (see L<FS::cust_pay>).
3927 sub cust_pay_pending_attempt {
3929 return $self->num_cust_pay_pending_attempt unless wantarray;
3930 sort { $a->_date <=> $b->_date }
3931 qsearch( 'cust_pay_pending', {
3932 'custnum' => $self->custnum,
3939 =item num_cust_pay_pending
3941 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3942 customer (without status "done"). Also called automatically when the
3943 cust_pay_pending method is used in a scalar context.
3947 sub num_cust_pay_pending {
3950 " SELECT COUNT(*) FROM cust_pay_pending ".
3951 " WHERE custnum = ? AND status != 'done' ",
3956 =item num_cust_pay_pending_attempt
3958 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3959 customer, with status "done" but without a corresp. Also called automatically when the
3960 cust_pay_pending method is used in a scalar context.
3964 sub num_cust_pay_pending_attempt {
3967 " SELECT COUNT(*) FROM cust_pay_pending ".
3968 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3975 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3981 map { $_ } #return $self->num_cust_refund unless wantarray;
3982 sort { $a->_date <=> $b->_date }
3983 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3986 =item display_custnum
3988 Returns the displayed customer number for this customer: agent_custid if
3989 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3993 sub display_custnum {
3996 return $self->agent_custid
3997 if $default_agent_custid && $self->agent_custid;
3999 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4003 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4004 } elsif ( $custnum_display_length ) {
4005 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4007 return $self->custnum;
4013 Returns a name string for this customer, either "Company (Last, First)" or
4020 my $name = $self->contact;
4021 $name = $self->company. " ($name)" if $self->company;
4025 =item batch_payment_payname
4027 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
4028 based on if a company name exists and is the account being used a business account.
4032 sub batch_payment_payname {
4034 my $cust_pay_batch = shift;
4037 if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
4038 else { $name = $self->first .' '. $self->last; }
4040 $name = $self->company
4041 if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
4046 =item service_contact
4048 Returns the L<FS::contact> object for this customer that has the 'Service'
4049 contact class, or undef if there is no such contact. Deprecated; don't use
4054 sub service_contact {
4056 if ( !exists($self->{service_contact}) ) {
4057 my $classnum = $self->scalar_sql(
4058 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4059 ) || 0; #if it's zero, qsearchs will return nothing
4060 my $cust_contact = qsearchs('cust_contact', {
4061 'classnum' => $classnum,
4062 'custnum' => $self->custnum,
4064 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4066 $self->{service_contact};
4071 Returns a name string for this (service/shipping) contact, either
4072 "Company (Last, First)" or "Last, First".
4079 my $name = $self->ship_contact;
4080 $name = $self->company. " ($name)" if $self->company;
4086 Returns a name string for this customer, either "Company" or "First Last".
4092 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4095 =item ship_name_short
4097 Returns a name string for this (service/shipping) contact, either "Company"
4102 sub ship_name_short {
4104 $self->service_contact
4105 ? $self->ship_contact_firstlast
4111 Returns this customer's full (billing) contact name only, "Last, First"
4117 $self->get('last'). ', '. $self->first;
4122 Returns this customer's full (shipping) contact name only, "Last, First"
4128 my $contact = $self->service_contact || $self;
4129 $contact->get('last') . ', ' . $contact->get('first');
4132 =item contact_firstlast
4134 Returns this customers full (billing) contact name only, "First Last".
4138 sub contact_firstlast {
4140 $self->first. ' '. $self->get('last');
4143 =item ship_contact_firstlast
4145 Returns this customer's full (shipping) contact name only, "First Last".
4149 sub ship_contact_firstlast {
4151 my $contact = $self->service_contact || $self;
4152 $contact->get('first') . ' '. $contact->get('last');
4155 sub bill_country_full {
4157 $self->bill_location->country_full;
4160 sub ship_country_full {
4162 $self->ship_location->country_full;
4165 =item county_state_county [ PREFIX ]
4167 Returns a string consisting of just the county, state and country.
4171 sub county_state_country {
4174 if ( @_ && $_[0] && $self->has_ship_address ) {
4175 $locationnum = $self->ship_locationnum;
4177 $locationnum = $self->bill_locationnum;
4179 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4180 $cust_location->county_state_country;
4183 =item geocode DATA_VENDOR
4185 Returns a value for the customer location as encoded by DATA_VENDOR.
4186 Currently this only makes sense for "CCH" as DATA_VENDOR.
4194 Returns a status string for this customer, currently:
4200 No packages have ever been ordered. Displayed as "No packages".
4204 Recurring packages all are new (not yet billed).
4208 One or more recurring packages is active.
4212 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4216 All non-cancelled recurring packages are suspended.
4220 All recurring packages are cancelled.
4224 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4225 cust_main-status_module configuration option.
4229 sub status { shift->cust_status(@_); }
4233 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4234 for my $status ( FS::cust_main->statuses() ) {
4235 my $method = $status.'_sql';
4236 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4237 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4238 $sth->execute( ($self->custnum) x $numnum )
4239 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4240 if ( $sth->fetchrow_arrayref->[0] ) {
4241 $self->hashref->{cust_status} = $status;
4247 =item is_status_delay_cancel
4249 Returns true if customer status is 'suspended'
4250 and all suspended cust_pkg return true for
4251 cust_pkg->is_status_delay_cancel.
4253 This is not a real status, this only meant for hacking display
4254 values, because otherwise treating the customer as suspended is
4255 really the whole point of the delay_cancel option.
4259 sub is_status_delay_cancel {
4261 return 0 unless $self->status eq 'suspended';
4262 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4263 return 0 unless $cust_pkg->is_status_delay_cancel;
4268 =item ucfirst_cust_status
4270 =item ucfirst_status
4272 Deprecated, use the cust_status_label method instead.
4274 Returns the status with the first character capitalized.
4278 sub ucfirst_status {
4279 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4280 local($ucfirst_nowarn) = 1;
4281 shift->ucfirst_cust_status(@_);
4284 sub ucfirst_cust_status {
4285 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4287 ucfirst($self->cust_status);
4290 =item cust_status_label
4294 Returns the display label for this status.
4298 sub status_label { shift->cust_status_label(@_); }
4300 sub cust_status_label {
4302 __PACKAGE__->statuslabels->{$self->cust_status};
4307 Returns a hex triplet color string for this customer's status.
4311 sub statuscolor { shift->cust_statuscolor(@_); }
4313 sub cust_statuscolor {
4315 __PACKAGE__->statuscolors->{$self->cust_status};
4318 =item tickets [ STATUS ]
4320 Returns an array of hashes representing the customer's RT tickets.
4322 An optional status (or arrayref or hashref of statuses) may be specified.
4328 my $status = ( @_ && $_[0] ) ? shift : '';
4330 my $num = $conf->config('cust_main-max_tickets') || 10;
4333 if ( $conf->config('ticket_system') ) {
4334 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4336 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4345 foreach my $priority (
4346 $conf->config('ticket_system-custom_priority_field-values'), ''
4348 last if scalar(@tickets) >= $num;
4350 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4351 $num - scalar(@tickets),
4362 =item appointments [ STATUS ]
4364 Returns an array of hashes representing the customer's RT tickets which
4371 my $status = ( @_ && $_[0] ) ? shift : '';
4373 return () unless $conf->config('ticket_system');
4375 my $queueid = $conf->config('ticket_system-appointment-queueid');
4377 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4386 # Return services representing svc_accts in customer support packages
4387 sub support_services {
4389 my %packages = map { $_ => 1 } $conf->config('support_packages');
4391 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4392 grep { $_->part_svc->svcdb eq 'svc_acct' }
4393 map { $_->cust_svc }
4394 grep { exists $packages{ $_->pkgpart } }
4395 $self->ncancelled_pkgs;
4399 # Return a list of latitude/longitude for one of the services (if any)
4400 sub service_coordinates {
4404 grep { $_->latitude && $_->longitude }
4406 map { $_->cust_svc }
4407 $self->ncancelled_pkgs;
4409 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4414 Returns a masked version of the named field
4419 my ($self,$field) = @_;
4423 'x'x(length($self->getfield($field))-4).
4424 substr($self->getfield($field), (length($self->getfield($field))-4));
4428 =item payment_history
4430 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4431 cust_credit and cust_refund objects. Each hashref has the following fields:
4433 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4435 I<date> - value of _date field, unix timestamp
4437 I<date_pretty> - user-friendly date
4439 I<description> - user-friendly description of item
4441 I<amount> - impact of item on user's balance
4442 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4443 Not to be confused with the native 'amount' field in cust_credit, see below.
4445 I<amount_pretty> - includes money char
4447 I<balance> - customer balance, chronologically as of this item
4449 I<balance_pretty> - includes money char
4451 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4453 I<paid> - amount paid for cust_pay records, undef for other types
4455 I<credit> - amount credited for cust_credit records, undef for other types.
4456 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4458 I<refund> - amount refunded for cust_refund records, undef for other types
4460 The four table-specific keys always have positive values, whether they reflect charges or payments.
4462 The following options may be passed to this method:
4464 I<line_items> - if true, returns charges ('Line item') rather than invoices
4466 I<start_date> - unix timestamp, only include records on or after.
4467 If specified, an item of type 'Previous' will also be included.
4468 It does not have table-specific fields.
4470 I<end_date> - unix timestamp, only include records before
4472 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4474 I<conf> - optional already-loaded FS::Conf object.
4478 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4479 # and also for sending customer statements, which should both be kept customer-friendly.
4480 # If you add anything that shouldn't be passed on through the API or exposed
4481 # to customers, add a new option to include it, don't include it by default
4482 sub payment_history {
4484 my $opt = ref($_[0]) ? $_[0] : { @_ };
4486 my $conf = $$opt{'conf'} || new FS::Conf;
4487 my $money_char = $conf->config("money_char") || '$',
4489 #first load entire history,
4490 #need previous to calculate previous balance
4491 #loading after end_date shouldn't hurt too much?
4493 if ( $$opt{'line_items'} ) {
4495 foreach my $cust_bill ( $self->cust_bill ) {
4498 'type' => 'Line item',
4499 'description' => $_->desc( $self->locale ).
4500 ( $_->sdate && $_->edate
4501 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4502 ' To '. time2str('%d-%b-%Y', $_->edate)
4505 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4506 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4507 'date' => $cust_bill->_date,
4508 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4510 foreach $cust_bill->cust_bill_pkg;
4517 'type' => 'Invoice',
4518 'description' => 'Invoice #'. $_->display_invnum,
4519 'amount' => sprintf('%.2f', $_->charged ),
4520 'charged' => sprintf('%.2f', $_->charged ),
4521 'date' => $_->_date,
4522 'date_pretty' => $self->time2str_local('short', $_->_date ),
4524 foreach $self->cust_bill;
4529 'type' => 'Payment',
4530 'description' => 'Payment', #XXX type
4531 'amount' => sprintf('%.2f', 0 - $_->paid ),
4532 'paid' => sprintf('%.2f', $_->paid ),
4533 'date' => $_->_date,
4534 'date_pretty' => $self->time2str_local('short', $_->_date ),
4536 foreach $self->cust_pay;
4540 'description' => 'Credit', #more info?
4541 'amount' => sprintf('%.2f', 0 -$_->amount ),
4542 'credit' => sprintf('%.2f', $_->amount ),
4543 'date' => $_->_date,
4544 'date_pretty' => $self->time2str_local('short', $_->_date ),
4546 foreach $self->cust_credit;
4550 'description' => 'Refund', #more info? type, like payment?
4551 'amount' => $_->refund,
4552 'refund' => $_->refund,
4553 'date' => $_->_date,
4554 'date_pretty' => $self->time2str_local('short', $_->_date ),
4556 foreach $self->cust_refund;
4558 #put it all in chronological order
4559 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4561 #calculate balance, filter items outside date range
4565 foreach my $item (@history) {
4566 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4567 $balance += $$item{'amount'};
4568 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4569 $previous += $$item{'amount'};
4572 $$item{'balance'} = sprintf("%.2f",$balance);
4573 foreach my $key ( qw(amount balance) ) {
4574 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4579 # start with previous balance, if there was one
4582 'type' => 'Previous',
4583 'description' => 'Previous balance',
4584 'amount' => sprintf("%.2f",$previous),
4585 'balance' => sprintf("%.2f",$previous),
4586 'date' => $$opt{'start_date'},
4587 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4589 #false laziness with above
4590 foreach my $key ( qw(amount balance) ) {
4591 $$item{$key.'_pretty'} = $$item{$key};
4592 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4594 unshift(@out,$item);
4597 @out = reverse @history if $$opt{'reverse_sort'};
4602 =item save_cust_payby
4604 Saves a new cust_payby for this customer, replacing an existing entry only
4605 in select circumstances. Does not validate input.
4607 If auto is specified, marks this as the customer's primary method, or the
4608 specified weight. Existing payment methods have their weight incremented as
4611 If bill_location is specified with auto, also sets location in cust_main.
4613 Will not insert complete duplicates of existing records, or records in which the
4614 only difference from an existing record is to turn off automatic payment (will
4615 return without error.) Will replace existing records in which the only difference
4616 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4617 Fields marked as preserved are optional, and existing values will not be overwritten with
4618 blanks when replacing.
4620 Accepts the following named parameters:
4630 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4634 optional, set higher than 1 for secondary, etc.
4642 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4650 optional, will be preserved when replacing
4658 CARD only, required, FS::cust_location object
4660 =item paystart_month
4662 CARD only, optional, will be preserved when replacing
4666 CARD only, optional, will be preserved when replacing
4670 CARD only, optional, will be preserved when replacing
4674 CARD only, only used if conf cvv-save is set appropriately
4684 =item saved_cust_payby
4686 scalar reference, for returning saved object
4692 #The code for this option is in place, but it's not currently used
4696 # existing cust_payby object to be replaced (must match custnum)
4698 # stateid/stateid_state/ss are not currently supported in cust_payby,
4699 # might not even work properly in 4.x, but will need to work here if ever added
4701 sub save_cust_payby {
4705 my $old = $opt{'replace'};
4706 my $new = new FS::cust_payby { $old ? $old->hash : () };
4707 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4708 $new->set( 'custnum' => $self->custnum );
4710 my $payby = $opt{'payment_payby'};
4711 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4713 # don't allow turning off auto when replacing
4714 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4716 my @check_existing; # payby relevant to this payment_payby
4718 # set payby based on auto
4719 if ( $payby eq 'CARD' ) {
4720 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4721 @check_existing = qw( CARD DCRD );
4722 } elsif ( $payby eq 'CHEK' ) {
4723 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4724 @check_existing = qw( CHEK DCHK );
4727 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4730 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4731 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4732 $new->set( 'payname' => $opt{'payname'} );
4733 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4735 my $conf = new FS::Conf;
4737 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4738 if ( $payby eq 'CARD' &&
4739 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4740 || $conf->exists('business-onlinepayment-verification')
4743 $new->set( 'paycvv' => $opt{'paycvv'} );
4745 $new->set( 'paycvv' => '');
4748 local $SIG{HUP} = 'IGNORE';
4749 local $SIG{INT} = 'IGNORE';
4750 local $SIG{QUIT} = 'IGNORE';
4751 local $SIG{TERM} = 'IGNORE';
4752 local $SIG{TSTP} = 'IGNORE';
4753 local $SIG{PIPE} = 'IGNORE';
4755 my $oldAutoCommit = $FS::UID::AutoCommit;
4756 local $FS::UID::AutoCommit = 0;
4759 # set fields specific to payment_payby
4760 if ( $payby eq 'CARD' ) {
4761 if ($opt{'bill_location'}) {
4762 $opt{'bill_location'}->set('custnum' => $self->custnum);
4763 my $error = $opt{'bill_location'}->find_or_insert;
4765 $dbh->rollback if $oldAutoCommit;
4768 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4770 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4771 $new->set( $field => $opt{$field} );
4774 foreach my $field ( qw(paytype paystate) ) {
4775 $new->set( $field => $opt{$field} );
4779 # other cust_payby to compare this to
4780 my @existing = $self->cust_payby(@check_existing);
4782 # fields that can overwrite blanks with values, but not values with blanks
4783 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4785 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4787 # generally, we don't want to overwrite existing cust_payby with this,
4788 # but we can replace if we're only marking it auto or adding a preserved field
4789 # and we can avoid saving a total duplicate or merely turning off auto
4791 foreach my $cust_payby (@existing) {
4792 # check fields that absolutely should not change
4793 foreach my $field ($new->fields) {
4794 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4795 next if grep(/^$field$/, @preserve );
4796 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4797 # check if paymask exists, if so stop and don't save, no need for a duplicate.
4798 return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4800 # now check fields that can replace if one value is blank
4802 foreach my $field (@preserve) {
4804 ( $new->get($field) and !$cust_payby->get($field) ) or
4805 ( $cust_payby->get($field) and !$new->get($field) )
4807 # prevention of overwriting values with blanks happens farther below
4809 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4813 unless ( $replace ) {
4814 # nearly identical, now check weight
4815 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4816 # ignore identical cust_payby, and ignore attempts to turn off auto
4817 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4818 $skip_cust_payby = 1;
4821 # otherwise, only change is to mark this as primary
4823 # if we got this far, we're definitely replacing
4830 $new->set( 'custpaybynum' => $old->custpaybynum );
4831 # don't turn off automatic payment (but allow it to be turned on)
4832 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4834 $new->set( 'payby' => $old->payby );
4835 $new->set( 'weight' => 1 );
4837 # make sure we're not overwriting values with blanks
4838 foreach my $field (@preserve) {
4839 if ( $old->get($field) and !$new->get($field) ) {
4840 $new->set( $field => $old->get($field) );
4845 # only overwrite cust_main bill_location if auto
4846 if ($opt{'auto'} && $opt{'bill_location'}) {
4847 $self->set('bill_location' => $opt{'bill_location'});
4848 my $error = $self->replace;
4850 $dbh->rollback if $oldAutoCommit;
4855 # done with everything except reweighting and saving cust_payby
4856 # still need to commit changes to cust_main and cust_location
4857 if ($skip_cust_payby) {
4858 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4862 # re-weight existing primary cust_pay for this payby
4864 foreach my $cust_payby (@existing) {
4865 # relies on cust_payby return order
4866 last unless $cust_payby->payby !~ /^D/;
4867 last if $cust_payby->weight > 1;
4868 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4869 next if $cust_payby->weight < ($opt{'weight'} || 1);
4870 $cust_payby->weight( $cust_payby->weight + 1 );
4871 my $error = $cust_payby->replace;
4873 $dbh->rollback if $oldAutoCommit;
4874 return "Error reweighting cust_payby: $error";
4879 # finally, save cust_payby
4880 my $error = $old ? $new->replace($old) : $new->insert;
4882 $dbh->rollback if $oldAutoCommit;
4886 ${$opt{'saved_cust_payby'}} = $new
4887 if $opt{'saved_cust_payby'};
4889 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4894 =item remove_cvv_from_cust_payby PAYINFO
4896 Removes paycvv from associated cust_payby with matching PAYINFO.
4900 sub remove_cvv_from_cust_payby {
4901 my ($self,$payinfo) = @_;
4903 my $oldAutoCommit = $FS::UID::AutoCommit;
4904 local $FS::UID::AutoCommit = 0;
4907 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4908 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4909 $cust_payby->paycvv('');
4910 my $error = $cust_payby->replace;
4912 $dbh->rollback if $oldAutoCommit;
4917 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4923 =head1 CLASS METHODS
4929 Class method that returns the list of possible status strings for customers
4930 (see L<the status method|/status>). For example:
4932 @statuses = FS::cust_main->statuses();
4938 keys %{ $self->statuscolors };
4941 =item cust_status_sql
4943 Returns an SQL fragment to determine the status of a cust_main record, as a
4948 sub cust_status_sql {
4950 for my $status ( FS::cust_main->statuses() ) {
4951 my $method = $status.'_sql';
4952 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4961 Returns an SQL expression identifying prospective cust_main records (customers
4962 with no packages ever ordered)
4966 use vars qw($select_count_pkgs);
4967 $select_count_pkgs =
4968 "SELECT COUNT(*) FROM cust_pkg
4969 WHERE cust_pkg.custnum = cust_main.custnum";
4971 sub select_count_pkgs_sql {
4976 " 0 = ( $select_count_pkgs ) ";
4981 Returns an SQL expression identifying ordered cust_main records (customers with
4982 no active packages, but recurring packages not yet setup or one time charges
4988 FS::cust_main->none_active_sql.
4989 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4994 Returns an SQL expression identifying active cust_main records (customers with
4995 active recurring packages).
5000 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5003 =item none_active_sql
5005 Returns an SQL expression identifying cust_main records with no active
5006 recurring packages. This includes customers of status prospect, ordered,
5007 inactive, and suspended.
5011 sub none_active_sql {
5012 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5017 Returns an SQL expression identifying inactive cust_main records (customers with
5018 no active recurring packages, but otherwise unsuspended/uncancelled).
5023 FS::cust_main->none_active_sql.
5024 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5030 Returns an SQL expression identifying suspended cust_main records.
5035 sub suspended_sql { susp_sql(@_); }
5037 FS::cust_main->none_active_sql.
5038 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5044 Returns an SQL expression identifying cancelled cust_main records.
5048 sub cancel_sql { shift->cancelled_sql(@_); }
5051 =item uncancelled_sql
5053 Returns an SQL expression identifying un-cancelled cust_main records.
5057 sub uncancelled_sql { uncancel_sql(@_); }
5060 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5065 Returns an SQL fragment to retreive the balance.
5070 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5071 WHERE cust_bill.custnum = cust_main.custnum )
5072 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5073 WHERE cust_pay.custnum = cust_main.custnum )
5074 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5075 WHERE cust_credit.custnum = cust_main.custnum )
5076 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5077 WHERE cust_refund.custnum = cust_main.custnum )
5080 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5082 Returns an SQL fragment to retreive the balance for this customer, optionally
5083 considering invoices with date earlier than START_TIME, and not
5084 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5085 total_unapplied_payments).
5087 Times are specified as SQL fragments or numeric
5088 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5089 L<Date::Parse> for conversion functions. The empty string can be passed
5090 to disable that time constraint completely.
5092 Available options are:
5096 =item unapplied_date
5098 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)
5103 set to true to remove all customer comparison clauses, for totals
5108 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5113 JOIN clause (typically used with the total option)
5117 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5118 time will be ignored. Note that START_TIME and END_TIME only limit the date
5119 range for invoices and I<unapplied> payments, credits, and refunds.
5125 sub balance_date_sql {
5126 my( $class, $start, $end, %opt ) = @_;
5128 my $cutoff = $opt{'cutoff'};
5130 my $owed = FS::cust_bill->owed_sql($cutoff);
5131 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5132 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5133 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5135 my $j = $opt{'join'} || '';
5137 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5138 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5139 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5140 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5142 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5143 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5144 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5145 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5150 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5152 Returns an SQL fragment to retreive the total unapplied payments for this
5153 customer, only considering payments with date earlier than START_TIME, and
5154 optionally not later than END_TIME.
5156 Times are specified as SQL fragments or numeric
5157 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5158 L<Date::Parse> for conversion functions. The empty string can be passed
5159 to disable that time constraint completely.
5161 Available options are:
5165 sub unapplied_payments_date_sql {
5166 my( $class, $start, $end, %opt ) = @_;
5168 my $cutoff = $opt{'cutoff'};
5170 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5172 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5173 'unapplied_date'=>1 );
5175 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5178 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5180 Helper method for balance_date_sql; name (and usage) subject to change
5181 (suggestions welcome).
5183 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5184 cust_refund, cust_credit or cust_pay).
5186 If TABLE is "cust_bill" or the unapplied_date option is true, only
5187 considers records with date earlier than START_TIME, and optionally not
5188 later than END_TIME .
5192 sub _money_table_where {
5193 my( $class, $table, $start, $end, %opt ) = @_;
5196 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5197 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5198 push @where, "$table._date <= $start" if defined($start) && length($start);
5199 push @where, "$table._date > $end" if defined($end) && length($end);
5201 push @where, @{$opt{'where'}} if $opt{'where'};
5202 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5208 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5209 use FS::cust_main::Search;
5212 FS::cust_main::Search->search(@_);
5221 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5223 Generates a templated notification to the customer (see L<Text::Template>).
5225 OPTIONS is a hash and may include
5227 I<extra_fields> - a hashref of name/value pairs which will be substituted
5228 into the template. These values may override values mentioned below
5229 and those from the customer record.
5231 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5233 The following variables are available in the template instead of or in addition
5234 to the fields of the customer record.
5236 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5240 # a lot like cust_bill::print_latex
5241 sub generate_letter {
5242 my ($self, $template, %options) = @_;
5244 warn "Template $template does not exist" && return
5245 unless $conf->exists($template) || $options{'template_text'};
5247 my $template_source = $options{'template_text'}
5248 ? [ $options{'template_text'} ]
5249 : [ map "$_\n", $conf->config($template) ];
5251 my $letter_template = new Text::Template
5253 SOURCE => $template_source,
5254 DELIMITERS => [ '[@--', '--@]' ],
5256 or die "can't create new Text::Template object: Text::Template::ERROR";
5258 $letter_template->compile()
5259 or die "can't compile template: Text::Template::ERROR";
5261 my %letter_data = map { $_ => $self->$_ } $self->fields;
5263 for (keys %{$options{extra_fields}}){
5264 $letter_data{$_} = $options{extra_fields}->{$_};
5267 unless(exists($letter_data{returnaddress})){
5268 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5269 $self->agent_template)
5271 if ( length($retadd) ) {
5272 $letter_data{returnaddress} = $retadd;
5273 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5274 $letter_data{returnaddress} =
5275 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5279 ( $conf->config('company_name', $self->agentnum),
5280 $conf->config('company_address', $self->agentnum),
5284 $letter_data{returnaddress} = '~';
5288 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5290 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5292 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5294 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5298 ) or die "can't open temp file: $!\n";
5299 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5300 or die "can't write temp file: $!\n";
5302 $letter_data{'logo_file'} = $lh->filename;
5304 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5308 ) or die "can't open temp file: $!\n";
5310 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5312 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5313 return ($1, $letter_data{'logo_file'});
5317 =item print_ps TEMPLATE
5319 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5325 my($file, $lfile) = $self->generate_letter(@_);
5326 my $ps = FS::Misc::generate_ps($file);
5327 unlink($file.'.tex');
5333 =item print TEMPLATE
5335 Prints the filled in template.
5337 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5341 sub queueable_print {
5344 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5345 or die "invalid customer number: " . $opt{custnum};
5347 #do not backport this change to 3.x
5348 # my $error = $self->print( { 'template' => $opt{template} } );
5349 my $error = $self->print( $opt{'template'} );
5350 die $error if $error;
5354 my ($self, $template) = (shift, shift);
5356 [ $self->print_ps($template) ],
5357 'agentnum' => $self->agentnum,
5361 #these three subs should just go away once agent stuff is all config overrides
5363 sub agent_template {
5365 $self->_agent_plandata('agent_templatename');
5368 sub agent_invoice_from {
5370 $self->_agent_plandata('agent_invoice_from');
5373 sub _agent_plandata {
5374 my( $self, $option ) = @_;
5376 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5377 #agent-specific Conf
5379 use FS::part_event::Condition;
5381 my $agentnum = $self->agentnum;
5383 my $regexp = regexp_sql();
5385 my $part_event_option =
5387 'select' => 'part_event_option.*',
5388 'table' => 'part_event_option',
5390 LEFT JOIN part_event USING ( eventpart )
5391 LEFT JOIN part_event_option AS peo_agentnum
5392 ON ( part_event.eventpart = peo_agentnum.eventpart
5393 AND peo_agentnum.optionname = 'agentnum'
5394 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5396 LEFT JOIN part_event_condition
5397 ON ( part_event.eventpart = part_event_condition.eventpart
5398 AND part_event_condition.conditionname = 'cust_bill_age'
5400 LEFT JOIN part_event_condition_option
5401 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5402 AND part_event_condition_option.optionname = 'age'
5405 #'hashref' => { 'optionname' => $option },
5406 #'hashref' => { 'part_event_option.optionname' => $option },
5408 " WHERE part_event_option.optionname = ". dbh->quote($option).
5409 " AND action = 'cust_bill_send_agent' ".
5410 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5411 " AND peo_agentnum.optionname = 'agentnum' ".
5412 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5414 CASE WHEN part_event_condition_option.optionname IS NULL
5416 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5418 , part_event.weight".
5422 unless ( $part_event_option ) {
5423 return $self->agent->invoice_template || ''
5424 if $option eq 'agent_templatename';
5428 $part_event_option->optionvalue;
5432 sub process_o2m_qsearch {
5435 return qsearch($table, @_) unless $table eq 'contact';
5437 my $hashref = shift;
5438 my %hash = %$hashref;
5439 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5440 or die 'guru meditation #4343';
5442 qsearch({ 'table' => 'contact',
5443 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5444 'hashref' => \%hash,
5445 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5446 " cust_contact.custnum = $custnum "
5450 sub process_o2m_qsearchs {
5453 return qsearchs($table, @_) unless $table eq 'contact';
5455 my $hashref = shift;
5456 my %hash = %$hashref;
5457 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5458 or die 'guru meditation #2121';
5460 qsearchs({ 'table' => 'contact',
5461 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5462 'hashref' => \%hash,
5463 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5464 " cust_contact.custnum = $custnum "
5468 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5470 Subroutine (not a method), designed to be called from the queue.
5472 Takes a list of options and values.
5474 Pulls up the customer record via the custnum option and calls bill_and_collect.
5479 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5481 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5482 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5484 #without this errors don't get rolled back
5485 $args{'fatal'} = 1; # runs from job queue, will be caught
5487 $cust_main->bill_and_collect( %args );
5490 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5492 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5493 C<collect> part. This is used in batch tax calculation, where invoice
5494 generation and collection events have to be completely separated.
5498 sub queued_collect {
5500 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5502 $cust_main->collect(%args);
5505 sub process_bill_and_collect {
5508 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5509 or die "custnum '$param->{custnum}' not found!\n";
5510 $param->{'job'} = $job;
5511 $param->{'fatal'} = 1; # runs from job queue, will be caught
5512 $param->{'retry'} = 1;
5515 eval { $cust_main->bill_and_collect( %$param) };
5517 die $@ =~ /cancel_pkgs cannot be run inside a transaction/
5518 ? "Bill Now unavailable for customer with pending package expiration\n"
5523 =item pending_invoice_count
5525 Return number of cust_bill with pending=Y for this customer
5529 sub pending_invoice_count {
5530 FS::cust_bill->count( 'custnum = '.shift->custnum."AND pending = 'Y'" );
5533 =item cust_locations_missing_district
5535 Always returns empty list, unless tax_district_method eq 'wa_sales'
5537 Return cust_location rows for this customer, associated with active
5538 customer packages, where tax district column is empty. Presense of
5539 these rows should block billing, because invoice would be generated
5540 with incorrect taxes
5544 sub cust_locations_missing_district {
5547 my $tax_district_method = FS::Conf->new->config('tax_district_method');
5550 unless $tax_district_method
5551 && $tax_district_method eq 'wa_sales';
5554 table => 'cust_location',
5555 select => 'cust_location.*',
5557 LEFT JOIN cust_main USING (custnum)
5558 LEFT JOIN cust_pkg ON cust_location.locationnum = cust_pkg.locationnum
5560 extra_sql => sprintf(q{
5561 WHERE cust_location.state = 'WA'
5562 AND cust_location.custnum = %s
5564 cust_location.district IS NULL
5565 or cust_location.district = ''
5567 AND cust_pkg.pkgnum IS NOT NULL
5569 cust_pkg.cancel > %s
5570 OR cust_pkg.cancel IS NULL
5573 $self->custnum, time()
5578 #starting to take quite a while for big dbs
5579 # (JRNL: journaled so it only happens once per database)
5580 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5581 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5582 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5583 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5584 # JRNL leading/trailing spaces in first, last, company
5585 # JRNL migrate to cust_payby
5586 # - otaker upgrade? journal and call it good? (double check to make sure
5587 # we're not still setting otaker here)
5589 #only going to get worse with new location stuff...
5591 sub _upgrade_data { #class method
5592 my ($class, %opts) = @_;
5594 my @statements = ();
5596 #this seems to be the only expensive one.. why does it take so long?
5597 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5599 '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';
5600 FS::upgrade_journal->set_done('cust_main__signupdate');
5604 foreach my $sql ( @statements ) {
5605 my $sth = dbh->prepare($sql) or die dbh->errstr;
5606 $sth->execute or die $sth->errstr;
5607 #warn ( (time - $t). " seconds\n" );
5611 local($ignore_expired_card) = 1;
5612 local($ignore_banned_card) = 1;
5613 local($skip_fuzzyfiles) = 1;
5614 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5616 FS::cust_main::Location->_upgrade_data(%opts);
5618 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5620 foreach my $cust_main ( qsearch({
5621 'table' => 'cust_main',
5623 'extra_sql' => 'WHERE '.
5625 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5626 qw( first last company )
5629 my $error = $cust_main->replace;
5630 die $error if $error;
5633 FS::upgrade_journal->set_done('cust_main__trimspaces');
5637 $class->_upgrade_otaker(%opts);
5639 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5640 # existing records will be encrypted in queueable_upgrade (below)
5641 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5642 eval "use FS::Setup";
5644 FS::Setup::enable_encryption();
5649 sub queueable_upgrade {
5652 ### encryption gets turned on in _upgrade_data, above
5654 eval "use FS::upgrade_journal";
5657 # prior to 2013 (commit f16665c9) payinfo was stored in history if not
5658 # encrypted, clear that out before encrypting/tokenizing anything else
5659 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5660 foreach my $table (qw(
5661 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5664 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5665 my $sth = dbh->prepare($sql) or die dbh->errstr;
5666 $sth->execute or die $sth->errstr;
5668 FS::upgrade_journal->set_done('clear_payinfo_history');
5671 # fix Tokenized paycardtype and encrypt old records
5672 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5673 || ! FS::upgrade_journal->is_done('encryption_check')
5677 # allow replacement of closed cust_pay/cust_refund records
5678 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5680 # because it looks like nothing's changing
5681 local $FS::Record::no_update_diff = 1;
5683 # commit everything immediately
5684 local $FS::UID::AutoCommit = 1;
5686 # encrypt what's there
5687 foreach my $table (qw(
5688 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5690 my $tclass = 'FS::'.$table;
5694 my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)
5696 my $record = $tclass->by_key($recnum);
5697 next unless $record; # small chance it's been deleted, that's ok
5698 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5699 # window for possible conflict is practically nonexistant,
5700 # but just in case...
5701 $record = $record->select_for_update;
5702 if (!$record->custnum && $table eq 'cust_pay_pending') {
5703 $record->set('custnum_pending',1);
5705 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5707 local($ignore_expired_card) = 1;
5708 local($ignore_banned_card) = 1;
5709 local($skip_fuzzyfiles) = 1;
5710 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5712 my $error = $record->replace;
5713 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5717 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5718 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5721 # now that everything's encrypted, tokenize...
5722 FS::cust_main::Billing_Realtime::token_check(@_);
5725 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5726 # cust_payby might get deleted while this runs
5728 sub _upgrade_next_recnum {
5729 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5730 my $recnum = shift @$recnums;
5731 return $recnum if $recnum;
5732 my $tclass = 'FS::'.$table;
5733 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5734 my $sql = 'SELECT '.$tclass->primary_key.
5736 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5737 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5738 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5739 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5740 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5741 $sth->execute() or die $sth->errstr;
5743 while (my $rec = $sth->fetchrow_hashref) {
5744 push @$recnums, $rec->{$tclass->primary_key};
5747 $$lastrecnum = $$recnums[-1];
5748 return shift @$recnums;
5757 The delete method should possibly take an FS::cust_main object reference
5758 instead of a scalar customer number.
5760 Bill and collect options should probably be passed as references instead of a
5763 There should probably be a configuration file with a list of allowed credit
5766 No multiple currency support (probably a larger project than just this module).
5768 Birthdates rely on negative epoch values.
5770 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5774 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5775 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5776 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.