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
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
29 use File::Temp; #qw( tempfile );
30 use Business::CreditCard 0.28;
31 use List::Util qw(min);
32 use FS::UID qw( dbh driver_name );
33 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_ps do_print money_pretty card_types );
36 use FS::Msgcat qw(gettext);
43 use FS::cust_bill_void;
44 use FS::legacy_cust_bill;
46 use FS::cust_pay_pending;
47 use FS::cust_pay_void;
48 use FS::cust_pay_batch;
51 use FS::part_referral;
52 use FS::cust_main_county;
53 use FS::cust_location;
56 use FS::cust_main_exemption;
57 use FS::cust_tax_adjustment;
58 use FS::cust_tax_location;
59 use FS::agent_currency;
60 use FS::cust_main_invoice;
62 use FS::prepay_credit;
68 use FS::payment_gateway;
69 use FS::agent_payment_gateway;
71 use FS::cust_main_note;
72 use FS::cust_attachment;
75 use FS::upgrade_journal;
80 # 1 is mostly method/subroutine entry and options
81 # 2 traces progress of some operations
82 # 3 is even more information including possibly sensitive data
84 our $me = '[FS::cust_main]';
87 our $ignore_expired_card = 0;
88 our $ignore_banned_card = 0;
89 our $ignore_invalid_card = 0;
91 our $skip_fuzzyfiles = 0;
93 our $ucfirst_nowarn = 0;
95 #this info is in cust_payby as of 4.x
96 #this and the fields themselves can be removed in 5.x
97 our @encrypted_fields = ('payinfo', 'paycvv');
98 sub nohistory_fields { ('payinfo', 'paycvv'); }
101 #ask FS::UID to run this stuff for us later
102 #$FS::UID::callback{'FS::cust_main'} = sub {
103 install_callback FS::UID sub {
104 $conf = new FS::Conf;
105 #yes, need it for stuff below (prolly should be cached)
106 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 my ( $hashref, $cache ) = @_;
112 if ( exists $hashref->{'pkgnum'} ) {
113 #@{ $self->{'_pkgnum'} } = ();
114 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
115 $self->{'_pkgnum'} = $subcache;
116 #push @{ $self->{'_pkgnum'} },
117 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
123 FS::cust_main - Object methods for cust_main records
129 $record = new FS::cust_main \%hash;
130 $record = new FS::cust_main { 'column' => 'value' };
132 $error = $record->insert;
134 $error = $new_record->replace($old_record);
136 $error = $record->delete;
138 $error = $record->check;
140 @cust_pkg = $record->all_pkgs;
142 @cust_pkg = $record->ncancelled_pkgs;
144 @cust_pkg = $record->suspended_pkgs;
146 $error = $record->bill;
147 $error = $record->bill %options;
148 $error = $record->bill 'time' => $time;
150 $error = $record->collect;
151 $error = $record->collect %options;
152 $error = $record->collect 'invoice_time' => $time,
157 An FS::cust_main object represents a customer. FS::cust_main inherits from
158 FS::Record. The following fields are currently supported:
164 Primary key (assigned automatically for new customers)
168 Agent (see L<FS::agent>)
172 Advertising source (see L<FS::part_referral>)
184 Cocial security number (optional)
208 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
212 Payment Information (See L<FS::payinfo_Mixin> for data format)
216 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
220 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
224 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
228 Start date month (maestro/solo cards only)
232 Start date year (maestro/solo cards only)
236 Issue number (maestro/solo cards only)
240 Name on card or billing name
244 IP address from which payment information was received
248 Tax exempt, empty or `Y'
252 Order taker (see L<FS::access_user>)
258 =item referral_custnum
260 Referring customer number
264 Enable individual CDR spooling, empty or `Y'
268 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
272 Discourage individual CDR printing, empty or `Y'
276 Allow self-service editing of ticket subjects, empty or 'Y'
278 =item calling_list_exempt
280 Do not call, empty or 'Y'
282 =item invoice_ship_address
284 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
294 Creates a new customer. To add the customer to the database, see L<"insert">.
296 Note that this stores the hash reference, not a distinct copy of the hash it
297 points to. You can ask the object for a copy with the I<hash> method.
301 sub table { 'cust_main'; }
303 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
305 Adds this customer to the database. If there is an error, returns the error,
306 otherwise returns false.
308 Usually the customer's location will not yet exist in the database, and
309 the C<bill_location> and C<ship_location> pseudo-fields must be set to
310 uninserted L<FS::cust_location> objects. These will be inserted and linked
311 (in both directions) to the new customer record. If they're references
312 to the same object, they will become the same location.
314 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
315 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
316 are inserted atomicly, or the transaction is rolled back. Passing an empty
317 hash reference is equivalent to not supplying this parameter. There should be
318 a better explanation of this, but until then, here's an example:
321 tie %hash, 'Tie::RefHash'; #this part is important
323 $cust_pkg => [ $svc_acct ],
326 $cust_main->insert( \%hash );
328 INVOICING_LIST_ARYREF: No longer supported.
330 Currently available options are: I<depend_jobnum>, I<noexport>,
331 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
333 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
334 on the supplied jobnum (they will not run until the specific job completes).
335 This can be used to defer provisioning until some action completes (such
336 as running the customer's credit card successfully).
338 The I<noexport> option is deprecated. If I<noexport> is set true, no
339 provisioning jobs (exports) are scheduled. (You can schedule them later with
340 the B<reexport> method.)
342 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
343 of tax names and exemption numbers. FS::cust_main_exemption records will be
344 created and inserted.
346 If I<prospectnum> is set, moves contacts and locations from that prospect.
348 If I<contact> is set to an arrayref of FS::contact objects, those will be
351 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
352 unset), inserts those new contacts with this new customer. Handles CGI
353 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
355 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
356 new stored payment records with this new customer. Handles CGI parameters
357 for an "m2" multiple entry field as passed by edit/cust_main.cgi
363 my $cust_pkgs = @_ ? shift : {};
365 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
366 warn "cust_main::insert using deprecated invoicing list argument";
367 $invoicing_list = shift;
370 warn "$me insert called with options ".
371 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
374 local $SIG{HUP} = 'IGNORE';
375 local $SIG{INT} = 'IGNORE';
376 local $SIG{QUIT} = 'IGNORE';
377 local $SIG{TERM} = 'IGNORE';
378 local $SIG{TSTP} = 'IGNORE';
379 local $SIG{PIPE} = 'IGNORE';
381 my $oldAutoCommit = $FS::UID::AutoCommit;
382 local $FS::UID::AutoCommit = 0;
385 my $prepay_identifier = '';
386 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
388 if ( $self->payby eq 'PREPAY' ) {
390 $self->payby(''); #'BILL');
391 $prepay_identifier = $self->payinfo;
394 warn " looking up prepaid card $prepay_identifier\n"
397 my $error = $self->get_prepay( $prepay_identifier,
398 'amount_ref' => \$amount,
399 'seconds_ref' => \$seconds,
400 'upbytes_ref' => \$upbytes,
401 'downbytes_ref' => \$downbytes,
402 'totalbytes_ref' => \$totalbytes,
405 $dbh->rollback if $oldAutoCommit;
406 #return "error applying prepaid card (transaction rolled back): $error";
410 $payby = 'PREP' if $amount;
412 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
415 $self->payby(''); #'BILL');
416 $amount = $self->paid;
421 foreach my $l (qw(bill_location ship_location)) {
423 my $loc = delete $self->hashref->{$l} or next;
425 if ( !$loc->locationnum ) {
426 # warn the location that we're going to insert it with no custnum
427 $loc->set(custnum_pending => 1);
428 warn " inserting $l\n"
430 my $error = $loc->insert;
432 $dbh->rollback if $oldAutoCommit;
433 my $label = $l eq 'ship_location' ? 'service' : 'billing';
434 return "$error (in $label location)";
437 } elsif ( $loc->prospectnum ) {
439 $loc->prospectnum('');
440 $loc->set(custnum_pending => 1);
441 my $error = $loc->replace;
443 $dbh->rollback if $oldAutoCommit;
444 my $label = $l eq 'ship_location' ? 'service' : 'billing';
445 return "$error (moving $label location)";
448 } elsif ( ($loc->custnum || 0) > 0 ) {
449 # then it somehow belongs to another customer--shouldn't happen
450 $dbh->rollback if $oldAutoCommit;
451 return "$l belongs to customer ".$loc->custnum;
453 # else it already belongs to this customer
454 # (happens when ship_location is identical to bill_location)
456 $self->set($l.'num', $loc->locationnum);
458 if ( $self->get($l.'num') eq '' ) {
459 $dbh->rollback if $oldAutoCommit;
464 warn " inserting $self\n"
467 $self->signupdate(time) unless $self->signupdate;
469 $self->auto_agent_custid()
470 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
472 my $error = $self->check_payinfo_cardtype
473 || $self->SUPER::insert;
475 $dbh->rollback if $oldAutoCommit;
476 #return "inserting cust_main record (transaction rolled back): $error";
480 # now set cust_location.custnum
481 foreach my $l (qw(bill_location ship_location)) {
482 warn " setting $l.custnum\n"
484 my $loc = $self->$l or next;
485 unless ( $loc->custnum ) {
486 $loc->set(custnum => $self->custnum);
487 $error ||= $loc->replace;
491 $dbh->rollback if $oldAutoCommit;
492 return "error setting $l custnum: $error";
496 warn " setting customer tags\n"
499 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
500 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
501 'custnum' => $self->custnum };
502 my $error = $cust_tag->insert;
504 $dbh->rollback if $oldAutoCommit;
509 my $prospectnum = delete $options{'prospectnum'};
510 if ( $prospectnum ) {
512 warn " moving contacts and locations from prospect $prospectnum\n"
516 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
517 unless ( $prospect_main ) {
518 $dbh->rollback if $oldAutoCommit;
519 return "Unknown prospectnum $prospectnum";
521 $prospect_main->custnum($self->custnum);
522 $prospect_main->disabled('Y');
523 my $error = $prospect_main->replace;
525 $dbh->rollback if $oldAutoCommit;
529 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
530 my $cust_contact = new FS::cust_contact {
531 'custnum' => $self->custnum,
532 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
534 my $error = $cust_contact->insert
535 || $prospect_contact->delete;
537 $dbh->rollback if $oldAutoCommit;
542 my @cust_location = $prospect_main->cust_location;
543 my @qual = $prospect_main->qual;
545 foreach my $r ( @cust_location, @qual ) {
547 $r->custnum($self->custnum);
548 my $error = $r->replace;
550 $dbh->rollback if $oldAutoCommit;
557 warn " setting contacts\n"
560 $invoicing_list ||= $options{'invoicing_list'};
561 if ( $invoicing_list ) {
563 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
566 foreach my $dest (@$invoicing_list ) {
567 if ($dest eq 'POST') {
568 $self->set('postal_invoice', 'Y');
571 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
572 if ( $contact_email ) {
573 my $cust_contact = FS::cust_contact->new({
574 contactnum => $contact_email->contactnum,
575 custnum => $self->custnum,
577 $cust_contact->set('invoice_dest', 'Y');
578 my $error = $cust_contact->contactnum ?
579 $cust_contact->replace : $cust_contact->insert;
581 $dbh->rollback if $oldAutoCommit;
582 return "$error (linking to email address $dest)";
586 # this email address is not yet linked to any contact
587 $email .= ',' if length($email);
593 my $contact = FS::contact->new({
594 'custnum' => $self->get('custnum'),
595 'last' => $self->get('last'),
596 'first' => $self->get('first'),
597 'emailaddress' => $email,
598 'invoice_dest' => 'Y', # yes, you can set this via the contact
600 my $error = $contact->insert;
602 $dbh->rollback if $oldAutoCommit;
608 if ( my $contact = delete $options{'contact'} ) {
610 foreach my $c ( @$contact ) {
611 $c->custnum($self->custnum);
612 my $error = $c->insert;
614 $dbh->rollback if $oldAutoCommit;
620 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
622 my $error = $self->process_o2m( 'table' => 'contact',
623 'fields' => FS::contact->cgi_contact_fields,
624 'params' => $contact_params,
627 $dbh->rollback if $oldAutoCommit;
632 warn " setting cust_payby\n"
635 if ( $options{cust_payby} ) {
637 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
638 $cust_payby->custnum($self->custnum);
639 my $error = $cust_payby->insert;
641 $dbh->rollback if $oldAutoCommit;
646 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
648 my $error = $self->process_o2m(
649 'table' => 'cust_payby',
650 'fields' => FS::cust_payby->cgi_cust_payby_fields,
651 'params' => $cust_payby_params,
652 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
655 $dbh->rollback if $oldAutoCommit;
661 warn " setting cust_main_exemption\n"
664 my $tax_exemption = delete $options{'tax_exemption'};
665 if ( $tax_exemption ) {
667 $tax_exemption = { map { $_ => '' } @$tax_exemption }
668 if ref($tax_exemption) eq 'ARRAY';
670 foreach my $taxname ( keys %$tax_exemption ) {
671 my $cust_main_exemption = new FS::cust_main_exemption {
672 'custnum' => $self->custnum,
673 'taxname' => $taxname,
674 'exempt_number' => $tax_exemption->{$taxname},
676 my $error = $cust_main_exemption->insert;
678 $dbh->rollback if $oldAutoCommit;
679 return "inserting cust_main_exemption (transaction rolled back): $error";
684 warn " ordering packages\n"
687 $error = $self->order_pkgs( $cust_pkgs,
689 'seconds_ref' => \$seconds,
690 'upbytes_ref' => \$upbytes,
691 'downbytes_ref' => \$downbytes,
692 'totalbytes_ref' => \$totalbytes,
695 $dbh->rollback if $oldAutoCommit;
700 $dbh->rollback if $oldAutoCommit;
701 return "No svc_acct record to apply pre-paid time";
703 if ( $upbytes || $downbytes || $totalbytes ) {
704 $dbh->rollback if $oldAutoCommit;
705 return "No svc_acct record to apply pre-paid data";
709 warn " inserting initial $payby payment of $amount\n"
711 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
713 $dbh->rollback if $oldAutoCommit;
714 return "inserting payment (transaction rolled back): $error";
718 unless ( $import || $skip_fuzzyfiles ) {
719 warn " queueing fuzzyfiles update\n"
721 $error = $self->queue_fuzzyfiles_update;
723 $dbh->rollback if $oldAutoCommit;
724 return "updating fuzzy search cache: $error";
728 # FS::geocode_Mixin::after_insert or something?
729 if ( $conf->config('tax_district_method') and !$import ) {
730 # if anything non-empty, try to look it up
731 my $queue = new FS::queue {
732 'job' => 'FS::geocode_Mixin::process_district_update',
733 'custnum' => $self->custnum,
735 my $error = $queue->insert( ref($self), $self->custnum );
737 $dbh->rollback if $oldAutoCommit;
738 return "queueing tax district update: $error";
743 warn " exporting\n" if $DEBUG > 1;
745 my $export_args = $options{'export_args'} || [];
748 map qsearch( 'part_export', {exportnum=>$_} ),
749 $conf->config('cust_main-exports'); #, $agentnum
751 foreach my $part_export ( @part_export ) {
752 my $error = $part_export->export_insert($self, @$export_args);
754 $dbh->rollback if $oldAutoCommit;
755 return "exporting to ". $part_export->exporttype.
756 " (transaction rolled back): $error";
760 #foreach my $depend_jobnum ( @$depend_jobnums ) {
761 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
763 # foreach my $jobnum ( @jobnums ) {
764 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
765 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
767 # my $error = $queue->depend_insert($depend_jobnum);
769 # $dbh->rollback if $oldAutoCommit;
770 # return "error queuing job dependancy: $error";
777 #if ( exists $options{'jobnums'} ) {
778 # push @{ $options{'jobnums'} }, @jobnums;
781 warn " insert complete; committing transaction\n"
784 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
789 use File::CounterFile;
790 sub auto_agent_custid {
793 my $format = $conf->config('cust_main-auto_agent_custid');
795 if ( $format eq '1YMMXXXXXXXX' ) {
797 my $counter = new File::CounterFile 'cust_main.agent_custid';
800 my $ym = 100000000000 + time2str('%y%m00000000', time);
801 if ( $ym > $counter->value ) {
802 $counter->{'value'} = $agent_custid = $ym;
803 $counter->{'updated'} = 1;
805 $agent_custid = $counter->inc;
811 die "Unknown cust_main-auto_agent_custid format: $format";
814 $self->agent_custid($agent_custid);
818 =item PACKAGE METHODS
820 Documentation on customer package methods has been moved to
821 L<FS::cust_main::Packages>.
823 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
825 Recharges this (existing) customer with the specified prepaid card (see
826 L<FS::prepay_credit>), specified either by I<identifier> or as an
827 FS::prepay_credit object. If there is an error, returns the error, otherwise
830 Optionally, five scalar references can be passed as well. They will have their
831 values filled in with the amount, number of seconds, and number of upload,
832 download, and total bytes applied by this prepaid card.
836 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
837 #the only place that uses these args
838 sub recharge_prepay {
839 my( $self, $prepay_credit, $amountref, $secondsref,
840 $upbytesref, $downbytesref, $totalbytesref ) = @_;
842 local $SIG{HUP} = 'IGNORE';
843 local $SIG{INT} = 'IGNORE';
844 local $SIG{QUIT} = 'IGNORE';
845 local $SIG{TERM} = 'IGNORE';
846 local $SIG{TSTP} = 'IGNORE';
847 local $SIG{PIPE} = 'IGNORE';
849 my $oldAutoCommit = $FS::UID::AutoCommit;
850 local $FS::UID::AutoCommit = 0;
853 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
855 my $error = $self->get_prepay( $prepay_credit,
856 'amount_ref' => \$amount,
857 'seconds_ref' => \$seconds,
858 'upbytes_ref' => \$upbytes,
859 'downbytes_ref' => \$downbytes,
860 'totalbytes_ref' => \$totalbytes,
862 || $self->increment_seconds($seconds)
863 || $self->increment_upbytes($upbytes)
864 || $self->increment_downbytes($downbytes)
865 || $self->increment_totalbytes($totalbytes)
866 || $self->insert_cust_pay_prepay( $amount,
868 ? $prepay_credit->identifier
873 $dbh->rollback if $oldAutoCommit;
877 if ( defined($amountref) ) { $$amountref = $amount; }
878 if ( defined($secondsref) ) { $$secondsref = $seconds; }
879 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
880 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
881 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
883 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
888 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
890 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
891 specified either by I<identifier> or as an FS::prepay_credit object.
893 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
894 incremented by the values of the prepaid card.
896 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
897 check or set this customer's I<agentnum>.
899 If there is an error, returns the error, otherwise returns false.
905 my( $self, $prepay_credit, %opt ) = @_;
907 local $SIG{HUP} = 'IGNORE';
908 local $SIG{INT} = 'IGNORE';
909 local $SIG{QUIT} = 'IGNORE';
910 local $SIG{TERM} = 'IGNORE';
911 local $SIG{TSTP} = 'IGNORE';
912 local $SIG{PIPE} = 'IGNORE';
914 my $oldAutoCommit = $FS::UID::AutoCommit;
915 local $FS::UID::AutoCommit = 0;
918 unless ( ref($prepay_credit) ) {
920 my $identifier = $prepay_credit;
922 $prepay_credit = qsearchs(
924 { 'identifier' => $identifier },
929 unless ( $prepay_credit ) {
930 $dbh->rollback if $oldAutoCommit;
931 return "Invalid prepaid card: ". $identifier;
936 if ( $prepay_credit->agentnum ) {
937 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
938 $dbh->rollback if $oldAutoCommit;
939 return "prepaid card not valid for agent ". $self->agentnum;
941 $self->agentnum($prepay_credit->agentnum);
944 my $error = $prepay_credit->delete;
946 $dbh->rollback if $oldAutoCommit;
947 return "removing prepay_credit (transaction rolled back): $error";
950 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
951 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
958 =item increment_upbytes SECONDS
960 Updates this customer's single or primary account (see L<FS::svc_acct>) by
961 the specified number of upbytes. If there is an error, returns the error,
962 otherwise returns false.
966 sub increment_upbytes {
967 _increment_column( shift, 'upbytes', @_);
970 =item increment_downbytes SECONDS
972 Updates this customer's single or primary account (see L<FS::svc_acct>) by
973 the specified number of downbytes. If there is an error, returns the error,
974 otherwise returns false.
978 sub increment_downbytes {
979 _increment_column( shift, 'downbytes', @_);
982 =item increment_totalbytes SECONDS
984 Updates this customer's single or primary account (see L<FS::svc_acct>) by
985 the specified number of totalbytes. If there is an error, returns the error,
986 otherwise returns false.
990 sub increment_totalbytes {
991 _increment_column( shift, 'totalbytes', @_);
994 =item increment_seconds SECONDS
996 Updates this customer's single or primary account (see L<FS::svc_acct>) by
997 the specified number of seconds. If there is an error, returns the error,
998 otherwise returns false.
1002 sub increment_seconds {
1003 _increment_column( shift, 'seconds', @_);
1006 =item _increment_column AMOUNT
1008 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1009 the specified number of seconds or bytes. If there is an error, returns
1010 the error, otherwise returns false.
1014 sub _increment_column {
1015 my( $self, $column, $amount ) = @_;
1016 warn "$me increment_column called: $column, $amount\n"
1019 return '' unless $amount;
1021 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1022 $self->ncancelled_pkgs;
1024 if ( ! @cust_pkg ) {
1025 return 'No packages with primary or single services found'.
1026 ' to apply pre-paid time';
1027 } elsif ( scalar(@cust_pkg) > 1 ) {
1028 #maybe have a way to specify the package/account?
1029 return 'Multiple packages found to apply pre-paid time';
1032 my $cust_pkg = $cust_pkg[0];
1033 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1037 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1039 if ( ! @cust_svc ) {
1040 return 'No account found to apply pre-paid time';
1041 } elsif ( scalar(@cust_svc) > 1 ) {
1042 return 'Multiple accounts found to apply pre-paid time';
1045 my $svc_acct = $cust_svc[0]->svc_x;
1046 warn " found service svcnum ". $svc_acct->pkgnum.
1047 ' ('. $svc_acct->email. ")\n"
1050 $column = "increment_$column";
1051 $svc_acct->$column($amount);
1055 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1057 Inserts a prepayment in the specified amount for this customer. An optional
1058 second argument can specify the prepayment identifier for tracking purposes.
1059 If there is an error, returns the error, otherwise returns false.
1063 sub insert_cust_pay_prepay {
1064 shift->insert_cust_pay('PREP', @_);
1067 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1069 Inserts a cash payment in the specified amount for this customer. An optional
1070 second argument can specify the payment identifier for tracking purposes.
1071 If there is an error, returns the error, otherwise returns false.
1075 sub insert_cust_pay_cash {
1076 shift->insert_cust_pay('CASH', @_);
1079 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1081 Inserts a Western Union payment in the specified amount for this customer. An
1082 optional second argument can specify the prepayment identifier for tracking
1083 purposes. If there is an error, returns the error, otherwise returns false.
1087 sub insert_cust_pay_west {
1088 shift->insert_cust_pay('WEST', @_);
1091 sub insert_cust_pay {
1092 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1093 my $payinfo = scalar(@_) ? shift : '';
1095 my $cust_pay = new FS::cust_pay {
1096 'custnum' => $self->custnum,
1097 'paid' => sprintf('%.2f', $amount),
1098 #'_date' => #date the prepaid card was purchased???
1100 'payinfo' => $payinfo,
1106 =item delete [ OPTION => VALUE ... ]
1108 This deletes the customer. If there is an error, returns the error, otherwise
1111 This will completely remove all traces of the customer record. This is not
1112 what you want when a customer cancels service; for that, cancel all of the
1113 customer's packages (see L</cancel>).
1115 If the customer has any uncancelled packages, you need to pass a new (valid)
1116 customer number for those packages to be transferred to, as the "new_customer"
1117 option. Cancelled packages will be deleted. Did I mention that this is NOT
1118 what you want when a customer cancels service and that you really should be
1119 looking at L<FS::cust_pkg/cancel>?
1121 You can't delete a customer with invoices (see L<FS::cust_bill>),
1122 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1123 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1124 set the "delete_financials" option to a true value.
1129 my( $self, %opt ) = @_;
1131 local $SIG{HUP} = 'IGNORE';
1132 local $SIG{INT} = 'IGNORE';
1133 local $SIG{QUIT} = 'IGNORE';
1134 local $SIG{TERM} = 'IGNORE';
1135 local $SIG{TSTP} = 'IGNORE';
1136 local $SIG{PIPE} = 'IGNORE';
1138 my $oldAutoCommit = $FS::UID::AutoCommit;
1139 local $FS::UID::AutoCommit = 0;
1142 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1143 $dbh->rollback if $oldAutoCommit;
1144 return "Can't delete a master agent customer";
1147 #use FS::access_user
1148 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1149 $dbh->rollback if $oldAutoCommit;
1150 return "Can't delete a master employee customer";
1153 tie my %financial_tables, 'Tie::IxHash',
1154 'cust_bill' => 'invoices',
1155 'cust_statement' => 'statements',
1156 'cust_credit' => 'credits',
1157 'cust_pay' => 'payments',
1158 'cust_refund' => 'refunds',
1161 foreach my $table ( keys %financial_tables ) {
1163 my @records = $self->$table();
1165 if ( @records && ! $opt{'delete_financials'} ) {
1166 $dbh->rollback if $oldAutoCommit;
1167 return "Can't delete a customer with ". $financial_tables{$table};
1170 foreach my $record ( @records ) {
1171 my $error = $record->delete;
1173 $dbh->rollback if $oldAutoCommit;
1174 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1180 my @cust_pkg = $self->ncancelled_pkgs;
1182 my $new_custnum = $opt{'new_custnum'};
1183 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1184 $dbh->rollback if $oldAutoCommit;
1185 return "Invalid new customer number: $new_custnum";
1187 foreach my $cust_pkg ( @cust_pkg ) {
1188 my %hash = $cust_pkg->hash;
1189 $hash{'custnum'} = $new_custnum;
1190 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1191 my $error = $new_cust_pkg->replace($cust_pkg,
1192 options => { $cust_pkg->options },
1195 $dbh->rollback if $oldAutoCommit;
1200 my @cancelled_cust_pkg = $self->all_pkgs;
1201 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1202 my $error = $cust_pkg->delete;
1204 $dbh->rollback if $oldAutoCommit;
1209 #cust_tax_adjustment in financials?
1210 #cust_pay_pending? ouch
1211 foreach my $table (qw(
1212 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1213 cust_payby cust_location cust_main_note cust_tax_adjustment
1214 cust_pay_void cust_pay_batch queue cust_tax_exempt
1216 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1217 my $error = $record->delete;
1219 $dbh->rollback if $oldAutoCommit;
1225 my $sth = $dbh->prepare(
1226 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1228 my $errstr = $dbh->errstr;
1229 $dbh->rollback if $oldAutoCommit;
1232 $sth->execute($self->custnum) or do {
1233 my $errstr = $sth->errstr;
1234 $dbh->rollback if $oldAutoCommit;
1240 my $ticket_dbh = '';
1241 if ($conf->config('ticket_system') eq 'RT_Internal') {
1243 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1244 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1245 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1246 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1249 if ( $ticket_dbh ) {
1251 my $ticket_sth = $ticket_dbh->prepare(
1252 'DELETE FROM Links WHERE Target = ?'
1254 my $errstr = $ticket_dbh->errstr;
1255 $dbh->rollback if $oldAutoCommit;
1258 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1260 my $errstr = $ticket_sth->errstr;
1261 $dbh->rollback if $oldAutoCommit;
1265 #check and see if the customer is the only link on the ticket, and
1266 #if so, set the ticket to deleted status in RT?
1267 #maybe someday, for now this will at least fix tickets not displaying
1271 #delete the customer record
1273 my $error = $self->SUPER::delete;
1275 $dbh->rollback if $oldAutoCommit;
1279 # cust_main exports!
1281 #my $export_args = $options{'export_args'} || [];
1284 map qsearch( 'part_export', {exportnum=>$_} ),
1285 $conf->config('cust_main-exports'); #, $agentnum
1287 foreach my $part_export ( @part_export ) {
1288 my $error = $part_export->export_delete( $self ); #, @$export_args);
1290 $dbh->rollback if $oldAutoCommit;
1291 return "exporting to ". $part_export->exporttype.
1292 " (transaction rolled back): $error";
1296 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1301 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1303 Replaces the OLD_RECORD with this one in the database. If there is an error,
1304 returns the error, otherwise returns false.
1306 To change the customer's address, set the pseudo-fields C<bill_location> and
1307 C<ship_location>. The address will still only change if at least one of the
1308 address fields differs from the existing values.
1310 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1311 set as the contact email address for a default contact with the same name as
1314 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1315 I<contact_params>, I<invoicing_list>.
1317 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1318 of tax names and exemption numbers. FS::cust_main_exemption records will be
1319 deleted and inserted as appropriate.
1321 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1322 groups (describing the customer's payment methods and contacts, respectively)
1323 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1324 and L<FS::contact> for the fields these can contain.
1326 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1327 should be used instead if possible.
1334 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1336 : $self->replace_old;
1340 warn "$me replace called\n"
1343 my $curuser = $FS::CurrentUser::CurrentUser;
1344 return "You are not permitted to create complimentary accounts."
1345 if $self->complimentary eq 'Y'
1346 && $self->complimentary ne $old->complimentary
1347 && ! $curuser->access_right('Complimentary customer');
1349 local($ignore_expired_card) = 1
1350 if $old->payby =~ /^(CARD|DCRD)$/
1351 && $self->payby =~ /^(CARD|DCRD)$/
1352 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1354 local($ignore_banned_card) = 1
1355 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1356 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1357 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1359 if ( $self->payby =~ /^(CARD|DCRD)$/
1360 && $old->payinfo ne $self->payinfo
1361 && $old->paymask ne $self->paymask )
1363 my $error = $self->check_payinfo_cardtype;
1364 return $error if $error;
1367 return "Invoicing locale is required"
1370 && $conf->exists('cust_main-require_locale');
1372 local $SIG{HUP} = 'IGNORE';
1373 local $SIG{INT} = 'IGNORE';
1374 local $SIG{QUIT} = 'IGNORE';
1375 local $SIG{TERM} = 'IGNORE';
1376 local $SIG{TSTP} = 'IGNORE';
1377 local $SIG{PIPE} = 'IGNORE';
1379 my $oldAutoCommit = $FS::UID::AutoCommit;
1380 local $FS::UID::AutoCommit = 0;
1383 for my $l (qw(bill_location ship_location)) {
1384 #my $old_loc = $old->$l;
1385 my $new_loc = $self->$l or next;
1387 # find the existing location if there is one
1388 $new_loc->set('custnum' => $self->custnum);
1389 my $error = $new_loc->find_or_insert;
1391 $dbh->rollback if $oldAutoCommit;
1394 $self->set($l.'num', $new_loc->locationnum);
1398 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1399 warn "cust_main::replace: using deprecated invoicing list argument";
1400 $invoicing_list = shift @param;
1403 my %options = @param;
1405 $invoicing_list ||= $options{invoicing_list};
1407 my @contacts = map { $_->contact } $self->cust_contact;
1408 # find a contact that matches the customer's name
1409 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1410 and $_->last eq $old->get('last') }
1412 $implicit_contact ||= FS::contact->new({
1413 'custnum' => $self->custnum,
1414 'locationnum' => $self->get('bill_locationnum'),
1417 # for any of these that are already contact emails, link to the existing
1419 if ( $invoicing_list ) {
1422 # kind of like process_m2m on these, except:
1423 # - the other side is two tables in a join
1424 # - and we might have to create new contact_emails
1425 # - and possibly a new contact
1427 # Find existing invoice emails that aren't on the implicit contact.
1428 # Any of these that are not on the new invoicing list will be removed.
1429 my %old_email_cust_contact;
1430 foreach my $cust_contact ($self->cust_contact) {
1431 next if !$cust_contact->invoice_dest;
1432 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1434 foreach my $contact_email ($cust_contact->contact->contact_email) {
1435 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1439 foreach my $dest (@$invoicing_list) {
1441 if ($dest eq 'POST') {
1443 $self->set('postal_invoice', 'Y');
1445 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1447 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1451 # See if it belongs to some other contact; if so, link it.
1452 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1454 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1455 my $cust_contact = qsearchs('cust_contact', {
1456 contactnum => $contact_email->contactnum,
1457 custnum => $self->custnum,
1458 }) || FS::cust_contact->new({
1459 contactnum => $contact_email->contactnum,
1460 custnum => $self->custnum,
1462 $cust_contact->set('invoice_dest', 'Y');
1463 my $error = $cust_contact->custcontactnum ?
1464 $cust_contact->replace : $cust_contact->insert;
1466 $dbh->rollback if $oldAutoCommit;
1467 return "$error (linking to email address $dest)";
1471 # This email address is not yet linked to any contact, so it will
1472 # be added to the implicit contact.
1473 $email .= ',' if length($email);
1479 foreach my $remove_dest (keys %old_email_cust_contact) {
1480 my $cust_contact = $old_email_cust_contact{$remove_dest};
1481 # These were not in the list of requested destinations, so take them off.
1482 $cust_contact->set('invoice_dest', '');
1483 my $error = $cust_contact->replace;
1485 $dbh->rollback if $oldAutoCommit;
1486 return "$error (unlinking email address $remove_dest)";
1490 # make sure it keeps up with the changed customer name, if any
1491 $implicit_contact->set('last', $self->get('last'));
1492 $implicit_contact->set('first', $self->get('first'));
1493 $implicit_contact->set('emailaddress', $email);
1494 $implicit_contact->set('invoice_dest', 'Y');
1495 $implicit_contact->set('custnum', $self->custnum);
1498 if ( $implicit_contact->contactnum ) {
1499 $error = $implicit_contact->replace;
1500 } elsif ( length($email) ) { # don't create a new contact if not needed
1501 $error = $implicit_contact->insert;
1505 $dbh->rollback if $oldAutoCommit;
1506 return "$error (adding email address $email)";
1511 # replace the customer record
1512 my $error = $self->SUPER::replace($old);
1515 $dbh->rollback if $oldAutoCommit;
1519 # now move packages to the new service location
1520 $self->set('ship_location', ''); #flush cache
1521 if ( $old->ship_locationnum and # should only be null during upgrade...
1522 $old->ship_locationnum != $self->ship_locationnum ) {
1523 $error = $old->ship_location->move_to($self->ship_location);
1525 $dbh->rollback if $oldAutoCommit;
1529 # don't move packages based on the billing location, but
1530 # disable it if it's no longer in use
1531 if ( $old->bill_locationnum and
1532 $old->bill_locationnum != $self->bill_locationnum ) {
1533 $error = $old->bill_location->disable_if_unused;
1535 $dbh->rollback if $oldAutoCommit;
1540 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1542 #this could be more efficient than deleting and re-inserting, if it matters
1543 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1544 my $error = $cust_tag->delete;
1546 $dbh->rollback if $oldAutoCommit;
1550 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1551 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1552 'custnum' => $self->custnum };
1553 my $error = $cust_tag->insert;
1555 $dbh->rollback if $oldAutoCommit;
1562 my $tax_exemption = delete $options{'tax_exemption'};
1563 if ( $tax_exemption ) {
1565 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1566 if ref($tax_exemption) eq 'ARRAY';
1568 my %cust_main_exemption =
1569 map { $_->taxname => $_ }
1570 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1572 foreach my $taxname ( keys %$tax_exemption ) {
1574 if ( $cust_main_exemption{$taxname} &&
1575 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1578 delete $cust_main_exemption{$taxname};
1582 my $cust_main_exemption = new FS::cust_main_exemption {
1583 'custnum' => $self->custnum,
1584 'taxname' => $taxname,
1585 'exempt_number' => $tax_exemption->{$taxname},
1587 my $error = $cust_main_exemption->insert;
1589 $dbh->rollback if $oldAutoCommit;
1590 return "inserting cust_main_exemption (transaction rolled back): $error";
1594 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1595 my $error = $cust_main_exemption->delete;
1597 $dbh->rollback if $oldAutoCommit;
1598 return "deleting cust_main_exemption (transaction rolled back): $error";
1604 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1606 my $error = $self->process_o2m(
1607 'table' => 'cust_payby',
1608 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1609 'params' => $cust_payby_params,
1610 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1613 $dbh->rollback if $oldAutoCommit;
1619 if ( my $contact_params = delete $options{'contact_params'} ) {
1621 # this can potentially replace contacts that were created by the
1622 # invoicing list argument, but the UI shouldn't allow both of them
1625 my $error = $self->process_o2m(
1626 'table' => 'contact',
1627 'fields' => FS::contact->cgi_contact_fields,
1628 'params' => $contact_params,
1631 $dbh->rollback if $oldAutoCommit;
1637 unless ( $import || $skip_fuzzyfiles ) {
1638 $error = $self->queue_fuzzyfiles_update;
1640 $dbh->rollback if $oldAutoCommit;
1641 return "updating fuzzy search cache: $error";
1645 # tax district update in cust_location
1647 # cust_main exports!
1649 my $export_args = $options{'export_args'} || [];
1652 map qsearch( 'part_export', {exportnum=>$_} ),
1653 $conf->config('cust_main-exports'); #, $agentnum
1655 foreach my $part_export ( @part_export ) {
1656 my $error = $part_export->export_replace( $self, $old, @$export_args);
1658 $dbh->rollback if $oldAutoCommit;
1659 return "exporting to ". $part_export->exporttype.
1660 " (transaction rolled back): $error";
1664 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1669 =item queue_fuzzyfiles_update
1671 Used by insert & replace to update the fuzzy search cache
1675 use FS::cust_main::Search;
1676 sub queue_fuzzyfiles_update {
1679 local $SIG{HUP} = 'IGNORE';
1680 local $SIG{INT} = 'IGNORE';
1681 local $SIG{QUIT} = 'IGNORE';
1682 local $SIG{TERM} = 'IGNORE';
1683 local $SIG{TSTP} = 'IGNORE';
1684 local $SIG{PIPE} = 'IGNORE';
1686 my $oldAutoCommit = $FS::UID::AutoCommit;
1687 local $FS::UID::AutoCommit = 0;
1690 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1691 my $queue = new FS::queue {
1692 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1694 my @args = "cust_main.$field", $self->get($field);
1695 my $error = $queue->insert( @args );
1697 $dbh->rollback if $oldAutoCommit;
1698 return "queueing job (transaction rolled back): $error";
1703 push @locations, $self->bill_location if $self->bill_locationnum;
1704 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1705 foreach my $location (@locations) {
1706 my $queue = new FS::queue {
1707 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1709 my @args = 'cust_location.address1', $location->address1;
1710 my $error = $queue->insert( @args );
1712 $dbh->rollback if $oldAutoCommit;
1713 return "queueing job (transaction rolled back): $error";
1717 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1724 Checks all fields to make sure this is a valid customer record. If there is
1725 an error, returns the error, otherwise returns false. Called by the insert
1726 and replace methods.
1733 warn "$me check BEFORE: \n". $self->_dump
1737 $self->ut_numbern('custnum')
1738 || $self->ut_number('agentnum')
1739 || $self->ut_textn('agent_custid')
1740 || $self->ut_number('refnum')
1741 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1742 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1743 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1744 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1745 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1746 || $self->ut_textn('custbatch')
1747 || $self->ut_name('last')
1748 || $self->ut_name('first')
1749 || $self->ut_snumbern('signupdate')
1750 || $self->ut_snumbern('birthdate')
1751 || $self->ut_namen('spouse_last')
1752 || $self->ut_namen('spouse_first')
1753 || $self->ut_snumbern('spouse_birthdate')
1754 || $self->ut_snumbern('anniversary_date')
1755 || $self->ut_textn('company')
1756 || $self->ut_textn('ship_company')
1757 || $self->ut_anything('comments')
1758 || $self->ut_numbern('referral_custnum')
1759 || $self->ut_textn('stateid')
1760 || $self->ut_textn('stateid_state')
1761 || $self->ut_textn('invoice_terms')
1762 || $self->ut_floatn('cdr_termination_percentage')
1763 || $self->ut_floatn('credit_limit')
1764 || $self->ut_numbern('billday')
1765 || $self->ut_numbern('prorate_day')
1766 || $self->ut_flag('edit_subject')
1767 || $self->ut_flag('calling_list_exempt')
1768 || $self->ut_flag('invoice_noemail')
1769 || $self->ut_flag('message_noemail')
1770 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1771 || $self->ut_currencyn('currency')
1772 || $self->ut_alphan('po_number')
1773 || $self->ut_enum('complimentary', [ '', 'Y' ])
1774 || $self->ut_flag('invoice_ship_address')
1775 || $self->ut_flag('invoice_dest')
1778 foreach (qw(company ship_company)) {
1779 my $company = $self->get($_);
1780 $company =~ s/^\s+//;
1781 $company =~ s/\s+$//;
1782 $company =~ s/\s+/ /g;
1783 $self->set($_, $company);
1786 #barf. need message catalogs. i18n. etc.
1787 $error .= "Please select an advertising source."
1788 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1789 return $error if $error;
1791 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1792 or return "Unknown agent";
1794 if ( $self->currency ) {
1795 my $agent_currency = qsearchs( 'agent_currency', {
1796 'agentnum' => $agent->agentnum,
1797 'currency' => $self->currency,
1799 or return "Agent ". $agent->agent.
1800 " not permitted to offer ". $self->currency. " invoicing";
1803 return "Unknown refnum"
1804 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1806 return "Unknown referring custnum: ". $self->referral_custnum
1807 unless ! $self->referral_custnum
1808 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1810 if ( $self->ss eq '' ) {
1815 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1816 or return "Illegal social security number: ". $self->ss;
1817 $self->ss("$1-$2-$3");
1820 #turn off invoice_ship_address if ship & bill are the same
1821 if ($self->bill_locationnum eq $self->ship_locationnum) {
1822 $self->invoice_ship_address('');
1825 # cust_main_county verification now handled by cust_location check
1828 $self->ut_phonen('daytime', $self->country)
1829 || $self->ut_phonen('night', $self->country)
1830 || $self->ut_phonen('fax', $self->country)
1831 || $self->ut_phonen('mobile', $self->country)
1833 return $error if $error;
1835 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1837 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1840 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1842 : FS::Msgcat::_gettext('daytime');
1843 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1845 : FS::Msgcat::_gettext('night');
1847 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1849 : FS::Msgcat::_gettext('mobile');
1851 return "$daytime_label, $night_label or $mobile_label is required"
1855 return "Please select an invoicing locale"
1858 && $conf->exists('cust_main-require_locale');
1860 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1861 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1865 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1867 warn "$me check AFTER: \n". $self->_dump
1870 $self->SUPER::check;
1873 sub check_payinfo_cardtype {
1876 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1878 my $payinfo = $self->payinfo;
1879 $payinfo =~ s/\D//g;
1881 return '' if $payinfo =~ /^99\d{14}$/; #token
1883 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1884 my $cardtype = cardtype($payinfo);
1886 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1894 Additional checks for replace only.
1899 my ($new,$old) = @_;
1900 #preserve old value if global config is set
1901 if ($old && $conf->exists('invoice-ship_address')) {
1902 $new->invoice_ship_address($old->invoice_ship_address);
1909 Returns a list of fields which have ship_ duplicates.
1914 qw( last first company
1916 address1 address2 city county state zip country
1918 daytime night fax mobile
1922 =item has_ship_address
1924 Returns true if this customer record has a separate shipping address.
1928 sub has_ship_address {
1930 $self->bill_locationnum != $self->ship_locationnum;
1935 Returns a list of key/value pairs, with the following keys: address1,
1936 adddress2, city, county, state, zip, country, district, and geocode. The
1937 shipping address is used if present.
1943 $self->ship_location->location_hash;
1948 Returns all locations (see L<FS::cust_location>) for this customer.
1955 'table' => 'cust_location',
1956 'hashref' => { 'custnum' => $self->custnum,
1957 'prospectnum' => '',
1959 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1965 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1971 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1974 =item cust_payby PAYBY
1976 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1978 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1979 Does not validate PAYBY.
1987 'table' => 'cust_payby',
1988 'hashref' => { 'custnum' => $self->custnum },
1989 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
1991 $search->{'extra_sql'} = ' AND payby IN ( ' . join(',', map { dbh->quote($_) } @payby) . ' ) '
1997 =item has_cust_payby_auto
1999 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2003 sub has_cust_payby_auto {
2006 'table' => 'cust_payby',
2007 'hashref' => { 'custnum' => $self->custnum, },
2008 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2009 'order_by' => 'LIMIT 1',
2016 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2017 and L<FS::cust_pkg>) for this customer, except those on hold.
2019 Returns a list: an empty list on success or a list of errors.
2025 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2030 Unsuspends all suspended packages in the on-hold state (those without setup
2031 dates) for this customer.
2037 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2042 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2044 Returns a list: an empty list on success or a list of errors.
2050 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2053 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2055 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2056 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2057 of a list of pkgparts; the hashref has the following keys:
2061 =item pkgparts - listref of pkgparts
2063 =item (other options are passed to the suspend method)
2068 Returns a list: an empty list on success or a list of errors.
2072 sub suspend_if_pkgpart {
2074 my (@pkgparts, %opt);
2075 if (ref($_[0]) eq 'HASH'){
2076 @pkgparts = @{$_[0]{pkgparts}};
2081 grep { $_->suspend(%opt) }
2082 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2083 $self->unsuspended_pkgs;
2086 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2088 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2089 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2090 instead of a list of pkgparts; the hashref has the following keys:
2094 =item pkgparts - listref of pkgparts
2096 =item (other options are passed to the suspend method)
2100 Returns a list: an empty list on success or a list of errors.
2104 sub suspend_unless_pkgpart {
2106 my (@pkgparts, %opt);
2107 if (ref($_[0]) eq 'HASH'){
2108 @pkgparts = @{$_[0]{pkgparts}};
2113 grep { $_->suspend(%opt) }
2114 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2115 $self->unsuspended_pkgs;
2118 =item cancel [ OPTION => VALUE ... ]
2120 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2122 Available options are:
2126 =item quiet - can be set true to supress email cancellation notices.
2128 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2130 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2132 =item nobill - can be set true to skip billing if it might otherwise be done.
2136 Always returns a list: an empty list on success or a list of errors.
2140 # nb that dates are not specified as valid options to this method
2143 my( $self, %opt ) = @_;
2145 warn "$me cancel called on customer ". $self->custnum. " with options ".
2146 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2149 return ( 'access denied' )
2150 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2152 if ( $opt{'ban'} ) {
2154 foreach my $cust_payby ( $self->cust_payby ) {
2156 #well, if they didn't get decrypted on search, then we don't have to
2157 # try again... queue a job for the server that does have decryption
2158 # capability if we're in a paranoid multi-server implementation?
2159 return ( "Can't (yet) ban encrypted credit cards" )
2160 if $cust_payby->is_encrypted($cust_payby->payinfo);
2162 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2163 my $error = $ban->insert;
2164 return ( $error ) if $error;
2170 my @pkgs = $self->ncancelled_pkgs;
2172 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2174 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2175 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2179 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2180 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2183 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2186 sub _banned_pay_hashref {
2187 die 'cust_main->_banned_pay_hashref deprecated';
2199 'payby' => $payby2ban{$self->payby},
2200 'payinfo' => $self->payinfo,
2201 #don't ever *search* on reason! #'reason' =>
2207 Returns all notes (see L<FS::cust_main_note>) for this customer.
2212 my($self,$orderby_classnum) = (shift,shift);
2213 my $orderby = "sticky DESC, _date DESC";
2214 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2215 qsearch( 'cust_main_note',
2216 { 'custnum' => $self->custnum },
2218 "ORDER BY $orderby",
2224 Returns the agent (see L<FS::agent>) for this customer.
2228 Returns the agent name (see L<FS::agent>) for this customer.
2234 $self->agent->agent;
2239 Returns any tags associated with this customer, as FS::cust_tag objects,
2240 or an empty list if there are no tags.
2244 Returns any tags associated with this customer, as FS::part_tag objects,
2245 or an empty list if there are no tags.
2251 map $_->part_tag, $self->cust_tag;
2257 Returns the customer class, as an FS::cust_class object, or the empty string
2258 if there is no customer class.
2262 Returns the customer category name, or the empty string if there is no customer
2269 my $cust_class = $self->cust_class;
2271 ? $cust_class->categoryname
2277 Returns the customer class name, or the empty string if there is no customer
2284 my $cust_class = $self->cust_class;
2286 ? $cust_class->classname
2292 Returns the external tax status, as an FS::tax_status object, or the empty
2293 string if there is no tax status.
2299 if ( $self->taxstatusnum ) {
2300 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2308 Returns the tax status code if there is one.
2314 my $tax_status = $self->tax_status;
2316 ? $tax_status->taxstatus
2320 =item BILLING METHODS
2322 Documentation on billing methods has been moved to
2323 L<FS::cust_main::Billing>.
2325 =item REALTIME BILLING METHODS
2327 Documentation on realtime billing methods has been moved to
2328 L<FS::cust_main::Billing_Realtime>.
2332 Removes the I<paycvv> field from the database directly.
2334 If there is an error, returns the error, otherwise returns false.
2339 die 'cust_main->remove_cvv deprecated';
2341 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2342 or return dbh->errstr;
2343 $sth->execute($self->custnum)
2344 or return $sth->errstr;
2351 Returns the total owed for this customer on all invoices
2352 (see L<FS::cust_bill/owed>).
2358 $self->total_owed_date(2145859200); #12/31/2037
2361 =item total_owed_date TIME
2363 Returns the total owed for this customer on all invoices with date earlier than
2364 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2365 see L<Time::Local> and L<Date::Parse> for conversion functions.
2369 sub total_owed_date {
2373 my $custnum = $self->custnum;
2375 my $owed_sql = FS::cust_bill->owed_sql;
2378 SELECT SUM($owed_sql) FROM cust_bill
2379 WHERE custnum = $custnum
2383 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2387 =item total_owed_pkgnum PKGNUM
2389 Returns the total owed on all invoices for this customer's specific package
2390 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2394 sub total_owed_pkgnum {
2395 my( $self, $pkgnum ) = @_;
2396 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2399 =item total_owed_date_pkgnum TIME PKGNUM
2401 Returns the total owed for this customer's specific package when using
2402 experimental package balances on all invoices with date earlier than
2403 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2404 see L<Time::Local> and L<Date::Parse> for conversion functions.
2408 sub total_owed_date_pkgnum {
2409 my( $self, $time, $pkgnum ) = @_;
2412 foreach my $cust_bill (
2413 grep { $_->_date <= $time }
2414 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2416 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2418 sprintf( "%.2f", $total_bill );
2424 Returns the total amount of all payments.
2431 $total += $_->paid foreach $self->cust_pay;
2432 sprintf( "%.2f", $total );
2435 =item total_unapplied_credits
2437 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2438 customer. See L<FS::cust_credit/credited>.
2440 =item total_credited
2442 Old name for total_unapplied_credits. Don't use.
2446 sub total_credited {
2447 #carp "total_credited deprecated, use total_unapplied_credits";
2448 shift->total_unapplied_credits(@_);
2451 sub total_unapplied_credits {
2454 my $custnum = $self->custnum;
2456 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2459 SELECT SUM($unapplied_sql) FROM cust_credit
2460 WHERE custnum = $custnum
2463 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2467 =item total_unapplied_credits_pkgnum PKGNUM
2469 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2470 customer. See L<FS::cust_credit/credited>.
2474 sub total_unapplied_credits_pkgnum {
2475 my( $self, $pkgnum ) = @_;
2476 my $total_credit = 0;
2477 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2478 sprintf( "%.2f", $total_credit );
2482 =item total_unapplied_payments
2484 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2485 See L<FS::cust_pay/unapplied>.
2489 sub total_unapplied_payments {
2492 my $custnum = $self->custnum;
2494 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2497 SELECT SUM($unapplied_sql) FROM cust_pay
2498 WHERE custnum = $custnum
2501 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2505 =item total_unapplied_payments_pkgnum PKGNUM
2507 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2508 specific package when using experimental package balances. See
2509 L<FS::cust_pay/unapplied>.
2513 sub total_unapplied_payments_pkgnum {
2514 my( $self, $pkgnum ) = @_;
2515 my $total_unapplied = 0;
2516 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2517 sprintf( "%.2f", $total_unapplied );
2521 =item total_unapplied_refunds
2523 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2524 customer. See L<FS::cust_refund/unapplied>.
2528 sub total_unapplied_refunds {
2530 my $custnum = $self->custnum;
2532 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2535 SELECT SUM($unapplied_sql) FROM cust_refund
2536 WHERE custnum = $custnum
2539 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2545 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2546 total_unapplied_credits minus total_unapplied_payments).
2552 $self->balance_date_range;
2555 =item balance_date TIME
2557 Returns the balance for this customer, only considering invoices with date
2558 earlier than TIME (total_owed_date minus total_credited minus
2559 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2560 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2567 $self->balance_date_range(shift);
2570 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2572 Returns the balance for this customer, optionally considering invoices with
2573 date earlier than START_TIME, and not later than END_TIME
2574 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2576 Times are specified as SQL fragments or numeric
2577 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2578 L<Date::Parse> for conversion functions. The empty string can be passed
2579 to disable that time constraint completely.
2581 Accepts the same options as L<balance_date_sql>:
2585 =item unapplied_date
2587 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)
2591 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2592 time will be ignored. Note that START_TIME and END_TIME only limit the date
2593 range for invoices and I<unapplied> payments, credits, and refunds.
2599 sub balance_date_range {
2601 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2602 ') FROM cust_main WHERE custnum='. $self->custnum;
2603 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2606 =item balance_pkgnum PKGNUM
2608 Returns the balance for this customer's specific package when using
2609 experimental package balances (total_owed plus total_unrefunded, minus
2610 total_unapplied_credits minus total_unapplied_payments)
2614 sub balance_pkgnum {
2615 my( $self, $pkgnum ) = @_;
2618 $self->total_owed_pkgnum($pkgnum)
2619 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2620 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2621 - $self->total_unapplied_credits_pkgnum($pkgnum)
2622 - $self->total_unapplied_payments_pkgnum($pkgnum)
2628 Returns a hash of useful information for making a payment.
2638 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2639 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2640 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2644 For credit card transactions:
2656 For electronic check transactions:
2666 #XXX i need to be updated for 4.x+
2672 $return{balance} = $self->balance;
2674 $return{payname} = $self->payname
2675 || ( $self->first. ' '. $self->get('last') );
2677 $return{$_} = $self->bill_location->$_
2678 for qw(address1 address2 city state zip);
2680 $return{payby} = $self->payby;
2681 $return{stateid_state} = $self->stateid_state;
2683 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2684 $return{card_type} = cardtype($self->payinfo);
2685 $return{payinfo} = $self->paymask;
2687 @return{'month', 'year'} = $self->paydate_monthyear;
2691 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2692 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2693 $return{payinfo1} = $payinfo1;
2694 $return{payinfo2} = $payinfo2;
2695 $return{paytype} = $self->paytype;
2696 $return{paystate} = $self->paystate;
2700 #doubleclick protection
2702 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2710 Returns the next payment expiration date for this customer. If they have no
2711 payment methods that will expire, returns 0.
2717 # filter out the ones that individually return 0, but then return 0 if
2718 # there are no results
2719 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2720 min( @epochs ) || 0;
2723 =item paydate_epoch_sql
2725 Returns an SQL expression to get the next payment expiration date for a
2726 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2727 dates, so that it's safe to test for "will it expire before date X" for any
2732 sub paydate_epoch_sql {
2734 my $paydate = FS::cust_payby->paydate_epoch_sql;
2735 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2739 my( $self, $taxname ) = @_;
2741 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2742 'taxname' => $taxname,
2747 =item cust_main_exemption
2749 =item invoicing_list
2751 Returns a list of email addresses (with svcnum entries expanded), and the word
2752 'POST' if the customer receives postal invoices.
2756 sub invoicing_list {
2757 my( $self, $arrayref ) = @_;
2760 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2763 my @emails = $self->invoicing_list_emailonly;
2764 push @emails, 'POST' if $self->get('postal_invoice');
2769 =item check_invoicing_list ARRAYREF
2771 Checks these arguements as valid input for the invoicing_list method. If there
2772 is an error, returns the error, otherwise returns false.
2776 sub check_invoicing_list {
2777 my( $self, $arrayref ) = @_;
2779 foreach my $address ( @$arrayref ) {
2781 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2782 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2785 my $cust_main_invoice = new FS::cust_main_invoice ( {
2786 'custnum' => $self->custnum,
2789 my $error = $self->custnum
2790 ? $cust_main_invoice->check
2791 : $cust_main_invoice->checkdest
2793 return $error if $error;
2797 return "Email address required"
2798 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2799 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2806 Returns the email addresses of all accounts provisioned for this customer.
2813 foreach my $cust_pkg ( $self->all_pkgs ) {
2814 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2816 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2817 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2819 $list{$_}=1 foreach map { $_->email } @svc_acct;
2824 =item invoicing_list_addpost
2826 Adds postal invoicing to this customer. If this customer is already configured
2827 to receive postal invoices, does nothing.
2831 sub invoicing_list_addpost {
2833 if ( $self->get('postal_invoice') eq '' ) {
2834 $self->set('postal_invoice', 'Y');
2835 my $error = $self->replace;
2836 warn $error if $error; # should fail harder, but this is traditional
2840 =item invoicing_list_emailonly
2842 Returns the list of email invoice recipients (invoicing_list without non-email
2843 destinations such as POST and FAX).
2847 sub invoicing_list_emailonly {
2849 warn "$me invoicing_list_emailonly called"
2851 return () if !$self->custnum; # not yet inserted
2852 return map { $_->emailaddress }
2854 table => 'cust_contact',
2855 select => 'emailaddress',
2856 addl_from => ' JOIN contact USING (contactnum) '.
2857 ' JOIN contact_email USING (contactnum)',
2858 hashref => { 'custnum' => $self->custnum, },
2859 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2863 =item invoicing_list_emailonly_scalar
2865 Returns the list of email invoice recipients (invoicing_list without non-email
2866 destinations such as POST and FAX) as a comma-separated scalar.
2870 sub invoicing_list_emailonly_scalar {
2872 warn "$me invoicing_list_emailonly_scalar called"
2874 join(', ', $self->invoicing_list_emailonly);
2877 =item referral_custnum_cust_main
2879 Returns the customer who referred this customer (or the empty string, if
2880 this customer was not referred).
2882 Note the difference with referral_cust_main method: This method,
2883 referral_custnum_cust_main returns the single customer (if any) who referred
2884 this customer, while referral_cust_main returns an array of customers referred
2889 sub referral_custnum_cust_main {
2891 return '' unless $self->referral_custnum;
2892 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
2895 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
2897 Returns an array of customers referred by this customer (referral_custnum set
2898 to this custnum). If DEPTH is given, recurses up to the given depth, returning
2899 customers referred by customers referred by this customer and so on, inclusive.
2900 The default behavior is DEPTH 1 (no recursion).
2902 Note the difference with referral_custnum_cust_main method: This method,
2903 referral_cust_main, returns an array of customers referred BY this customer,
2904 while referral_custnum_cust_main returns the single customer (if any) who
2905 referred this customer.
2909 sub referral_cust_main {
2911 my $depth = @_ ? shift : 1;
2912 my $exclude = @_ ? shift : {};
2915 map { $exclude->{$_->custnum}++; $_; }
2916 grep { ! $exclude->{ $_->custnum } }
2917 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
2921 map { $_->referral_cust_main($depth-1, $exclude) }
2928 =item referral_cust_main_ncancelled
2930 Same as referral_cust_main, except only returns customers with uncancelled
2935 sub referral_cust_main_ncancelled {
2937 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
2940 =item referral_cust_pkg [ DEPTH ]
2942 Like referral_cust_main, except returns a flat list of all unsuspended (and
2943 uncancelled) packages for each customer. The number of items in this list may
2944 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
2948 sub referral_cust_pkg {
2950 my $depth = @_ ? shift : 1;
2952 map { $_->unsuspended_pkgs }
2953 grep { $_->unsuspended_pkgs }
2954 $self->referral_cust_main($depth);
2957 =item referring_cust_main
2959 Returns the single cust_main record for the customer who referred this customer
2960 (referral_custnum), or false.
2964 sub referring_cust_main {
2966 return '' unless $self->referral_custnum;
2967 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
2970 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
2972 Applies a credit to this customer. If there is an error, returns the error,
2973 otherwise returns false.
2975 REASON can be a text string, an FS::reason object, or a scalar reference to
2976 a reasonnum. If a text string, it will be automatically inserted as a new
2977 reason, and a 'reason_type' option must be passed to indicate the
2978 FS::reason_type for the new reason.
2980 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
2981 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
2982 I<commission_pkgnum>.
2984 Any other options are passed to FS::cust_credit::insert.
2989 my( $self, $amount, $reason, %options ) = @_;
2991 my $cust_credit = new FS::cust_credit {
2992 'custnum' => $self->custnum,
2993 'amount' => $amount,
2996 if ( ref($reason) ) {
2998 if ( ref($reason) eq 'SCALAR' ) {
2999 $cust_credit->reasonnum( $$reason );
3001 $cust_credit->reasonnum( $reason->reasonnum );
3005 $cust_credit->set('reason', $reason)
3008 $cust_credit->$_( delete $options{$_} )
3009 foreach grep exists($options{$_}),
3010 qw( addlinfo eventnum ),
3011 map "commission_$_", qw( agentnum salesnum pkgnum );
3013 $cust_credit->insert(%options);
3017 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3019 Creates a one-time charge for this customer. If there is an error, returns
3020 the error, otherwise returns false.
3022 New-style, with a hashref of options:
3024 my $error = $cust_main->charge(
3028 'start_date' => str2time('7/4/2009'),
3029 'pkg' => 'Description',
3030 'comment' => 'Comment',
3031 'additional' => [], #extra invoice detail
3032 'classnum' => 1, #pkg_class
3034 'setuptax' => '', # or 'Y' for tax exempt
3036 'locationnum'=> 1234, # optional
3039 'taxclass' => 'Tax class',
3042 'taxproduct' => 2, #part_pkg_taxproduct
3043 'override' => {}, #XXX describe
3045 #will be filled in with the new object
3046 'cust_pkg_ref' => \$cust_pkg,
3048 #generate an invoice immediately
3050 'invoice_terms' => '', #with these terms
3056 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3060 #super false laziness w/quotation::charge
3063 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3064 my ( $pkg, $comment, $additional );
3065 my ( $setuptax, $taxclass ); #internal taxes
3066 my ( $taxproduct, $override ); #vendor (CCH) taxes
3068 my $separate_bill = '';
3069 my $cust_pkg_ref = '';
3070 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3072 if ( ref( $_[0] ) ) {
3073 $amount = $_[0]->{amount};
3074 $setup_cost = $_[0]->{setup_cost};
3075 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3076 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3077 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3078 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3079 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3080 : '$'. sprintf("%.2f",$amount);
3081 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3082 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3083 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3084 $additional = $_[0]->{additional} || [];
3085 $taxproduct = $_[0]->{taxproductnum};
3086 $override = { '' => $_[0]->{tax_override} };
3087 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3088 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3089 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3090 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3091 $separate_bill = $_[0]->{separate_bill} || '';
3097 $pkg = @_ ? shift : 'One-time charge';
3098 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3100 $taxclass = @_ ? shift : '';
3104 local $SIG{HUP} = 'IGNORE';
3105 local $SIG{INT} = 'IGNORE';
3106 local $SIG{QUIT} = 'IGNORE';
3107 local $SIG{TERM} = 'IGNORE';
3108 local $SIG{TSTP} = 'IGNORE';
3109 local $SIG{PIPE} = 'IGNORE';
3111 my $oldAutoCommit = $FS::UID::AutoCommit;
3112 local $FS::UID::AutoCommit = 0;
3115 my $part_pkg = new FS::part_pkg ( {
3117 'comment' => $comment,
3121 'classnum' => ( $classnum ? $classnum : '' ),
3122 'setuptax' => $setuptax,
3123 'taxclass' => $taxclass,
3124 'taxproductnum' => $taxproduct,
3125 'setup_cost' => $setup_cost,
3128 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3129 ( 0 .. @$additional - 1 )
3131 'additional_count' => scalar(@$additional),
3132 'setup_fee' => $amount,
3135 my $error = $part_pkg->insert( options => \%options,
3136 tax_overrides => $override,
3139 $dbh->rollback if $oldAutoCommit;
3143 my $pkgpart = $part_pkg->pkgpart;
3144 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3145 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3146 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3147 $error = $type_pkgs->insert;
3149 $dbh->rollback if $oldAutoCommit;
3154 my $cust_pkg = new FS::cust_pkg ( {
3155 'custnum' => $self->custnum,
3156 'pkgpart' => $pkgpart,
3157 'quantity' => $quantity,
3158 'start_date' => $start_date,
3159 'no_auto' => $no_auto,
3160 'separate_bill' => $separate_bill,
3161 'locationnum'=> $locationnum,
3164 $error = $cust_pkg->insert;
3166 $dbh->rollback if $oldAutoCommit;
3168 } elsif ( $cust_pkg_ref ) {
3169 ${$cust_pkg_ref} = $cust_pkg;
3173 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3174 'pkg_list' => [ $cust_pkg ],
3177 $dbh->rollback if $oldAutoCommit;
3182 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3187 #=item charge_postal_fee
3189 #Applies a one time charge this customer. If there is an error,
3190 #returns the error, returns the cust_pkg charge object or false
3191 #if there was no charge.
3195 # This should be a customer event. For that to work requires that bill
3196 # also be a customer event.
3198 sub charge_postal_fee {
3201 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3202 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3204 my $cust_pkg = new FS::cust_pkg ( {
3205 'custnum' => $self->custnum,
3206 'pkgpart' => $pkgpart,
3210 my $error = $cust_pkg->insert;
3211 $error ? $error : $cust_pkg;
3214 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3216 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3218 Optionally, a list or hashref of additional arguments to the qsearch call can
3225 my $opt = ref($_[0]) ? shift : { @_ };
3227 #return $self->num_cust_bill unless wantarray || keys %$opt;
3229 $opt->{'table'} = 'cust_bill';
3230 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3231 $opt->{'hashref'}{'custnum'} = $self->custnum;
3232 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3234 map { $_ } #behavior of sort undefined in scalar context
3235 sort { $a->_date <=> $b->_date }
3239 =item open_cust_bill
3241 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3246 sub open_cust_bill {
3250 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3256 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3258 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3262 sub legacy_cust_bill {
3265 #return $self->num_legacy_cust_bill unless wantarray;
3267 map { $_ } #behavior of sort undefined in scalar context
3268 sort { $a->_date <=> $b->_date }
3269 qsearch({ 'table' => 'legacy_cust_bill',
3270 'hashref' => { 'custnum' => $self->custnum, },
3271 'order_by' => 'ORDER BY _date ASC',
3275 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3277 Returns all the statements (see L<FS::cust_statement>) for this customer.
3279 Optionally, a list or hashref of additional arguments to the qsearch call can
3284 =item cust_bill_void
3286 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3290 sub cust_bill_void {
3293 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3294 sort { $a->_date <=> $b->_date }
3295 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3298 sub cust_statement {
3300 my $opt = ref($_[0]) ? shift : { @_ };
3302 #return $self->num_cust_statement unless wantarray || keys %$opt;
3304 $opt->{'table'} = 'cust_statement';
3305 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3306 $opt->{'hashref'}{'custnum'} = $self->custnum;
3307 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3309 map { $_ } #behavior of sort undefined in scalar context
3310 sort { $a->_date <=> $b->_date }
3314 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3316 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3318 Optionally, a list or hashref of additional arguments to the qsearch call can
3319 be passed following the SVCDB.
3326 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3327 warn "$me svc_x requires a svcdb";
3330 my $opt = ref($_[0]) ? shift : { @_ };
3332 $opt->{'table'} = $svcdb;
3333 $opt->{'addl_from'} =
3334 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3335 ($opt->{'addl_from'} || '');
3337 my $custnum = $self->custnum;
3338 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3339 my $where = "cust_pkg.custnum = $custnum";
3341 my $extra_sql = $opt->{'extra_sql'} || '';
3342 if ( keys %{ $opt->{'hashref'} } ) {
3343 $extra_sql = " AND $where $extra_sql";
3346 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3347 $extra_sql = "WHERE $where AND $1";
3350 $extra_sql = "WHERE $where $extra_sql";
3353 $opt->{'extra_sql'} = $extra_sql;
3358 # required for use as an eventtable;
3361 $self->svc_x('svc_acct', @_);
3366 Returns all the credits (see L<FS::cust_credit>) for this customer.
3373 #return $self->num_cust_credit unless wantarray;
3375 map { $_ } #behavior of sort undefined in scalar context
3376 sort { $a->_date <=> $b->_date }
3377 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3380 =item cust_credit_pkgnum
3382 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3383 package when using experimental package balances.
3387 sub cust_credit_pkgnum {
3388 my( $self, $pkgnum ) = @_;
3389 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3390 sort { $a->_date <=> $b->_date }
3391 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3392 'pkgnum' => $pkgnum,
3397 =item cust_credit_void
3399 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3403 sub cust_credit_void {
3406 sort { $a->_date <=> $b->_date }
3407 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3412 Returns all the payments (see L<FS::cust_pay>) for this customer.
3418 my $opt = ref($_[0]) ? shift : { @_ };
3420 return $self->num_cust_pay unless wantarray || keys %$opt;
3422 $opt->{'table'} = 'cust_pay';
3423 $opt->{'hashref'}{'custnum'} = $self->custnum;
3425 map { $_ } #behavior of sort undefined in scalar context
3426 sort { $a->_date <=> $b->_date }
3433 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3434 called automatically when the cust_pay method is used in a scalar context.
3440 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3441 my $sth = dbh->prepare($sql) or die dbh->errstr;
3442 $sth->execute($self->custnum) or die $sth->errstr;
3443 $sth->fetchrow_arrayref->[0];
3446 =item unapplied_cust_pay
3448 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3452 sub unapplied_cust_pay {
3456 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3462 =item cust_pay_pkgnum
3464 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3465 package when using experimental package balances.
3469 sub cust_pay_pkgnum {
3470 my( $self, $pkgnum ) = @_;
3471 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3472 sort { $a->_date <=> $b->_date }
3473 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3474 'pkgnum' => $pkgnum,
3481 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3487 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3488 sort { $a->_date <=> $b->_date }
3489 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3492 =item cust_pay_pending
3494 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3495 (without status "done").
3499 sub cust_pay_pending {
3501 return $self->num_cust_pay_pending unless wantarray;
3502 sort { $a->_date <=> $b->_date }
3503 qsearch( 'cust_pay_pending', {
3504 'custnum' => $self->custnum,
3505 'status' => { op=>'!=', value=>'done' },
3510 =item cust_pay_pending_attempt
3512 Returns all payment attempts / declined payments for this customer, as pending
3513 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3514 a corresponding payment (see L<FS::cust_pay>).
3518 sub cust_pay_pending_attempt {
3520 return $self->num_cust_pay_pending_attempt unless wantarray;
3521 sort { $a->_date <=> $b->_date }
3522 qsearch( 'cust_pay_pending', {
3523 'custnum' => $self->custnum,
3530 =item num_cust_pay_pending
3532 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3533 customer (without status "done"). Also called automatically when the
3534 cust_pay_pending method is used in a scalar context.
3538 sub num_cust_pay_pending {
3541 " SELECT COUNT(*) FROM cust_pay_pending ".
3542 " WHERE custnum = ? AND status != 'done' ",
3547 =item num_cust_pay_pending_attempt
3549 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3550 customer, with status "done" but without a corresp. Also called automatically when the
3551 cust_pay_pending method is used in a scalar context.
3555 sub num_cust_pay_pending_attempt {
3558 " SELECT COUNT(*) FROM cust_pay_pending ".
3559 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3566 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3572 map { $_ } #return $self->num_cust_refund unless wantarray;
3573 sort { $a->_date <=> $b->_date }
3574 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3577 =item display_custnum
3579 Returns the displayed customer number for this customer: agent_custid if
3580 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3584 sub display_custnum {
3587 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3588 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3589 if ( $special eq 'CoStAg' ) {
3590 $prefix = uc( join('',
3592 ($self->state =~ /^(..)/),
3593 $prefix || ($self->agent->agent =~ /^(..)/)
3596 elsif ( $special eq 'CoStCl' ) {
3597 $prefix = uc( join('',
3599 ($self->state =~ /^(..)/),
3600 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3603 # add any others here if needed
3606 my $length = $conf->config('cust_main-custnum-display_length');
3607 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3608 return $self->agent_custid;
3609 } elsif ( $prefix ) {
3610 $length = 8 if !defined($length);
3612 sprintf('%0'.$length.'d', $self->custnum)
3613 } elsif ( $length ) {
3614 return sprintf('%0'.$length.'d', $self->custnum);
3616 return $self->custnum;
3622 Returns a name string for this customer, either "Company (Last, First)" or
3629 my $name = $self->contact;
3630 $name = $self->company. " ($name)" if $self->company;
3634 =item service_contact
3636 Returns the L<FS::contact> object for this customer that has the 'Service'
3637 contact class, or undef if there is no such contact. Deprecated; don't use
3642 sub service_contact {
3644 if ( !exists($self->{service_contact}) ) {
3645 my $classnum = $self->scalar_sql(
3646 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3647 ) || 0; #if it's zero, qsearchs will return nothing
3648 my $cust_contact = qsearchs('cust_contact', {
3649 'classnum' => $classnum,
3650 'custnum' => $self->custnum,
3652 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3654 $self->{service_contact};
3659 Returns a name string for this (service/shipping) contact, either
3660 "Company (Last, First)" or "Last, First".
3667 my $name = $self->ship_contact;
3668 $name = $self->company. " ($name)" if $self->company;
3674 Returns a name string for this customer, either "Company" or "First Last".
3680 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3683 =item ship_name_short
3685 Returns a name string for this (service/shipping) contact, either "Company"
3690 sub ship_name_short {
3692 $self->service_contact
3693 ? $self->ship_contact_firstlast
3699 Returns this customer's full (billing) contact name only, "Last, First"
3705 $self->get('last'). ', '. $self->first;
3710 Returns this customer's full (shipping) contact name only, "Last, First"
3716 my $contact = $self->service_contact || $self;
3717 $contact->get('last') . ', ' . $contact->get('first');
3720 =item contact_firstlast
3722 Returns this customers full (billing) contact name only, "First Last".
3726 sub contact_firstlast {
3728 $self->first. ' '. $self->get('last');
3731 =item ship_contact_firstlast
3733 Returns this customer's full (shipping) contact name only, "First Last".
3737 sub ship_contact_firstlast {
3739 my $contact = $self->service_contact || $self;
3740 $contact->get('first') . ' '. $contact->get('last');
3743 sub bill_country_full {
3745 $self->bill_location->country_full;
3748 sub ship_country_full {
3750 $self->ship_location->country_full;
3753 =item county_state_county [ PREFIX ]
3755 Returns a string consisting of just the county, state and country.
3759 sub county_state_country {
3762 if ( @_ && $_[0] && $self->has_ship_address ) {
3763 $locationnum = $self->ship_locationnum;
3765 $locationnum = $self->bill_locationnum;
3767 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3768 $cust_location->county_state_country;
3771 =item geocode DATA_VENDOR
3773 Returns a value for the customer location as encoded by DATA_VENDOR.
3774 Currently this only makes sense for "CCH" as DATA_VENDOR.
3782 Returns a status string for this customer, currently:
3788 No packages have ever been ordered. Displayed as "No packages".
3792 Recurring packages all are new (not yet billed).
3796 One or more recurring packages is active.
3800 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3804 All non-cancelled recurring packages are suspended.
3808 All recurring packages are cancelled.
3812 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3813 cust_main-status_module configuration option.
3817 sub status { shift->cust_status(@_); }
3821 for my $status ( FS::cust_main->statuses() ) {
3822 my $method = $status.'_sql';
3823 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3824 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3825 $sth->execute( ($self->custnum) x $numnum )
3826 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3827 return $status if $sth->fetchrow_arrayref->[0];
3831 =item is_status_delay_cancel
3833 Returns true if customer status is 'suspended'
3834 and all suspended cust_pkg return true for
3835 cust_pkg->is_status_delay_cancel.
3837 This is not a real status, this only meant for hacking display
3838 values, because otherwise treating the customer as suspended is
3839 really the whole point of the delay_cancel option.
3843 sub is_status_delay_cancel {
3845 return 0 unless $self->status eq 'suspended';
3846 foreach my $cust_pkg ($self->ncancelled_pkgs) {
3847 return 0 unless $cust_pkg->is_status_delay_cancel;
3852 =item ucfirst_cust_status
3854 =item ucfirst_status
3856 Deprecated, use the cust_status_label method instead.
3858 Returns the status with the first character capitalized.
3862 sub ucfirst_status {
3863 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3864 local($ucfirst_nowarn) = 1;
3865 shift->ucfirst_cust_status(@_);
3868 sub ucfirst_cust_status {
3869 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3871 ucfirst($self->cust_status);
3874 =item cust_status_label
3878 Returns the display label for this status.
3882 sub status_label { shift->cust_status_label(@_); }
3884 sub cust_status_label {
3886 __PACKAGE__->statuslabels->{$self->cust_status};
3891 Returns a hex triplet color string for this customer's status.
3895 sub statuscolor { shift->cust_statuscolor(@_); }
3897 sub cust_statuscolor {
3899 __PACKAGE__->statuscolors->{$self->cust_status};
3902 =item tickets [ STATUS ]
3904 Returns an array of hashes representing the customer's RT tickets.
3906 An optional status (or arrayref or hashref of statuses) may be specified.
3912 my $status = ( @_ && $_[0] ) ? shift : '';
3914 my $num = $conf->config('cust_main-max_tickets') || 10;
3917 if ( $conf->config('ticket_system') ) {
3918 unless ( $conf->config('ticket_system-custom_priority_field') ) {
3920 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
3929 foreach my $priority (
3930 $conf->config('ticket_system-custom_priority_field-values'), ''
3932 last if scalar(@tickets) >= $num;
3934 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3935 $num - scalar(@tickets),
3946 =item appointments [ STATUS ]
3948 Returns an array of hashes representing the customer's RT tickets which
3955 my $status = ( @_ && $_[0] ) ? shift : '';
3957 return () unless $conf->config('ticket_system');
3959 my $queueid = $conf->config('ticket_system-appointment-queueid');
3961 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3970 # Return services representing svc_accts in customer support packages
3971 sub support_services {
3973 my %packages = map { $_ => 1 } $conf->config('support_packages');
3975 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
3976 grep { $_->part_svc->svcdb eq 'svc_acct' }
3977 map { $_->cust_svc }
3978 grep { exists $packages{ $_->pkgpart } }
3979 $self->ncancelled_pkgs;
3983 # Return a list of latitude/longitude for one of the services (if any)
3984 sub service_coordinates {
3988 grep { $_->latitude && $_->longitude }
3990 map { $_->cust_svc }
3991 $self->ncancelled_pkgs;
3993 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
3998 Returns a masked version of the named field
4003 my ($self,$field) = @_;
4007 'x'x(length($self->getfield($field))-4).
4008 substr($self->getfield($field), (length($self->getfield($field))-4));
4012 =item payment_history
4014 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4015 cust_credit and cust_refund objects. Each hashref has the following fields:
4017 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4019 I<date> - value of _date field, unix timestamp
4021 I<date_pretty> - user-friendly date
4023 I<description> - user-friendly description of item
4025 I<amount> - impact of item on user's balance
4026 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4027 Not to be confused with the native 'amount' field in cust_credit, see below.
4029 I<amount_pretty> - includes money char
4031 I<balance> - customer balance, chronologically as of this item
4033 I<balance_pretty> - includes money char
4035 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4037 I<paid> - amount paid for cust_pay records, undef for other types
4039 I<credit> - amount credited for cust_credit records, undef for other types.
4040 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4042 I<refund> - amount refunded for cust_refund records, undef for other types
4044 The four table-specific keys always have positive values, whether they reflect charges or payments.
4046 The following options may be passed to this method:
4048 I<line_items> - if true, returns charges ('Line item') rather than invoices
4050 I<start_date> - unix timestamp, only include records on or after.
4051 If specified, an item of type 'Previous' will also be included.
4052 It does not have table-specific fields.
4054 I<end_date> - unix timestamp, only include records before
4056 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4058 I<conf> - optional already-loaded FS::Conf object.
4062 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4063 # and also for sending customer statements, which should both be kept customer-friendly.
4064 # If you add anything that shouldn't be passed on through the API or exposed
4065 # to customers, add a new option to include it, don't include it by default
4066 sub payment_history {
4068 my $opt = ref($_[0]) ? $_[0] : { @_ };
4070 my $conf = $$opt{'conf'} || new FS::Conf;
4071 my $money_char = $conf->config("money_char") || '$',
4073 #first load entire history,
4074 #need previous to calculate previous balance
4075 #loading after end_date shouldn't hurt too much?
4077 if ( $$opt{'line_items'} ) {
4079 foreach my $cust_bill ( $self->cust_bill ) {
4082 'type' => 'Line item',
4083 'description' => $_->desc( $self->locale ).
4084 ( $_->sdate && $_->edate
4085 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4086 ' To '. time2str('%d-%b-%Y', $_->edate)
4089 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4090 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4091 'date' => $cust_bill->_date,
4092 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4094 foreach $cust_bill->cust_bill_pkg;
4101 'type' => 'Invoice',
4102 'description' => 'Invoice #'. $_->display_invnum,
4103 'amount' => sprintf('%.2f', $_->charged ),
4104 'charged' => sprintf('%.2f', $_->charged ),
4105 'date' => $_->_date,
4106 'date_pretty' => $self->time2str_local('short', $_->_date ),
4108 foreach $self->cust_bill;
4113 'type' => 'Payment',
4114 'description' => 'Payment', #XXX type
4115 'amount' => sprintf('%.2f', 0 - $_->paid ),
4116 'paid' => sprintf('%.2f', $_->paid ),
4117 'date' => $_->_date,
4118 'date_pretty' => $self->time2str_local('short', $_->_date ),
4120 foreach $self->cust_pay;
4124 'description' => 'Credit', #more info?
4125 'amount' => sprintf('%.2f', 0 -$_->amount ),
4126 'credit' => sprintf('%.2f', $_->amount ),
4127 'date' => $_->_date,
4128 'date_pretty' => $self->time2str_local('short', $_->_date ),
4130 foreach $self->cust_credit;
4134 'description' => 'Refund', #more info? type, like payment?
4135 'amount' => $_->refund,
4136 'refund' => $_->refund,
4137 'date' => $_->_date,
4138 'date_pretty' => $self->time2str_local('short', $_->_date ),
4140 foreach $self->cust_refund;
4142 #put it all in chronological order
4143 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4145 #calculate balance, filter items outside date range
4149 foreach my $item (@history) {
4150 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4151 $balance += $$item{'amount'};
4152 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4153 $previous += $$item{'amount'};
4156 $$item{'balance'} = sprintf("%.2f",$balance);
4157 foreach my $key ( qw(amount balance) ) {
4158 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4163 # start with previous balance, if there was one
4166 'type' => 'Previous',
4167 'description' => 'Previous balance',
4168 'amount' => sprintf("%.2f",$previous),
4169 'balance' => sprintf("%.2f",$previous),
4170 'date' => $$opt{'start_date'},
4171 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4173 #false laziness with above
4174 foreach my $key ( qw(amount balance) ) {
4175 $$item{$key.'_pretty'} = $$item{$key};
4176 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4178 unshift(@out,$item);
4181 @out = reverse @history if $$opt{'reverse_sort'};
4186 =item save_cust_payby
4188 Saves a new cust_payby for this customer, replacing an existing entry only
4189 in select circumstances. Does not validate input.
4191 If auto is specified, marks this as the customer's primary method, or the
4192 specified weight. Existing payment methods have their weight incremented as
4195 If bill_location is specified with auto, also sets location in cust_main.
4197 Will not insert complete duplicates of existing records, or records in which the
4198 only difference from an existing record is to turn off automatic payment (will
4199 return without error.) Will replace existing records in which the only difference
4200 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4201 Fields marked as preserved are optional, and existing values will not be overwritten with
4202 blanks when replacing.
4204 Accepts the following named parameters:
4214 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4218 optional, set higher than 1 for secondary, etc.
4226 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4234 optional, will be preserved when replacing
4242 CARD only, required, FS::cust_location object
4244 =item paystart_month
4246 CARD only, optional, will be preserved when replacing
4250 CARD only, optional, will be preserved when replacing
4254 CARD only, optional, will be preserved when replacing
4258 CARD only, only used if conf cvv-save is set appropriately
4272 #The code for this option is in place, but it's not currently used
4276 # existing cust_payby object to be replaced (must match custnum)
4278 # stateid/stateid_state/ss are not currently supported in cust_payby,
4279 # might not even work properly in 4.x, but will need to work here if ever added
4281 sub save_cust_payby {
4285 my $old = $opt{'replace'};
4286 my $new = new FS::cust_payby { $old ? $old->hash : () };
4287 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4288 $new->set( 'custnum' => $self->custnum );
4290 my $payby = $opt{'payment_payby'};
4291 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4293 # don't allow turning off auto when replacing
4294 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4296 my @check_existing; # payby relevant to this payment_payby
4298 # set payby based on auto
4299 if ( $payby eq 'CARD' ) {
4300 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4301 @check_existing = qw( CARD DCRD );
4302 } elsif ( $payby eq 'CHEK' ) {
4303 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4304 @check_existing = qw( CHEK DCHK );
4307 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4310 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4311 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4312 $new->set( 'payname' => $opt{'payname'} );
4313 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4315 my $conf = new FS::Conf;
4317 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4318 if ( $payby eq 'CARD' &&
4319 grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save') ) {
4320 $new->set( 'paycvv' => $opt{'paycvv'} );
4322 $new->set( 'paycvv' => '');
4325 local $SIG{HUP} = 'IGNORE';
4326 local $SIG{INT} = 'IGNORE';
4327 local $SIG{QUIT} = 'IGNORE';
4328 local $SIG{TERM} = 'IGNORE';
4329 local $SIG{TSTP} = 'IGNORE';
4330 local $SIG{PIPE} = 'IGNORE';
4332 my $oldAutoCommit = $FS::UID::AutoCommit;
4333 local $FS::UID::AutoCommit = 0;
4336 # set fields specific to payment_payby
4337 if ( $payby eq 'CARD' ) {
4338 if ($opt{'bill_location'}) {
4339 $opt{'bill_location'}->set('custnum' => $self->custnum);
4340 my $error = $opt{'bill_location'}->find_or_insert;
4342 $dbh->rollback if $oldAutoCommit;
4345 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4347 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4348 $new->set( $field => $opt{$field} );
4351 foreach my $field ( qw(paytype paystate) ) {
4352 $new->set( $field => $opt{$field} );
4356 # other cust_payby to compare this to
4357 my @existing = $self->cust_payby(@check_existing);
4359 # fields that can overwrite blanks with values, but not values with blanks
4360 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4362 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4364 # generally, we don't want to overwrite existing cust_payby with this,
4365 # but we can replace if we're only marking it auto or adding a preserved field
4366 # and we can avoid saving a total duplicate or merely turning off auto
4368 foreach my $cust_payby (@existing) {
4369 # check fields that absolutely should not change
4370 foreach my $field ($new->fields) {
4371 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4372 next if grep(/^$field$/, @preserve );
4373 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4375 # now check fields that can replace if one value is blank
4377 foreach my $field (@preserve) {
4379 ( $new->get($field) and !$cust_payby->get($field) ) or
4380 ( $cust_payby->get($field) and !$new->get($field) )
4382 # prevention of overwriting values with blanks happens farther below
4384 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4388 unless ( $replace ) {
4389 # nearly identical, now check weight
4390 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4391 # ignore identical cust_payby, and ignore attempts to turn off auto
4392 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4393 $skip_cust_payby = 1;
4396 # otherwise, only change is to mark this as primary
4398 # if we got this far, we're definitely replacing
4405 $new->set( 'custpaybynum' => $old->custpaybynum );
4406 # don't turn off automatic payment (but allow it to be turned on)
4407 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4409 $new->set( 'payby' => $old->payby );
4410 $new->set( 'weight' => 1 );
4412 # make sure we're not overwriting values with blanks
4413 foreach my $field (@preserve) {
4414 if ( $old->get($field) and !$new->get($field) ) {
4415 $new->set( $field => $old->get($field) );
4420 # only overwrite cust_main bill_location if auto
4421 if ($opt{'auto'} && $opt{'bill_location'}) {
4422 $self->set('bill_location' => $opt{'bill_location'});
4423 my $error = $self->replace;
4425 $dbh->rollback if $oldAutoCommit;
4430 # done with everything except reweighting and saving cust_payby
4431 # still need to commit changes to cust_main and cust_location
4432 if ($skip_cust_payby) {
4433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4437 # re-weight existing primary cust_pay for this payby
4439 foreach my $cust_payby (@existing) {
4440 # relies on cust_payby return order
4441 last unless $cust_payby->payby !~ /^D/;
4442 last if $cust_payby->weight > 1;
4443 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4444 next if $cust_payby->weight < ($opt{'weight'} || 1);
4445 $cust_payby->weight( $cust_payby->weight + 1 );
4446 my $error = $cust_payby->replace;
4448 $dbh->rollback if $oldAutoCommit;
4449 return "Error reweighting cust_payby: $error";
4454 # finally, save cust_payby
4455 my $error = $old ? $new->replace($old) : $new->insert;
4457 $dbh->rollback if $oldAutoCommit;
4461 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4468 =head1 CLASS METHODS
4474 Class method that returns the list of possible status strings for customers
4475 (see L<the status method|/status>). For example:
4477 @statuses = FS::cust_main->statuses();
4483 keys %{ $self->statuscolors };
4486 =item cust_status_sql
4488 Returns an SQL fragment to determine the status of a cust_main record, as a
4493 sub cust_status_sql {
4495 for my $status ( FS::cust_main->statuses() ) {
4496 my $method = $status.'_sql';
4497 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4506 Returns an SQL expression identifying prospective cust_main records (customers
4507 with no packages ever ordered)
4511 use vars qw($select_count_pkgs);
4512 $select_count_pkgs =
4513 "SELECT COUNT(*) FROM cust_pkg
4514 WHERE cust_pkg.custnum = cust_main.custnum";
4516 sub select_count_pkgs_sql {
4521 " 0 = ( $select_count_pkgs ) ";
4526 Returns an SQL expression identifying ordered cust_main records (customers with
4527 no active packages, but recurring packages not yet setup or one time charges
4533 FS::cust_main->none_active_sql.
4534 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4539 Returns an SQL expression identifying active cust_main records (customers with
4540 active recurring packages).
4545 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4548 =item none_active_sql
4550 Returns an SQL expression identifying cust_main records with no active
4551 recurring packages. This includes customers of status prospect, ordered,
4552 inactive, and suspended.
4556 sub none_active_sql {
4557 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4562 Returns an SQL expression identifying inactive cust_main records (customers with
4563 no active recurring packages, but otherwise unsuspended/uncancelled).
4568 FS::cust_main->none_active_sql.
4569 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4575 Returns an SQL expression identifying suspended cust_main records.
4580 sub suspended_sql { susp_sql(@_); }
4582 FS::cust_main->none_active_sql.
4583 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4589 Returns an SQL expression identifying cancelled cust_main records.
4593 sub cancel_sql { shift->cancelled_sql(@_); }
4596 =item uncancelled_sql
4598 Returns an SQL expression identifying un-cancelled cust_main records.
4602 sub uncancelled_sql { uncancel_sql(@_); }
4603 sub uncancel_sql { "
4604 ( 0 < ( $select_count_pkgs
4605 AND ( cust_pkg.cancel IS NULL
4606 OR cust_pkg.cancel = 0
4609 OR 0 = ( $select_count_pkgs )
4615 Returns an SQL fragment to retreive the balance.
4620 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4621 WHERE cust_bill.custnum = cust_main.custnum )
4622 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4623 WHERE cust_pay.custnum = cust_main.custnum )
4624 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4625 WHERE cust_credit.custnum = cust_main.custnum )
4626 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4627 WHERE cust_refund.custnum = cust_main.custnum )
4630 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4632 Returns an SQL fragment to retreive the balance for this customer, optionally
4633 considering invoices with date earlier than START_TIME, and not
4634 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4635 total_unapplied_payments).
4637 Times are specified as SQL fragments or numeric
4638 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4639 L<Date::Parse> for conversion functions. The empty string can be passed
4640 to disable that time constraint completely.
4642 Available options are:
4646 =item unapplied_date
4648 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)
4653 set to true to remove all customer comparison clauses, for totals
4658 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4663 JOIN clause (typically used with the total option)
4667 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4668 time will be ignored. Note that START_TIME and END_TIME only limit the date
4669 range for invoices and I<unapplied> payments, credits, and refunds.
4675 sub balance_date_sql {
4676 my( $class, $start, $end, %opt ) = @_;
4678 my $cutoff = $opt{'cutoff'};
4680 my $owed = FS::cust_bill->owed_sql($cutoff);
4681 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4682 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4683 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4685 my $j = $opt{'join'} || '';
4687 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4688 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4689 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4690 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4692 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4693 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4694 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4695 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4700 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4702 Returns an SQL fragment to retreive the total unapplied payments for this
4703 customer, only considering payments with date earlier than START_TIME, and
4704 optionally not later than END_TIME.
4706 Times are specified as SQL fragments or numeric
4707 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4708 L<Date::Parse> for conversion functions. The empty string can be passed
4709 to disable that time constraint completely.
4711 Available options are:
4715 sub unapplied_payments_date_sql {
4716 my( $class, $start, $end, %opt ) = @_;
4718 my $cutoff = $opt{'cutoff'};
4720 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4722 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4723 'unapplied_date'=>1 );
4725 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4728 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4730 Helper method for balance_date_sql; name (and usage) subject to change
4731 (suggestions welcome).
4733 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4734 cust_refund, cust_credit or cust_pay).
4736 If TABLE is "cust_bill" or the unapplied_date option is true, only
4737 considers records with date earlier than START_TIME, and optionally not
4738 later than END_TIME .
4742 sub _money_table_where {
4743 my( $class, $table, $start, $end, %opt ) = @_;
4746 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4747 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4748 push @where, "$table._date <= $start" if defined($start) && length($start);
4749 push @where, "$table._date > $end" if defined($end) && length($end);
4751 push @where, @{$opt{'where'}} if $opt{'where'};
4752 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4758 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4759 use FS::cust_main::Search;
4762 FS::cust_main::Search->search(@_);
4771 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4773 Generates a templated notification to the customer (see L<Text::Template>).
4775 OPTIONS is a hash and may include
4777 I<extra_fields> - a hashref of name/value pairs which will be substituted
4778 into the template. These values may override values mentioned below
4779 and those from the customer record.
4781 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4783 The following variables are available in the template instead of or in addition
4784 to the fields of the customer record.
4786 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4790 # a lot like cust_bill::print_latex
4791 sub generate_letter {
4792 my ($self, $template, %options) = @_;
4794 warn "Template $template does not exist" && return
4795 unless $conf->exists($template) || $options{'template_text'};
4797 my $template_source = $options{'template_text'}
4798 ? [ $options{'template_text'} ]
4799 : [ map "$_\n", $conf->config($template) ];
4801 my $letter_template = new Text::Template
4803 SOURCE => $template_source,
4804 DELIMITERS => [ '[@--', '--@]' ],
4806 or die "can't create new Text::Template object: Text::Template::ERROR";
4808 $letter_template->compile()
4809 or die "can't compile template: Text::Template::ERROR";
4811 my %letter_data = map { $_ => $self->$_ } $self->fields;
4813 for (keys %{$options{extra_fields}}){
4814 $letter_data{$_} = $options{extra_fields}->{$_};
4817 unless(exists($letter_data{returnaddress})){
4818 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4819 $self->agent_template)
4821 if ( length($retadd) ) {
4822 $letter_data{returnaddress} = $retadd;
4823 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4824 $letter_data{returnaddress} =
4825 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4829 ( $conf->config('company_name', $self->agentnum),
4830 $conf->config('company_address', $self->agentnum),
4834 $letter_data{returnaddress} = '~';
4838 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4840 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4842 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4844 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4848 ) or die "can't open temp file: $!\n";
4849 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4850 or die "can't write temp file: $!\n";
4852 $letter_data{'logo_file'} = $lh->filename;
4854 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4858 ) or die "can't open temp file: $!\n";
4860 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4862 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4863 return ($1, $letter_data{'logo_file'});
4867 =item print_ps TEMPLATE
4869 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4875 my($file, $lfile) = $self->generate_letter(@_);
4876 my $ps = FS::Misc::generate_ps($file);
4877 unlink($file.'.tex');
4883 =item print TEMPLATE
4885 Prints the filled in template.
4887 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4891 sub queueable_print {
4894 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4895 or die "invalid customer number: " . $opt{custnum};
4897 #do not backport this change to 3.x
4898 # my $error = $self->print( { 'template' => $opt{template} } );
4899 my $error = $self->print( $opt{'template'} );
4900 die $error if $error;
4904 my ($self, $template) = (shift, shift);
4906 [ $self->print_ps($template) ],
4907 'agentnum' => $self->agentnum,
4911 #these three subs should just go away once agent stuff is all config overrides
4913 sub agent_template {
4915 $self->_agent_plandata('agent_templatename');
4918 sub agent_invoice_from {
4920 $self->_agent_plandata('agent_invoice_from');
4923 sub _agent_plandata {
4924 my( $self, $option ) = @_;
4926 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4927 #agent-specific Conf
4929 use FS::part_event::Condition;
4931 my $agentnum = $self->agentnum;
4933 my $regexp = regexp_sql();
4935 my $part_event_option =
4937 'select' => 'part_event_option.*',
4938 'table' => 'part_event_option',
4940 LEFT JOIN part_event USING ( eventpart )
4941 LEFT JOIN part_event_option AS peo_agentnum
4942 ON ( part_event.eventpart = peo_agentnum.eventpart
4943 AND peo_agentnum.optionname = 'agentnum'
4944 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4946 LEFT JOIN part_event_condition
4947 ON ( part_event.eventpart = part_event_condition.eventpart
4948 AND part_event_condition.conditionname = 'cust_bill_age'
4950 LEFT JOIN part_event_condition_option
4951 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4952 AND part_event_condition_option.optionname = 'age'
4955 #'hashref' => { 'optionname' => $option },
4956 #'hashref' => { 'part_event_option.optionname' => $option },
4958 " WHERE part_event_option.optionname = ". dbh->quote($option).
4959 " AND action = 'cust_bill_send_agent' ".
4960 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4961 " AND peo_agentnum.optionname = 'agentnum' ".
4962 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4964 CASE WHEN part_event_condition_option.optionname IS NULL
4966 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4968 , part_event.weight".
4972 unless ( $part_event_option ) {
4973 return $self->agent->invoice_template || ''
4974 if $option eq 'agent_templatename';
4978 $part_event_option->optionvalue;
4982 sub process_o2m_qsearch {
4985 return qsearch($table, @_) unless $table eq 'contact';
4987 my $hashref = shift;
4988 my %hash = %$hashref;
4989 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
4990 or die 'guru meditation #4343';
4992 qsearch({ 'table' => 'contact',
4993 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
4994 'hashref' => \%hash,
4995 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
4996 " cust_contact.custnum = $custnum "
5000 sub process_o2m_qsearchs {
5003 return qsearchs($table, @_) unless $table eq 'contact';
5005 my $hashref = shift;
5006 my %hash = %$hashref;
5007 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5008 or die 'guru meditation #2121';
5010 qsearchs({ 'table' => 'contact',
5011 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5012 'hashref' => \%hash,
5013 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5014 " cust_contact.custnum = $custnum "
5018 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5020 Subroutine (not a method), designed to be called from the queue.
5022 Takes a list of options and values.
5024 Pulls up the customer record via the custnum option and calls bill_and_collect.
5029 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5031 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5032 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5034 #without this errors don't get rolled back
5035 $args{'fatal'} = 1; # runs from job queue, will be caught
5037 $cust_main->bill_and_collect( %args );
5040 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5042 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5043 C<collect> part. This is used in batch tax calculation, where invoice
5044 generation and collection events have to be completely separated.
5048 sub queued_collect {
5050 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5052 $cust_main->collect(%args);
5055 sub process_bill_and_collect {
5058 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5059 or die "custnum '$param->{custnum}' not found!\n";
5060 $param->{'job'} = $job;
5061 $param->{'fatal'} = 1; # runs from job queue, will be caught
5062 $param->{'retry'} = 1;
5064 $cust_main->bill_and_collect( %$param );
5067 #starting to take quite a while for big dbs
5068 # (JRNL: journaled so it only happens once per database)
5069 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5070 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5071 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5072 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5073 # JRNL leading/trailing spaces in first, last, company
5074 # JRNL migrate to cust_payby
5075 # - otaker upgrade? journal and call it good? (double check to make sure
5076 # we're not still setting otaker here)
5078 #only going to get worse with new location stuff...
5080 sub _upgrade_data { #class method
5081 my ($class, %opts) = @_;
5083 my @statements = ();
5085 #this seems to be the only expensive one.. why does it take so long?
5086 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5088 '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';
5089 FS::upgrade_journal->set_done('cust_main__signupdate');
5093 foreach my $sql ( @statements ) {
5094 my $sth = dbh->prepare($sql) or die dbh->errstr;
5095 $sth->execute or die $sth->errstr;
5096 #warn ( (time - $t). " seconds\n" );
5100 local($ignore_expired_card) = 1;
5101 local($ignore_banned_card) = 1;
5102 local($skip_fuzzyfiles) = 1;
5103 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5105 FS::cust_main::Location->_upgrade_data(%opts);
5107 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5109 foreach my $cust_main ( qsearch({
5110 'table' => 'cust_main',
5112 'extra_sql' => 'WHERE '.
5114 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5115 qw( first last company )
5118 my $error = $cust_main->replace;
5119 die $error if $error;
5122 FS::upgrade_journal->set_done('cust_main__trimspaces');
5126 $class->_upgrade_otaker(%opts);
5136 The delete method should possibly take an FS::cust_main object reference
5137 instead of a scalar customer number.
5139 Bill and collect options should probably be passed as references instead of a
5142 There should probably be a configuration file with a list of allowed credit
5145 No multiple currency support (probably a larger project than just this module).
5147 Birthdates rely on negative epoch values.
5149 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5153 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5154 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5155 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.