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 our $default_agent_custid;
102 our $custnum_display_length;
103 #ask FS::UID to run this stuff for us later
104 #$FS::UID::callback{'FS::cust_main'} = sub {
105 install_callback FS::UID sub {
106 $conf = new FS::Conf;
107 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
108 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
109 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
114 my ( $hashref, $cache ) = @_;
115 if ( exists $hashref->{'pkgnum'} ) {
116 #@{ $self->{'_pkgnum'} } = ();
117 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
118 $self->{'_pkgnum'} = $subcache;
119 #push @{ $self->{'_pkgnum'} },
120 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
126 FS::cust_main - Object methods for cust_main records
132 $record = new FS::cust_main \%hash;
133 $record = new FS::cust_main { 'column' => 'value' };
135 $error = $record->insert;
137 $error = $new_record->replace($old_record);
139 $error = $record->delete;
141 $error = $record->check;
143 @cust_pkg = $record->all_pkgs;
145 @cust_pkg = $record->ncancelled_pkgs;
147 @cust_pkg = $record->suspended_pkgs;
149 $error = $record->bill;
150 $error = $record->bill %options;
151 $error = $record->bill 'time' => $time;
153 $error = $record->collect;
154 $error = $record->collect %options;
155 $error = $record->collect 'invoice_time' => $time,
160 An FS::cust_main object represents a customer. FS::cust_main inherits from
161 FS::Record. The following fields are currently supported:
167 Primary key (assigned automatically for new customers)
171 Agent (see L<FS::agent>)
175 Advertising source (see L<FS::part_referral>)
187 Cocial security number (optional)
211 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
215 Payment Information (See L<FS::payinfo_Mixin> for data format)
219 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
223 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
227 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
231 Start date month (maestro/solo cards only)
235 Start date year (maestro/solo cards only)
239 Issue number (maestro/solo cards only)
243 Name on card or billing name
247 IP address from which payment information was received
251 Tax exempt, empty or `Y'
255 Order taker (see L<FS::access_user>)
261 =item referral_custnum
263 Referring customer number
267 Enable individual CDR spooling, empty or `Y'
271 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
275 Discourage individual CDR printing, empty or `Y'
279 Allow self-service editing of ticket subjects, empty or 'Y'
281 =item calling_list_exempt
283 Do not call, empty or 'Y'
285 =item invoice_ship_address
287 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
297 Creates a new customer. To add the customer to the database, see L<"insert">.
299 Note that this stores the hash reference, not a distinct copy of the hash it
300 points to. You can ask the object for a copy with the I<hash> method.
304 sub table { 'cust_main'; }
306 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
308 Adds this customer to the database. If there is an error, returns the error,
309 otherwise returns false.
311 Usually the customer's location will not yet exist in the database, and
312 the C<bill_location> and C<ship_location> pseudo-fields must be set to
313 uninserted L<FS::cust_location> objects. These will be inserted and linked
314 (in both directions) to the new customer record. If they're references
315 to the same object, they will become the same location.
317 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
318 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
319 are inserted atomicly, or the transaction is rolled back. Passing an empty
320 hash reference is equivalent to not supplying this parameter. There should be
321 a better explanation of this, but until then, here's an example:
324 tie %hash, 'Tie::RefHash'; #this part is important
326 $cust_pkg => [ $svc_acct ],
329 $cust_main->insert( \%hash );
331 INVOICING_LIST_ARYREF: No longer supported.
333 Currently available options are: I<depend_jobnum>, I<noexport>,
334 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
336 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
337 on the supplied jobnum (they will not run until the specific job completes).
338 This can be used to defer provisioning until some action completes (such
339 as running the customer's credit card successfully).
341 The I<noexport> option is deprecated. If I<noexport> is set true, no
342 provisioning jobs (exports) are scheduled. (You can schedule them later with
343 the B<reexport> method.)
345 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
346 of tax names and exemption numbers. FS::cust_main_exemption records will be
347 created and inserted.
349 If I<prospectnum> is set, moves contacts and locations from that prospect.
351 If I<contact> is set to an arrayref of FS::contact objects, those will be
354 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
355 unset), inserts those new contacts with this new customer. Handles CGI
356 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
358 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
359 new stored payment records with this new customer. Handles CGI parameters
360 for an "m2" multiple entry field as passed by edit/cust_main.cgi
366 my $cust_pkgs = @_ ? shift : {};
368 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
369 warn "cust_main::insert using deprecated invoicing list argument";
370 $invoicing_list = shift;
373 warn "$me insert called with options ".
374 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
377 local $SIG{HUP} = 'IGNORE';
378 local $SIG{INT} = 'IGNORE';
379 local $SIG{QUIT} = 'IGNORE';
380 local $SIG{TERM} = 'IGNORE';
381 local $SIG{TSTP} = 'IGNORE';
382 local $SIG{PIPE} = 'IGNORE';
384 my $oldAutoCommit = $FS::UID::AutoCommit;
385 local $FS::UID::AutoCommit = 0;
388 my $prepay_identifier = '';
389 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
391 if ( $self->payby eq 'PREPAY' ) {
393 $self->payby(''); #'BILL');
394 $prepay_identifier = $self->payinfo;
397 warn " looking up prepaid card $prepay_identifier\n"
400 my $error = $self->get_prepay( $prepay_identifier,
401 'amount_ref' => \$amount,
402 'seconds_ref' => \$seconds,
403 'upbytes_ref' => \$upbytes,
404 'downbytes_ref' => \$downbytes,
405 'totalbytes_ref' => \$totalbytes,
408 $dbh->rollback if $oldAutoCommit;
409 #return "error applying prepaid card (transaction rolled back): $error";
413 $payby = 'PREP' if $amount;
415 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
418 $self->payby(''); #'BILL');
419 $amount = $self->paid;
424 foreach my $l (qw(bill_location ship_location)) {
426 my $loc = delete $self->hashref->{$l} or next;
428 if ( !$loc->locationnum ) {
429 # warn the location that we're going to insert it with no custnum
430 $loc->set(custnum_pending => 1);
431 warn " inserting $l\n"
433 my $error = $loc->insert;
435 $dbh->rollback if $oldAutoCommit;
436 my $label = $l eq 'ship_location' ? 'service' : 'billing';
437 return "$error (in $label location)";
440 } elsif ( $loc->prospectnum ) {
442 $loc->prospectnum('');
443 $loc->set(custnum_pending => 1);
444 my $error = $loc->replace;
446 $dbh->rollback if $oldAutoCommit;
447 my $label = $l eq 'ship_location' ? 'service' : 'billing';
448 return "$error (moving $label location)";
451 } elsif ( ($loc->custnum || 0) > 0 ) {
452 # then it somehow belongs to another customer--shouldn't happen
453 $dbh->rollback if $oldAutoCommit;
454 return "$l belongs to customer ".$loc->custnum;
456 # else it already belongs to this customer
457 # (happens when ship_location is identical to bill_location)
459 $self->set($l.'num', $loc->locationnum);
461 if ( $self->get($l.'num') eq '' ) {
462 $dbh->rollback if $oldAutoCommit;
467 warn " inserting $self\n"
470 $self->signupdate(time) unless $self->signupdate;
472 $self->auto_agent_custid()
473 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
475 my $error = $self->check_payinfo_cardtype
476 || $self->SUPER::insert;
478 $dbh->rollback if $oldAutoCommit;
479 #return "inserting cust_main record (transaction rolled back): $error";
483 # now set cust_location.custnum
484 foreach my $l (qw(bill_location ship_location)) {
485 warn " setting $l.custnum\n"
487 my $loc = $self->$l or next;
488 unless ( $loc->custnum ) {
489 $loc->set(custnum => $self->custnum);
490 $error ||= $loc->replace;
494 $dbh->rollback if $oldAutoCommit;
495 return "error setting $l custnum: $error";
499 warn " setting customer tags\n"
502 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
503 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
504 'custnum' => $self->custnum };
505 my $error = $cust_tag->insert;
507 $dbh->rollback if $oldAutoCommit;
512 my $prospectnum = delete $options{'prospectnum'};
513 if ( $prospectnum ) {
515 warn " moving contacts and locations from prospect $prospectnum\n"
519 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
520 unless ( $prospect_main ) {
521 $dbh->rollback if $oldAutoCommit;
522 return "Unknown prospectnum $prospectnum";
524 $prospect_main->custnum($self->custnum);
525 $prospect_main->disabled('Y');
526 my $error = $prospect_main->replace;
528 $dbh->rollback if $oldAutoCommit;
532 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
533 my $cust_contact = new FS::cust_contact {
534 'custnum' => $self->custnum,
535 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
537 my $error = $cust_contact->insert
538 || $prospect_contact->delete;
540 $dbh->rollback if $oldAutoCommit;
545 my @cust_location = $prospect_main->cust_location;
546 my @qual = $prospect_main->qual;
548 foreach my $r ( @cust_location, @qual ) {
550 $r->custnum($self->custnum);
551 my $error = $r->replace;
553 $dbh->rollback if $oldAutoCommit;
560 warn " setting contacts\n"
563 $invoicing_list ||= $options{'invoicing_list'};
564 if ( $invoicing_list ) {
566 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
569 foreach my $dest (@$invoicing_list ) {
570 if ($dest eq 'POST') {
571 $self->set('postal_invoice', 'Y');
574 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
575 if ( $contact_email ) {
576 my $cust_contact = FS::cust_contact->new({
577 contactnum => $contact_email->contactnum,
578 custnum => $self->custnum,
580 $cust_contact->set('invoice_dest', 'Y');
581 my $error = $cust_contact->contactnum ?
582 $cust_contact->replace : $cust_contact->insert;
584 $dbh->rollback if $oldAutoCommit;
585 return "$error (linking to email address $dest)";
589 # this email address is not yet linked to any contact
590 $email .= ',' if length($email);
596 my $contact = FS::contact->new({
597 'custnum' => $self->get('custnum'),
598 'last' => $self->get('last'),
599 'first' => $self->get('first'),
600 'emailaddress' => $email,
601 'invoice_dest' => 'Y', # yes, you can set this via the contact
603 my $error = $contact->insert;
605 $dbh->rollback if $oldAutoCommit;
611 if ( my $contact = delete $options{'contact'} ) {
613 foreach my $c ( @$contact ) {
614 $c->custnum($self->custnum);
615 my $error = $c->insert;
617 $dbh->rollback if $oldAutoCommit;
623 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
625 my $error = $self->process_o2m( 'table' => 'contact',
626 'fields' => FS::contact->cgi_contact_fields,
627 'params' => $contact_params,
630 $dbh->rollback if $oldAutoCommit;
635 warn " setting cust_payby\n"
638 if ( $options{cust_payby} ) {
640 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
641 $cust_payby->custnum($self->custnum);
642 my $error = $cust_payby->insert;
644 $dbh->rollback if $oldAutoCommit;
649 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
651 my $error = $self->process_o2m(
652 'table' => 'cust_payby',
653 'fields' => FS::cust_payby->cgi_cust_payby_fields,
654 'params' => $cust_payby_params,
655 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
658 $dbh->rollback if $oldAutoCommit;
664 warn " setting cust_main_exemption\n"
667 my $tax_exemption = delete $options{'tax_exemption'};
668 if ( $tax_exemption ) {
670 $tax_exemption = { map { $_ => '' } @$tax_exemption }
671 if ref($tax_exemption) eq 'ARRAY';
673 foreach my $taxname ( keys %$tax_exemption ) {
674 my $cust_main_exemption = new FS::cust_main_exemption {
675 'custnum' => $self->custnum,
676 'taxname' => $taxname,
677 'exempt_number' => $tax_exemption->{$taxname},
679 my $error = $cust_main_exemption->insert;
681 $dbh->rollback if $oldAutoCommit;
682 return "inserting cust_main_exemption (transaction rolled back): $error";
687 warn " ordering packages\n"
690 $error = $self->order_pkgs( $cust_pkgs,
692 'seconds_ref' => \$seconds,
693 'upbytes_ref' => \$upbytes,
694 'downbytes_ref' => \$downbytes,
695 'totalbytes_ref' => \$totalbytes,
698 $dbh->rollback if $oldAutoCommit;
703 $dbh->rollback if $oldAutoCommit;
704 return "No svc_acct record to apply pre-paid time";
706 if ( $upbytes || $downbytes || $totalbytes ) {
707 $dbh->rollback if $oldAutoCommit;
708 return "No svc_acct record to apply pre-paid data";
712 warn " inserting initial $payby payment of $amount\n"
714 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
716 $dbh->rollback if $oldAutoCommit;
717 return "inserting payment (transaction rolled back): $error";
721 unless ( $import || $skip_fuzzyfiles ) {
722 warn " queueing fuzzyfiles update\n"
724 $error = $self->queue_fuzzyfiles_update;
726 $dbh->rollback if $oldAutoCommit;
727 return "updating fuzzy search cache: $error";
731 # FS::geocode_Mixin::after_insert or something?
732 if ( $conf->config('tax_district_method') and !$import ) {
733 # if anything non-empty, try to look it up
734 my $queue = new FS::queue {
735 'job' => 'FS::geocode_Mixin::process_district_update',
736 'custnum' => $self->custnum,
738 my $error = $queue->insert( ref($self), $self->custnum );
740 $dbh->rollback if $oldAutoCommit;
741 return "queueing tax district update: $error";
746 warn " exporting\n" if $DEBUG > 1;
748 my $export_args = $options{'export_args'} || [];
751 map qsearch( 'part_export', {exportnum=>$_} ),
752 $conf->config('cust_main-exports'); #, $agentnum
754 foreach my $part_export ( @part_export ) {
755 my $error = $part_export->export_insert($self, @$export_args);
757 $dbh->rollback if $oldAutoCommit;
758 return "exporting to ". $part_export->exporttype.
759 " (transaction rolled back): $error";
763 #foreach my $depend_jobnum ( @$depend_jobnums ) {
764 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
766 # foreach my $jobnum ( @jobnums ) {
767 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
768 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
770 # my $error = $queue->depend_insert($depend_jobnum);
772 # $dbh->rollback if $oldAutoCommit;
773 # return "error queuing job dependancy: $error";
780 #if ( exists $options{'jobnums'} ) {
781 # push @{ $options{'jobnums'} }, @jobnums;
784 warn " insert complete; committing transaction\n"
787 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
792 use File::CounterFile;
793 sub auto_agent_custid {
796 my $format = $conf->config('cust_main-auto_agent_custid');
798 if ( $format eq '1YMMXXXXXXXX' ) {
800 my $counter = new File::CounterFile 'cust_main.agent_custid';
803 my $ym = 100000000000 + time2str('%y%m00000000', time);
804 if ( $ym > $counter->value ) {
805 $counter->{'value'} = $agent_custid = $ym;
806 $counter->{'updated'} = 1;
808 $agent_custid = $counter->inc;
814 die "Unknown cust_main-auto_agent_custid format: $format";
817 $self->agent_custid($agent_custid);
821 =item PACKAGE METHODS
823 Documentation on customer package methods has been moved to
824 L<FS::cust_main::Packages>.
826 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
828 Recharges this (existing) customer with the specified prepaid card (see
829 L<FS::prepay_credit>), specified either by I<identifier> or as an
830 FS::prepay_credit object. If there is an error, returns the error, otherwise
833 Optionally, five scalar references can be passed as well. They will have their
834 values filled in with the amount, number of seconds, and number of upload,
835 download, and total bytes applied by this prepaid card.
839 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
840 #the only place that uses these args
841 sub recharge_prepay {
842 my( $self, $prepay_credit, $amountref, $secondsref,
843 $upbytesref, $downbytesref, $totalbytesref ) = @_;
845 local $SIG{HUP} = 'IGNORE';
846 local $SIG{INT} = 'IGNORE';
847 local $SIG{QUIT} = 'IGNORE';
848 local $SIG{TERM} = 'IGNORE';
849 local $SIG{TSTP} = 'IGNORE';
850 local $SIG{PIPE} = 'IGNORE';
852 my $oldAutoCommit = $FS::UID::AutoCommit;
853 local $FS::UID::AutoCommit = 0;
856 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
858 my $error = $self->get_prepay( $prepay_credit,
859 'amount_ref' => \$amount,
860 'seconds_ref' => \$seconds,
861 'upbytes_ref' => \$upbytes,
862 'downbytes_ref' => \$downbytes,
863 'totalbytes_ref' => \$totalbytes,
865 || $self->increment_seconds($seconds)
866 || $self->increment_upbytes($upbytes)
867 || $self->increment_downbytes($downbytes)
868 || $self->increment_totalbytes($totalbytes)
869 || $self->insert_cust_pay_prepay( $amount,
871 ? $prepay_credit->identifier
876 $dbh->rollback if $oldAutoCommit;
880 if ( defined($amountref) ) { $$amountref = $amount; }
881 if ( defined($secondsref) ) { $$secondsref = $seconds; }
882 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
883 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
884 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
886 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
891 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
893 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
894 specified either by I<identifier> or as an FS::prepay_credit object.
896 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
897 incremented by the values of the prepaid card.
899 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
900 check or set this customer's I<agentnum>.
902 If there is an error, returns the error, otherwise returns false.
908 my( $self, $prepay_credit, %opt ) = @_;
910 local $SIG{HUP} = 'IGNORE';
911 local $SIG{INT} = 'IGNORE';
912 local $SIG{QUIT} = 'IGNORE';
913 local $SIG{TERM} = 'IGNORE';
914 local $SIG{TSTP} = 'IGNORE';
915 local $SIG{PIPE} = 'IGNORE';
917 my $oldAutoCommit = $FS::UID::AutoCommit;
918 local $FS::UID::AutoCommit = 0;
921 unless ( ref($prepay_credit) ) {
923 my $identifier = $prepay_credit;
925 $prepay_credit = qsearchs(
927 { 'identifier' => $identifier },
932 unless ( $prepay_credit ) {
933 $dbh->rollback if $oldAutoCommit;
934 return "Invalid prepaid card: ". $identifier;
939 if ( $prepay_credit->agentnum ) {
940 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
941 $dbh->rollback if $oldAutoCommit;
942 return "prepaid card not valid for agent ". $self->agentnum;
944 $self->agentnum($prepay_credit->agentnum);
947 my $error = $prepay_credit->delete;
949 $dbh->rollback if $oldAutoCommit;
950 return "removing prepay_credit (transaction rolled back): $error";
953 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
954 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
956 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
961 =item increment_upbytes SECONDS
963 Updates this customer's single or primary account (see L<FS::svc_acct>) by
964 the specified number of upbytes. If there is an error, returns the error,
965 otherwise returns false.
969 sub increment_upbytes {
970 _increment_column( shift, 'upbytes', @_);
973 =item increment_downbytes SECONDS
975 Updates this customer's single or primary account (see L<FS::svc_acct>) by
976 the specified number of downbytes. If there is an error, returns the error,
977 otherwise returns false.
981 sub increment_downbytes {
982 _increment_column( shift, 'downbytes', @_);
985 =item increment_totalbytes SECONDS
987 Updates this customer's single or primary account (see L<FS::svc_acct>) by
988 the specified number of totalbytes. If there is an error, returns the error,
989 otherwise returns false.
993 sub increment_totalbytes {
994 _increment_column( shift, 'totalbytes', @_);
997 =item increment_seconds SECONDS
999 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1000 the specified number of seconds. If there is an error, returns the error,
1001 otherwise returns false.
1005 sub increment_seconds {
1006 _increment_column( shift, 'seconds', @_);
1009 =item _increment_column AMOUNT
1011 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1012 the specified number of seconds or bytes. If there is an error, returns
1013 the error, otherwise returns false.
1017 sub _increment_column {
1018 my( $self, $column, $amount ) = @_;
1019 warn "$me increment_column called: $column, $amount\n"
1022 return '' unless $amount;
1024 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1025 $self->ncancelled_pkgs;
1027 if ( ! @cust_pkg ) {
1028 return 'No packages with primary or single services found'.
1029 ' to apply pre-paid time';
1030 } elsif ( scalar(@cust_pkg) > 1 ) {
1031 #maybe have a way to specify the package/account?
1032 return 'Multiple packages found to apply pre-paid time';
1035 my $cust_pkg = $cust_pkg[0];
1036 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1040 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1042 if ( ! @cust_svc ) {
1043 return 'No account found to apply pre-paid time';
1044 } elsif ( scalar(@cust_svc) > 1 ) {
1045 return 'Multiple accounts found to apply pre-paid time';
1048 my $svc_acct = $cust_svc[0]->svc_x;
1049 warn " found service svcnum ". $svc_acct->pkgnum.
1050 ' ('. $svc_acct->email. ")\n"
1053 $column = "increment_$column";
1054 $svc_acct->$column($amount);
1058 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1060 Inserts a prepayment in the specified amount for this customer. An optional
1061 second argument can specify the prepayment identifier for tracking purposes.
1062 If there is an error, returns the error, otherwise returns false.
1066 sub insert_cust_pay_prepay {
1067 shift->insert_cust_pay('PREP', @_);
1070 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1072 Inserts a cash payment in the specified amount for this customer. An optional
1073 second argument can specify the payment identifier for tracking purposes.
1074 If there is an error, returns the error, otherwise returns false.
1078 sub insert_cust_pay_cash {
1079 shift->insert_cust_pay('CASH', @_);
1082 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1084 Inserts a Western Union payment in the specified amount for this customer. An
1085 optional second argument can specify the prepayment identifier for tracking
1086 purposes. If there is an error, returns the error, otherwise returns false.
1090 sub insert_cust_pay_west {
1091 shift->insert_cust_pay('WEST', @_);
1094 sub insert_cust_pay {
1095 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1096 my $payinfo = scalar(@_) ? shift : '';
1098 my $cust_pay = new FS::cust_pay {
1099 'custnum' => $self->custnum,
1100 'paid' => sprintf('%.2f', $amount),
1101 #'_date' => #date the prepaid card was purchased???
1103 'payinfo' => $payinfo,
1109 =item delete [ OPTION => VALUE ... ]
1111 This deletes the customer. If there is an error, returns the error, otherwise
1114 This will completely remove all traces of the customer record. This is not
1115 what you want when a customer cancels service; for that, cancel all of the
1116 customer's packages (see L</cancel>).
1118 If the customer has any uncancelled packages, you need to pass a new (valid)
1119 customer number for those packages to be transferred to, as the "new_customer"
1120 option. Cancelled packages will be deleted. Did I mention that this is NOT
1121 what you want when a customer cancels service and that you really should be
1122 looking at L<FS::cust_pkg/cancel>?
1124 You can't delete a customer with invoices (see L<FS::cust_bill>),
1125 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1126 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1127 set the "delete_financials" option to a true value.
1132 my( $self, %opt ) = @_;
1134 local $SIG{HUP} = 'IGNORE';
1135 local $SIG{INT} = 'IGNORE';
1136 local $SIG{QUIT} = 'IGNORE';
1137 local $SIG{TERM} = 'IGNORE';
1138 local $SIG{TSTP} = 'IGNORE';
1139 local $SIG{PIPE} = 'IGNORE';
1141 my $oldAutoCommit = $FS::UID::AutoCommit;
1142 local $FS::UID::AutoCommit = 0;
1145 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1146 $dbh->rollback if $oldAutoCommit;
1147 return "Can't delete a master agent customer";
1150 #use FS::access_user
1151 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1152 $dbh->rollback if $oldAutoCommit;
1153 return "Can't delete a master employee customer";
1156 tie my %financial_tables, 'Tie::IxHash',
1157 'cust_bill' => 'invoices',
1158 'cust_statement' => 'statements',
1159 'cust_credit' => 'credits',
1160 'cust_pay' => 'payments',
1161 'cust_refund' => 'refunds',
1164 foreach my $table ( keys %financial_tables ) {
1166 my @records = $self->$table();
1168 if ( @records && ! $opt{'delete_financials'} ) {
1169 $dbh->rollback if $oldAutoCommit;
1170 return "Can't delete a customer with ". $financial_tables{$table};
1173 foreach my $record ( @records ) {
1174 my $error = $record->delete;
1176 $dbh->rollback if $oldAutoCommit;
1177 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1183 my @cust_pkg = $self->ncancelled_pkgs;
1185 my $new_custnum = $opt{'new_custnum'};
1186 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1187 $dbh->rollback if $oldAutoCommit;
1188 return "Invalid new customer number: $new_custnum";
1190 foreach my $cust_pkg ( @cust_pkg ) {
1191 my %hash = $cust_pkg->hash;
1192 $hash{'custnum'} = $new_custnum;
1193 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1194 my $error = $new_cust_pkg->replace($cust_pkg,
1195 options => { $cust_pkg->options },
1198 $dbh->rollback if $oldAutoCommit;
1203 my @cancelled_cust_pkg = $self->all_pkgs;
1204 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1205 my $error = $cust_pkg->delete;
1207 $dbh->rollback if $oldAutoCommit;
1212 #cust_tax_adjustment in financials?
1213 #cust_pay_pending? ouch
1214 foreach my $table (qw(
1215 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1216 cust_payby cust_location cust_main_note cust_tax_adjustment
1217 cust_pay_void cust_pay_batch queue cust_tax_exempt
1219 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1220 my $error = $record->delete;
1222 $dbh->rollback if $oldAutoCommit;
1228 my $sth = $dbh->prepare(
1229 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1231 my $errstr = $dbh->errstr;
1232 $dbh->rollback if $oldAutoCommit;
1235 $sth->execute($self->custnum) or do {
1236 my $errstr = $sth->errstr;
1237 $dbh->rollback if $oldAutoCommit;
1243 my $ticket_dbh = '';
1244 if ($conf->config('ticket_system') eq 'RT_Internal') {
1246 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1247 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1248 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1249 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1252 if ( $ticket_dbh ) {
1254 my $ticket_sth = $ticket_dbh->prepare(
1255 'DELETE FROM Links WHERE Target = ?'
1257 my $errstr = $ticket_dbh->errstr;
1258 $dbh->rollback if $oldAutoCommit;
1261 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1263 my $errstr = $ticket_sth->errstr;
1264 $dbh->rollback if $oldAutoCommit;
1268 #check and see if the customer is the only link on the ticket, and
1269 #if so, set the ticket to deleted status in RT?
1270 #maybe someday, for now this will at least fix tickets not displaying
1274 #delete the customer record
1276 my $error = $self->SUPER::delete;
1278 $dbh->rollback if $oldAutoCommit;
1282 # cust_main exports!
1284 #my $export_args = $options{'export_args'} || [];
1287 map qsearch( 'part_export', {exportnum=>$_} ),
1288 $conf->config('cust_main-exports'); #, $agentnum
1290 foreach my $part_export ( @part_export ) {
1291 my $error = $part_export->export_delete( $self ); #, @$export_args);
1293 $dbh->rollback if $oldAutoCommit;
1294 return "exporting to ". $part_export->exporttype.
1295 " (transaction rolled back): $error";
1299 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1304 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1306 Replaces the OLD_RECORD with this one in the database. If there is an error,
1307 returns the error, otherwise returns false.
1309 To change the customer's address, set the pseudo-fields C<bill_location> and
1310 C<ship_location>. The address will still only change if at least one of the
1311 address fields differs from the existing values.
1313 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1314 set as the contact email address for a default contact with the same name as
1317 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1318 I<contact_params>, I<invoicing_list>.
1320 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1321 of tax names and exemption numbers. FS::cust_main_exemption records will be
1322 deleted and inserted as appropriate.
1324 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1325 groups (describing the customer's payment methods and contacts, respectively)
1326 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1327 and L<FS::contact> for the fields these can contain.
1329 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1330 should be used instead if possible.
1337 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1339 : $self->replace_old;
1343 warn "$me replace called\n"
1346 my $curuser = $FS::CurrentUser::CurrentUser;
1347 return "You are not permitted to create complimentary accounts."
1348 if $self->complimentary eq 'Y'
1349 && $self->complimentary ne $old->complimentary
1350 && ! $curuser->access_right('Complimentary customer');
1352 local($ignore_expired_card) = 1
1353 if $old->payby =~ /^(CARD|DCRD)$/
1354 && $self->payby =~ /^(CARD|DCRD)$/
1355 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1357 local($ignore_banned_card) = 1
1358 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1359 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1360 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1362 if ( $self->payby =~ /^(CARD|DCRD)$/
1363 && $old->payinfo ne $self->payinfo
1364 && $old->paymask ne $self->paymask )
1366 my $error = $self->check_payinfo_cardtype;
1367 return $error if $error;
1370 return "Invoicing locale is required"
1373 && $conf->exists('cust_main-require_locale');
1375 local $SIG{HUP} = 'IGNORE';
1376 local $SIG{INT} = 'IGNORE';
1377 local $SIG{QUIT} = 'IGNORE';
1378 local $SIG{TERM} = 'IGNORE';
1379 local $SIG{TSTP} = 'IGNORE';
1380 local $SIG{PIPE} = 'IGNORE';
1382 my $oldAutoCommit = $FS::UID::AutoCommit;
1383 local $FS::UID::AutoCommit = 0;
1386 for my $l (qw(bill_location ship_location)) {
1387 #my $old_loc = $old->$l;
1388 my $new_loc = $self->$l or next;
1390 # find the existing location if there is one
1391 $new_loc->set('custnum' => $self->custnum);
1392 my $error = $new_loc->find_or_insert;
1394 $dbh->rollback if $oldAutoCommit;
1397 $self->set($l.'num', $new_loc->locationnum);
1401 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1402 warn "cust_main::replace: using deprecated invoicing list argument";
1403 $invoicing_list = shift @param;
1406 my %options = @param;
1408 $invoicing_list ||= $options{invoicing_list};
1410 my @contacts = map { $_->contact } $self->cust_contact;
1411 # find a contact that matches the customer's name
1412 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1413 and $_->last eq $old->get('last') }
1415 $implicit_contact ||= FS::contact->new({
1416 'custnum' => $self->custnum,
1417 'locationnum' => $self->get('bill_locationnum'),
1420 # for any of these that are already contact emails, link to the existing
1422 if ( $invoicing_list ) {
1425 # kind of like process_m2m on these, except:
1426 # - the other side is two tables in a join
1427 # - and we might have to create new contact_emails
1428 # - and possibly a new contact
1430 # Find existing invoice emails that aren't on the implicit contact.
1431 # Any of these that are not on the new invoicing list will be removed.
1432 my %old_email_cust_contact;
1433 foreach my $cust_contact ($self->cust_contact) {
1434 next if !$cust_contact->invoice_dest;
1435 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1437 foreach my $contact_email ($cust_contact->contact->contact_email) {
1438 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1442 foreach my $dest (@$invoicing_list) {
1444 if ($dest eq 'POST') {
1446 $self->set('postal_invoice', 'Y');
1448 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1450 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1454 # See if it belongs to some other contact; if so, link it.
1455 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1457 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1458 my $cust_contact = qsearchs('cust_contact', {
1459 contactnum => $contact_email->contactnum,
1460 custnum => $self->custnum,
1461 }) || FS::cust_contact->new({
1462 contactnum => $contact_email->contactnum,
1463 custnum => $self->custnum,
1465 $cust_contact->set('invoice_dest', 'Y');
1466 my $error = $cust_contact->custcontactnum ?
1467 $cust_contact->replace : $cust_contact->insert;
1469 $dbh->rollback if $oldAutoCommit;
1470 return "$error (linking to email address $dest)";
1474 # This email address is not yet linked to any contact, so it will
1475 # be added to the implicit contact.
1476 $email .= ',' if length($email);
1482 foreach my $remove_dest (keys %old_email_cust_contact) {
1483 my $cust_contact = $old_email_cust_contact{$remove_dest};
1484 # These were not in the list of requested destinations, so take them off.
1485 $cust_contact->set('invoice_dest', '');
1486 my $error = $cust_contact->replace;
1488 $dbh->rollback if $oldAutoCommit;
1489 return "$error (unlinking email address $remove_dest)";
1493 # make sure it keeps up with the changed customer name, if any
1494 $implicit_contact->set('last', $self->get('last'));
1495 $implicit_contact->set('first', $self->get('first'));
1496 $implicit_contact->set('emailaddress', $email);
1497 $implicit_contact->set('invoice_dest', 'Y');
1498 $implicit_contact->set('custnum', $self->custnum);
1501 if ( $implicit_contact->contactnum ) {
1502 $error = $implicit_contact->replace;
1503 } elsif ( length($email) ) { # don't create a new contact if not needed
1504 $error = $implicit_contact->insert;
1508 $dbh->rollback if $oldAutoCommit;
1509 return "$error (adding email address $email)";
1514 # replace the customer record
1515 my $error = $self->SUPER::replace($old);
1518 $dbh->rollback if $oldAutoCommit;
1522 # now move packages to the new service location
1523 $self->set('ship_location', ''); #flush cache
1524 if ( $old->ship_locationnum and # should only be null during upgrade...
1525 $old->ship_locationnum != $self->ship_locationnum ) {
1526 $error = $old->ship_location->move_to($self->ship_location);
1528 $dbh->rollback if $oldAutoCommit;
1532 # don't move packages based on the billing location, but
1533 # disable it if it's no longer in use
1534 if ( $old->bill_locationnum and
1535 $old->bill_locationnum != $self->bill_locationnum ) {
1536 $error = $old->bill_location->disable_if_unused;
1538 $dbh->rollback if $oldAutoCommit;
1543 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1545 #this could be more efficient than deleting and re-inserting, if it matters
1546 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1547 my $error = $cust_tag->delete;
1549 $dbh->rollback if $oldAutoCommit;
1553 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1554 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1555 'custnum' => $self->custnum };
1556 my $error = $cust_tag->insert;
1558 $dbh->rollback if $oldAutoCommit;
1565 my $tax_exemption = delete $options{'tax_exemption'};
1566 if ( $tax_exemption ) {
1568 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1569 if ref($tax_exemption) eq 'ARRAY';
1571 my %cust_main_exemption =
1572 map { $_->taxname => $_ }
1573 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1575 foreach my $taxname ( keys %$tax_exemption ) {
1577 if ( $cust_main_exemption{$taxname} &&
1578 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1581 delete $cust_main_exemption{$taxname};
1585 my $cust_main_exemption = new FS::cust_main_exemption {
1586 'custnum' => $self->custnum,
1587 'taxname' => $taxname,
1588 'exempt_number' => $tax_exemption->{$taxname},
1590 my $error = $cust_main_exemption->insert;
1592 $dbh->rollback if $oldAutoCommit;
1593 return "inserting cust_main_exemption (transaction rolled back): $error";
1597 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1598 my $error = $cust_main_exemption->delete;
1600 $dbh->rollback if $oldAutoCommit;
1601 return "deleting cust_main_exemption (transaction rolled back): $error";
1607 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1609 my $error = $self->process_o2m(
1610 'table' => 'cust_payby',
1611 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1612 'params' => $cust_payby_params,
1613 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1616 $dbh->rollback if $oldAutoCommit;
1622 if ( my $contact_params = delete $options{'contact_params'} ) {
1624 # this can potentially replace contacts that were created by the
1625 # invoicing list argument, but the UI shouldn't allow both of them
1628 my $error = $self->process_o2m(
1629 'table' => 'contact',
1630 'fields' => FS::contact->cgi_contact_fields,
1631 'params' => $contact_params,
1634 $dbh->rollback if $oldAutoCommit;
1640 unless ( $import || $skip_fuzzyfiles ) {
1641 $error = $self->queue_fuzzyfiles_update;
1643 $dbh->rollback if $oldAutoCommit;
1644 return "updating fuzzy search cache: $error";
1648 # tax district update in cust_location
1650 # cust_main exports!
1652 my $export_args = $options{'export_args'} || [];
1655 map qsearch( 'part_export', {exportnum=>$_} ),
1656 $conf->config('cust_main-exports'); #, $agentnum
1658 foreach my $part_export ( @part_export ) {
1659 my $error = $part_export->export_replace( $self, $old, @$export_args);
1661 $dbh->rollback if $oldAutoCommit;
1662 return "exporting to ". $part_export->exporttype.
1663 " (transaction rolled back): $error";
1667 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1672 =item queue_fuzzyfiles_update
1674 Used by insert & replace to update the fuzzy search cache
1678 use FS::cust_main::Search;
1679 sub queue_fuzzyfiles_update {
1682 local $SIG{HUP} = 'IGNORE';
1683 local $SIG{INT} = 'IGNORE';
1684 local $SIG{QUIT} = 'IGNORE';
1685 local $SIG{TERM} = 'IGNORE';
1686 local $SIG{TSTP} = 'IGNORE';
1687 local $SIG{PIPE} = 'IGNORE';
1689 my $oldAutoCommit = $FS::UID::AutoCommit;
1690 local $FS::UID::AutoCommit = 0;
1693 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1694 my $queue = new FS::queue {
1695 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1697 my @args = "cust_main.$field", $self->get($field);
1698 my $error = $queue->insert( @args );
1700 $dbh->rollback if $oldAutoCommit;
1701 return "queueing job (transaction rolled back): $error";
1706 push @locations, $self->bill_location if $self->bill_locationnum;
1707 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1708 foreach my $location (@locations) {
1709 my $queue = new FS::queue {
1710 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1712 my @args = 'cust_location.address1', $location->address1;
1713 my $error = $queue->insert( @args );
1715 $dbh->rollback if $oldAutoCommit;
1716 return "queueing job (transaction rolled back): $error";
1720 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1727 Checks all fields to make sure this is a valid customer record. If there is
1728 an error, returns the error, otherwise returns false. Called by the insert
1729 and replace methods.
1736 warn "$me check BEFORE: \n". $self->_dump
1740 $self->ut_numbern('custnum')
1741 || $self->ut_number('agentnum')
1742 || $self->ut_textn('agent_custid')
1743 || $self->ut_number('refnum')
1744 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1745 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1746 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1747 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1748 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1749 || $self->ut_textn('custbatch')
1750 || $self->ut_name('last')
1751 || $self->ut_name('first')
1752 || $self->ut_snumbern('signupdate')
1753 || $self->ut_snumbern('birthdate')
1754 || $self->ut_namen('spouse_last')
1755 || $self->ut_namen('spouse_first')
1756 || $self->ut_snumbern('spouse_birthdate')
1757 || $self->ut_snumbern('anniversary_date')
1758 || $self->ut_textn('company')
1759 || $self->ut_textn('ship_company')
1760 || $self->ut_anything('comments')
1761 || $self->ut_numbern('referral_custnum')
1762 || $self->ut_textn('stateid')
1763 || $self->ut_textn('stateid_state')
1764 || $self->ut_textn('invoice_terms')
1765 || $self->ut_floatn('cdr_termination_percentage')
1766 || $self->ut_floatn('credit_limit')
1767 || $self->ut_numbern('billday')
1768 || $self->ut_numbern('prorate_day')
1769 || $self->ut_flag('edit_subject')
1770 || $self->ut_flag('calling_list_exempt')
1771 || $self->ut_flag('invoice_noemail')
1772 || $self->ut_flag('message_noemail')
1773 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1774 || $self->ut_currencyn('currency')
1775 || $self->ut_alphan('po_number')
1776 || $self->ut_enum('complimentary', [ '', 'Y' ])
1777 || $self->ut_flag('invoice_ship_address')
1778 || $self->ut_flag('invoice_dest')
1781 foreach (qw(company ship_company)) {
1782 my $company = $self->get($_);
1783 $company =~ s/^\s+//;
1784 $company =~ s/\s+$//;
1785 $company =~ s/\s+/ /g;
1786 $self->set($_, $company);
1789 #barf. need message catalogs. i18n. etc.
1790 $error .= "Please select an advertising source."
1791 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1792 return $error if $error;
1794 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1795 or return "Unknown agent";
1797 if ( $self->currency ) {
1798 my $agent_currency = qsearchs( 'agent_currency', {
1799 'agentnum' => $agent->agentnum,
1800 'currency' => $self->currency,
1802 or return "Agent ". $agent->agent.
1803 " not permitted to offer ". $self->currency. " invoicing";
1806 return "Unknown refnum"
1807 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1809 return "Unknown referring custnum: ". $self->referral_custnum
1810 unless ! $self->referral_custnum
1811 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1813 if ( $self->ss eq '' ) {
1818 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1819 or return "Illegal social security number: ". $self->ss;
1820 $self->ss("$1-$2-$3");
1823 #turn off invoice_ship_address if ship & bill are the same
1824 if ($self->bill_locationnum eq $self->ship_locationnum) {
1825 $self->invoice_ship_address('');
1828 # cust_main_county verification now handled by cust_location check
1831 $self->ut_phonen('daytime', $self->country)
1832 || $self->ut_phonen('night', $self->country)
1833 || $self->ut_phonen('fax', $self->country)
1834 || $self->ut_phonen('mobile', $self->country)
1836 return $error if $error;
1838 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1840 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1843 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1845 : FS::Msgcat::_gettext('daytime');
1846 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1848 : FS::Msgcat::_gettext('night');
1850 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1852 : FS::Msgcat::_gettext('mobile');
1854 return "$daytime_label, $night_label or $mobile_label is required"
1858 return "Please select an invoicing locale"
1861 && $conf->exists('cust_main-require_locale');
1863 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1864 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1868 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1870 warn "$me check AFTER: \n". $self->_dump
1873 $self->SUPER::check;
1876 sub check_payinfo_cardtype {
1879 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1881 my $payinfo = $self->payinfo;
1882 $payinfo =~ s/\D//g;
1884 return '' if $payinfo =~ /^99\d{14}$/; #token
1886 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1887 my $cardtype = cardtype($payinfo);
1889 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1897 Additional checks for replace only.
1902 my ($new,$old) = @_;
1903 #preserve old value if global config is set
1904 if ($old && $conf->exists('invoice-ship_address')) {
1905 $new->invoice_ship_address($old->invoice_ship_address);
1912 Returns a list of fields which have ship_ duplicates.
1917 qw( last first company
1919 address1 address2 city county state zip country
1921 daytime night fax mobile
1925 =item has_ship_address
1927 Returns true if this customer record has a separate shipping address.
1931 sub has_ship_address {
1933 $self->bill_locationnum != $self->ship_locationnum;
1938 Returns a list of key/value pairs, with the following keys: address1,
1939 adddress2, city, county, state, zip, country, district, and geocode. The
1940 shipping address is used if present.
1946 $self->ship_location->location_hash;
1951 Returns all locations (see L<FS::cust_location>) for this customer.
1958 'table' => 'cust_location',
1959 'hashref' => { 'custnum' => $self->custnum,
1960 'prospectnum' => '',
1962 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1968 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1974 qsearch('cust_contact', { 'custnum' => $self->custnum } );
1977 =item cust_payby PAYBY
1979 Returns all payment methods (see L<FS::cust_payby>) for this customer.
1981 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
1982 Does not validate PAYBY.
1990 'table' => 'cust_payby',
1991 'hashref' => { 'custnum' => $self->custnum },
1992 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
1994 $search->{'extra_sql'} = ' AND payby IN ( ' . join(',', map { dbh->quote($_) } @payby) . ' ) '
2000 =item has_cust_payby_auto
2002 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2006 sub has_cust_payby_auto {
2009 'table' => 'cust_payby',
2010 'hashref' => { 'custnum' => $self->custnum, },
2011 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2012 'order_by' => 'LIMIT 1',
2019 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2020 and L<FS::cust_pkg>) for this customer, except those on hold.
2022 Returns a list: an empty list on success or a list of errors.
2028 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2033 Unsuspends all suspended packages in the on-hold state (those without setup
2034 dates) for this customer.
2040 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2045 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2047 Returns a list: an empty list on success or a list of errors.
2053 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2056 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2058 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2059 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2060 of a list of pkgparts; the hashref has the following keys:
2064 =item pkgparts - listref of pkgparts
2066 =item (other options are passed to the suspend method)
2071 Returns a list: an empty list on success or a list of errors.
2075 sub suspend_if_pkgpart {
2077 my (@pkgparts, %opt);
2078 if (ref($_[0]) eq 'HASH'){
2079 @pkgparts = @{$_[0]{pkgparts}};
2084 grep { $_->suspend(%opt) }
2085 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2086 $self->unsuspended_pkgs;
2089 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2091 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2092 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2093 instead of a list of pkgparts; the hashref has the following keys:
2097 =item pkgparts - listref of pkgparts
2099 =item (other options are passed to the suspend method)
2103 Returns a list: an empty list on success or a list of errors.
2107 sub suspend_unless_pkgpart {
2109 my (@pkgparts, %opt);
2110 if (ref($_[0]) eq 'HASH'){
2111 @pkgparts = @{$_[0]{pkgparts}};
2116 grep { $_->suspend(%opt) }
2117 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2118 $self->unsuspended_pkgs;
2121 =item cancel [ OPTION => VALUE ... ]
2123 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2125 Available options are:
2129 =item quiet - can be set true to supress email cancellation notices.
2131 =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.
2133 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2135 =item nobill - can be set true to skip billing if it might otherwise be done.
2139 Always returns a list: an empty list on success or a list of errors.
2143 # nb that dates are not specified as valid options to this method
2146 my( $self, %opt ) = @_;
2148 warn "$me cancel called on customer ". $self->custnum. " with options ".
2149 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2152 return ( 'access denied' )
2153 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2155 if ( $opt{'ban'} ) {
2157 foreach my $cust_payby ( $self->cust_payby ) {
2159 #well, if they didn't get decrypted on search, then we don't have to
2160 # try again... queue a job for the server that does have decryption
2161 # capability if we're in a paranoid multi-server implementation?
2162 return ( "Can't (yet) ban encrypted credit cards" )
2163 if $cust_payby->is_encrypted($cust_payby->payinfo);
2165 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2166 my $error = $ban->insert;
2167 return ( $error ) if $error;
2173 my @pkgs = $self->ncancelled_pkgs;
2175 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2177 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2178 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2182 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2183 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2186 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2189 sub _banned_pay_hashref {
2190 die 'cust_main->_banned_pay_hashref deprecated';
2202 'payby' => $payby2ban{$self->payby},
2203 'payinfo' => $self->payinfo,
2204 #don't ever *search* on reason! #'reason' =>
2210 Returns all notes (see L<FS::cust_main_note>) for this customer.
2215 my($self,$orderby_classnum) = (shift,shift);
2216 my $orderby = "sticky DESC, _date DESC";
2217 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2218 qsearch( 'cust_main_note',
2219 { 'custnum' => $self->custnum },
2221 "ORDER BY $orderby",
2227 Returns the agent (see L<FS::agent>) for this customer.
2231 Returns the agent name (see L<FS::agent>) for this customer.
2237 $self->agent->agent;
2242 Returns any tags associated with this customer, as FS::cust_tag objects,
2243 or an empty list if there are no tags.
2247 Returns any tags associated with this customer, as FS::part_tag objects,
2248 or an empty list if there are no tags.
2254 map $_->part_tag, $self->cust_tag;
2260 Returns the customer class, as an FS::cust_class object, or the empty string
2261 if there is no customer class.
2265 Returns the customer category name, or the empty string if there is no customer
2272 my $cust_class = $self->cust_class;
2274 ? $cust_class->categoryname
2280 Returns the customer class name, or the empty string if there is no customer
2287 my $cust_class = $self->cust_class;
2289 ? $cust_class->classname
2295 Returns the external tax status, as an FS::tax_status object, or the empty
2296 string if there is no tax status.
2302 if ( $self->taxstatusnum ) {
2303 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2311 Returns the tax status code if there is one.
2317 my $tax_status = $self->tax_status;
2319 ? $tax_status->taxstatus
2323 =item BILLING METHODS
2325 Documentation on billing methods has been moved to
2326 L<FS::cust_main::Billing>.
2328 =item REALTIME BILLING METHODS
2330 Documentation on realtime billing methods has been moved to
2331 L<FS::cust_main::Billing_Realtime>.
2335 Removes the I<paycvv> field from the database directly.
2337 If there is an error, returns the error, otherwise returns false.
2342 die 'cust_main->remove_cvv deprecated';
2344 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2345 or return dbh->errstr;
2346 $sth->execute($self->custnum)
2347 or return $sth->errstr;
2354 Returns the total owed for this customer on all invoices
2355 (see L<FS::cust_bill/owed>).
2361 $self->total_owed_date(2145859200); #12/31/2037
2364 =item total_owed_date TIME
2366 Returns the total owed for this customer on all invoices with date earlier than
2367 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2368 see L<Time::Local> and L<Date::Parse> for conversion functions.
2372 sub total_owed_date {
2376 my $custnum = $self->custnum;
2378 my $owed_sql = FS::cust_bill->owed_sql;
2381 SELECT SUM($owed_sql) FROM cust_bill
2382 WHERE custnum = $custnum
2386 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2390 =item total_owed_pkgnum PKGNUM
2392 Returns the total owed on all invoices for this customer's specific package
2393 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2397 sub total_owed_pkgnum {
2398 my( $self, $pkgnum ) = @_;
2399 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2402 =item total_owed_date_pkgnum TIME PKGNUM
2404 Returns the total owed for this customer's specific package when using
2405 experimental package balances on all invoices with date earlier than
2406 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2407 see L<Time::Local> and L<Date::Parse> for conversion functions.
2411 sub total_owed_date_pkgnum {
2412 my( $self, $time, $pkgnum ) = @_;
2415 foreach my $cust_bill (
2416 grep { $_->_date <= $time }
2417 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2419 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2421 sprintf( "%.2f", $total_bill );
2427 Returns the total amount of all payments.
2434 $total += $_->paid foreach $self->cust_pay;
2435 sprintf( "%.2f", $total );
2438 =item total_unapplied_credits
2440 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2441 customer. See L<FS::cust_credit/credited>.
2443 =item total_credited
2445 Old name for total_unapplied_credits. Don't use.
2449 sub total_credited {
2450 #carp "total_credited deprecated, use total_unapplied_credits";
2451 shift->total_unapplied_credits(@_);
2454 sub total_unapplied_credits {
2457 my $custnum = $self->custnum;
2459 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2462 SELECT SUM($unapplied_sql) FROM cust_credit
2463 WHERE custnum = $custnum
2466 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2470 =item total_unapplied_credits_pkgnum PKGNUM
2472 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2473 customer. See L<FS::cust_credit/credited>.
2477 sub total_unapplied_credits_pkgnum {
2478 my( $self, $pkgnum ) = @_;
2479 my $total_credit = 0;
2480 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2481 sprintf( "%.2f", $total_credit );
2485 =item total_unapplied_payments
2487 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2488 See L<FS::cust_pay/unapplied>.
2492 sub total_unapplied_payments {
2495 my $custnum = $self->custnum;
2497 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2500 SELECT SUM($unapplied_sql) FROM cust_pay
2501 WHERE custnum = $custnum
2504 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2508 =item total_unapplied_payments_pkgnum PKGNUM
2510 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2511 specific package when using experimental package balances. See
2512 L<FS::cust_pay/unapplied>.
2516 sub total_unapplied_payments_pkgnum {
2517 my( $self, $pkgnum ) = @_;
2518 my $total_unapplied = 0;
2519 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2520 sprintf( "%.2f", $total_unapplied );
2524 =item total_unapplied_refunds
2526 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2527 customer. See L<FS::cust_refund/unapplied>.
2531 sub total_unapplied_refunds {
2533 my $custnum = $self->custnum;
2535 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2538 SELECT SUM($unapplied_sql) FROM cust_refund
2539 WHERE custnum = $custnum
2542 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2548 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2549 total_unapplied_credits minus total_unapplied_payments).
2555 $self->balance_date_range;
2558 =item balance_date TIME
2560 Returns the balance for this customer, only considering invoices with date
2561 earlier than TIME (total_owed_date minus total_credited minus
2562 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2563 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2570 $self->balance_date_range(shift);
2573 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2575 Returns the balance for this customer, optionally considering invoices with
2576 date earlier than START_TIME, and not later than END_TIME
2577 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2579 Times are specified as SQL fragments or numeric
2580 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2581 L<Date::Parse> for conversion functions. The empty string can be passed
2582 to disable that time constraint completely.
2584 Accepts the same options as L<balance_date_sql>:
2588 =item unapplied_date
2590 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)
2594 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2595 time will be ignored. Note that START_TIME and END_TIME only limit the date
2596 range for invoices and I<unapplied> payments, credits, and refunds.
2602 sub balance_date_range {
2604 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2605 ') FROM cust_main WHERE custnum='. $self->custnum;
2606 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2609 =item balance_pkgnum PKGNUM
2611 Returns the balance for this customer's specific package when using
2612 experimental package balances (total_owed plus total_unrefunded, minus
2613 total_unapplied_credits minus total_unapplied_payments)
2617 sub balance_pkgnum {
2618 my( $self, $pkgnum ) = @_;
2621 $self->total_owed_pkgnum($pkgnum)
2622 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2623 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2624 - $self->total_unapplied_credits_pkgnum($pkgnum)
2625 - $self->total_unapplied_payments_pkgnum($pkgnum)
2631 Returns a hash of useful information for making a payment.
2641 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2642 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2643 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2647 For credit card transactions:
2659 For electronic check transactions:
2669 #XXX i need to be updated for 4.x+
2675 $return{balance} = $self->balance;
2677 $return{payname} = $self->payname
2678 || ( $self->first. ' '. $self->get('last') );
2680 $return{$_} = $self->bill_location->$_
2681 for qw(address1 address2 city state zip);
2683 $return{payby} = $self->payby;
2684 $return{stateid_state} = $self->stateid_state;
2686 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2687 $return{card_type} = cardtype($self->payinfo);
2688 $return{payinfo} = $self->paymask;
2690 @return{'month', 'year'} = $self->paydate_monthyear;
2694 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2695 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2696 $return{payinfo1} = $payinfo1;
2697 $return{payinfo2} = $payinfo2;
2698 $return{paytype} = $self->paytype;
2699 $return{paystate} = $self->paystate;
2703 #doubleclick protection
2705 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2713 Returns the next payment expiration date for this customer. If they have no
2714 payment methods that will expire, returns 0.
2720 # filter out the ones that individually return 0, but then return 0 if
2721 # there are no results
2722 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2723 min( @epochs ) || 0;
2726 =item paydate_epoch_sql
2728 Returns an SQL expression to get the next payment expiration date for a
2729 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2730 dates, so that it's safe to test for "will it expire before date X" for any
2735 sub paydate_epoch_sql {
2737 my $paydate = FS::cust_payby->paydate_epoch_sql;
2738 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2742 my( $self, $taxname ) = @_;
2744 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2745 'taxname' => $taxname,
2750 =item cust_main_exemption
2752 =item invoicing_list
2754 Returns a list of email addresses (with svcnum entries expanded), and the word
2755 'POST' if the customer receives postal invoices.
2759 sub invoicing_list {
2760 my( $self, $arrayref ) = @_;
2763 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2766 my @emails = $self->invoicing_list_emailonly;
2767 push @emails, 'POST' if $self->get('postal_invoice');
2772 =item check_invoicing_list ARRAYREF
2774 Checks these arguements as valid input for the invoicing_list method. If there
2775 is an error, returns the error, otherwise returns false.
2779 sub check_invoicing_list {
2780 my( $self, $arrayref ) = @_;
2782 foreach my $address ( @$arrayref ) {
2784 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2785 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2788 my $cust_main_invoice = new FS::cust_main_invoice ( {
2789 'custnum' => $self->custnum,
2792 my $error = $self->custnum
2793 ? $cust_main_invoice->check
2794 : $cust_main_invoice->checkdest
2796 return $error if $error;
2800 return "Email address required"
2801 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2802 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2809 Returns the email addresses of all accounts provisioned for this customer.
2816 foreach my $cust_pkg ( $self->all_pkgs ) {
2817 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2819 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2820 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2822 $list{$_}=1 foreach map { $_->email } @svc_acct;
2827 =item invoicing_list_addpost
2829 Adds postal invoicing to this customer. If this customer is already configured
2830 to receive postal invoices, does nothing.
2834 sub invoicing_list_addpost {
2836 if ( $self->get('postal_invoice') eq '' ) {
2837 $self->set('postal_invoice', 'Y');
2838 my $error = $self->replace;
2839 warn $error if $error; # should fail harder, but this is traditional
2843 =item invoicing_list_emailonly
2845 Returns the list of email invoice recipients (invoicing_list without non-email
2846 destinations such as POST and FAX).
2850 sub invoicing_list_emailonly {
2852 warn "$me invoicing_list_emailonly called"
2854 return () if !$self->custnum; # not yet inserted
2855 return map { $_->emailaddress }
2857 table => 'cust_contact',
2858 select => 'emailaddress',
2859 addl_from => ' JOIN contact USING (contactnum) '.
2860 ' JOIN contact_email USING (contactnum)',
2861 hashref => { 'custnum' => $self->custnum, },
2862 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2866 =item invoicing_list_emailonly_scalar
2868 Returns the list of email invoice recipients (invoicing_list without non-email
2869 destinations such as POST and FAX) as a comma-separated scalar.
2873 sub invoicing_list_emailonly_scalar {
2875 warn "$me invoicing_list_emailonly_scalar called"
2877 join(', ', $self->invoicing_list_emailonly);
2880 =item referral_custnum_cust_main
2882 Returns the customer who referred this customer (or the empty string, if
2883 this customer was not referred).
2885 Note the difference with referral_cust_main method: This method,
2886 referral_custnum_cust_main returns the single customer (if any) who referred
2887 this customer, while referral_cust_main returns an array of customers referred
2892 sub referral_custnum_cust_main {
2894 return '' unless $self->referral_custnum;
2895 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
2898 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
2900 Returns an array of customers referred by this customer (referral_custnum set
2901 to this custnum). If DEPTH is given, recurses up to the given depth, returning
2902 customers referred by customers referred by this customer and so on, inclusive.
2903 The default behavior is DEPTH 1 (no recursion).
2905 Note the difference with referral_custnum_cust_main method: This method,
2906 referral_cust_main, returns an array of customers referred BY this customer,
2907 while referral_custnum_cust_main returns the single customer (if any) who
2908 referred this customer.
2912 sub referral_cust_main {
2914 my $depth = @_ ? shift : 1;
2915 my $exclude = @_ ? shift : {};
2918 map { $exclude->{$_->custnum}++; $_; }
2919 grep { ! $exclude->{ $_->custnum } }
2920 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
2924 map { $_->referral_cust_main($depth-1, $exclude) }
2931 =item referral_cust_main_ncancelled
2933 Same as referral_cust_main, except only returns customers with uncancelled
2938 sub referral_cust_main_ncancelled {
2940 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
2943 =item referral_cust_pkg [ DEPTH ]
2945 Like referral_cust_main, except returns a flat list of all unsuspended (and
2946 uncancelled) packages for each customer. The number of items in this list may
2947 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
2951 sub referral_cust_pkg {
2953 my $depth = @_ ? shift : 1;
2955 map { $_->unsuspended_pkgs }
2956 grep { $_->unsuspended_pkgs }
2957 $self->referral_cust_main($depth);
2960 =item referring_cust_main
2962 Returns the single cust_main record for the customer who referred this customer
2963 (referral_custnum), or false.
2967 sub referring_cust_main {
2969 return '' unless $self->referral_custnum;
2970 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
2973 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
2975 Applies a credit to this customer. If there is an error, returns the error,
2976 otherwise returns false.
2978 REASON can be a text string, an FS::reason object, or a scalar reference to
2979 a reasonnum. If a text string, it will be automatically inserted as a new
2980 reason, and a 'reason_type' option must be passed to indicate the
2981 FS::reason_type for the new reason.
2983 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
2984 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
2985 I<commission_pkgnum>.
2987 Any other options are passed to FS::cust_credit::insert.
2992 my( $self, $amount, $reason, %options ) = @_;
2994 my $cust_credit = new FS::cust_credit {
2995 'custnum' => $self->custnum,
2996 'amount' => $amount,
2999 if ( ref($reason) ) {
3001 if ( ref($reason) eq 'SCALAR' ) {
3002 $cust_credit->reasonnum( $$reason );
3004 $cust_credit->reasonnum( $reason->reasonnum );
3008 $cust_credit->set('reason', $reason)
3011 $cust_credit->$_( delete $options{$_} )
3012 foreach grep exists($options{$_}),
3013 qw( addlinfo eventnum ),
3014 map "commission_$_", qw( agentnum salesnum pkgnum );
3016 $cust_credit->insert(%options);
3020 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3022 Creates a one-time charge for this customer. If there is an error, returns
3023 the error, otherwise returns false.
3025 New-style, with a hashref of options:
3027 my $error = $cust_main->charge(
3031 'start_date' => str2time('7/4/2009'),
3032 'pkg' => 'Description',
3033 'comment' => 'Comment',
3034 'additional' => [], #extra invoice detail
3035 'classnum' => 1, #pkg_class
3037 'setuptax' => '', # or 'Y' for tax exempt
3039 'locationnum'=> 1234, # optional
3042 'taxclass' => 'Tax class',
3045 'taxproduct' => 2, #part_pkg_taxproduct
3046 'override' => {}, #XXX describe
3048 #will be filled in with the new object
3049 'cust_pkg_ref' => \$cust_pkg,
3051 #generate an invoice immediately
3053 'invoice_terms' => '', #with these terms
3059 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3063 #super false laziness w/quotation::charge
3066 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3067 my ( $pkg, $comment, $additional );
3068 my ( $setuptax, $taxclass ); #internal taxes
3069 my ( $taxproduct, $override ); #vendor (CCH) taxes
3071 my $separate_bill = '';
3072 my $cust_pkg_ref = '';
3073 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3075 if ( ref( $_[0] ) ) {
3076 $amount = $_[0]->{amount};
3077 $setup_cost = $_[0]->{setup_cost};
3078 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3079 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3080 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3081 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3082 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3083 : '$'. sprintf("%.2f",$amount);
3084 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3085 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3086 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3087 $additional = $_[0]->{additional} || [];
3088 $taxproduct = $_[0]->{taxproductnum};
3089 $override = { '' => $_[0]->{tax_override} };
3090 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3091 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3092 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3093 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3094 $separate_bill = $_[0]->{separate_bill} || '';
3100 $pkg = @_ ? shift : 'One-time charge';
3101 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3103 $taxclass = @_ ? shift : '';
3107 local $SIG{HUP} = 'IGNORE';
3108 local $SIG{INT} = 'IGNORE';
3109 local $SIG{QUIT} = 'IGNORE';
3110 local $SIG{TERM} = 'IGNORE';
3111 local $SIG{TSTP} = 'IGNORE';
3112 local $SIG{PIPE} = 'IGNORE';
3114 my $oldAutoCommit = $FS::UID::AutoCommit;
3115 local $FS::UID::AutoCommit = 0;
3118 my $part_pkg = new FS::part_pkg ( {
3120 'comment' => $comment,
3124 'classnum' => ( $classnum ? $classnum : '' ),
3125 'setuptax' => $setuptax,
3126 'taxclass' => $taxclass,
3127 'taxproductnum' => $taxproduct,
3128 'setup_cost' => $setup_cost,
3131 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3132 ( 0 .. @$additional - 1 )
3134 'additional_count' => scalar(@$additional),
3135 'setup_fee' => $amount,
3138 my $error = $part_pkg->insert( options => \%options,
3139 tax_overrides => $override,
3142 $dbh->rollback if $oldAutoCommit;
3146 my $pkgpart = $part_pkg->pkgpart;
3147 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3148 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3149 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3150 $error = $type_pkgs->insert;
3152 $dbh->rollback if $oldAutoCommit;
3157 my $cust_pkg = new FS::cust_pkg ( {
3158 'custnum' => $self->custnum,
3159 'pkgpart' => $pkgpart,
3160 'quantity' => $quantity,
3161 'start_date' => $start_date,
3162 'no_auto' => $no_auto,
3163 'separate_bill' => $separate_bill,
3164 'locationnum'=> $locationnum,
3167 $error = $cust_pkg->insert;
3169 $dbh->rollback if $oldAutoCommit;
3171 } elsif ( $cust_pkg_ref ) {
3172 ${$cust_pkg_ref} = $cust_pkg;
3176 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3177 'pkg_list' => [ $cust_pkg ],
3180 $dbh->rollback if $oldAutoCommit;
3185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3190 #=item charge_postal_fee
3192 #Applies a one time charge this customer. If there is an error,
3193 #returns the error, returns the cust_pkg charge object or false
3194 #if there was no charge.
3198 # This should be a customer event. For that to work requires that bill
3199 # also be a customer event.
3201 sub charge_postal_fee {
3204 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3205 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3207 my $cust_pkg = new FS::cust_pkg ( {
3208 'custnum' => $self->custnum,
3209 'pkgpart' => $pkgpart,
3213 my $error = $cust_pkg->insert;
3214 $error ? $error : $cust_pkg;
3217 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3219 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3221 Optionally, a list or hashref of additional arguments to the qsearch call can
3228 my $opt = ref($_[0]) ? shift : { @_ };
3230 #return $self->num_cust_bill unless wantarray || keys %$opt;
3232 $opt->{'table'} = 'cust_bill';
3233 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3234 $opt->{'hashref'}{'custnum'} = $self->custnum;
3235 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3237 map { $_ } #behavior of sort undefined in scalar context
3238 sort { $a->_date <=> $b->_date }
3242 =item open_cust_bill
3244 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3249 sub open_cust_bill {
3253 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3259 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3261 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3265 sub legacy_cust_bill {
3268 #return $self->num_legacy_cust_bill unless wantarray;
3270 map { $_ } #behavior of sort undefined in scalar context
3271 sort { $a->_date <=> $b->_date }
3272 qsearch({ 'table' => 'legacy_cust_bill',
3273 'hashref' => { 'custnum' => $self->custnum, },
3274 'order_by' => 'ORDER BY _date ASC',
3278 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3280 Returns all the statements (see L<FS::cust_statement>) for this customer.
3282 Optionally, a list or hashref of additional arguments to the qsearch call can
3287 =item cust_bill_void
3289 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3293 sub cust_bill_void {
3296 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3297 sort { $a->_date <=> $b->_date }
3298 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3301 sub cust_statement {
3303 my $opt = ref($_[0]) ? shift : { @_ };
3305 #return $self->num_cust_statement unless wantarray || keys %$opt;
3307 $opt->{'table'} = 'cust_statement';
3308 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3309 $opt->{'hashref'}{'custnum'} = $self->custnum;
3310 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3312 map { $_ } #behavior of sort undefined in scalar context
3313 sort { $a->_date <=> $b->_date }
3317 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3319 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3321 Optionally, a list or hashref of additional arguments to the qsearch call can
3322 be passed following the SVCDB.
3329 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3330 warn "$me svc_x requires a svcdb";
3333 my $opt = ref($_[0]) ? shift : { @_ };
3335 $opt->{'table'} = $svcdb;
3336 $opt->{'addl_from'} =
3337 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3338 ($opt->{'addl_from'} || '');
3340 my $custnum = $self->custnum;
3341 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3342 my $where = "cust_pkg.custnum = $custnum";
3344 my $extra_sql = $opt->{'extra_sql'} || '';
3345 if ( keys %{ $opt->{'hashref'} } ) {
3346 $extra_sql = " AND $where $extra_sql";
3349 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3350 $extra_sql = "WHERE $where AND $1";
3353 $extra_sql = "WHERE $where $extra_sql";
3356 $opt->{'extra_sql'} = $extra_sql;
3361 # required for use as an eventtable;
3364 $self->svc_x('svc_acct', @_);
3369 Returns all the credits (see L<FS::cust_credit>) for this customer.
3376 #return $self->num_cust_credit unless wantarray;
3378 map { $_ } #behavior of sort undefined in scalar context
3379 sort { $a->_date <=> $b->_date }
3380 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3383 =item cust_credit_pkgnum
3385 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3386 package when using experimental package balances.
3390 sub cust_credit_pkgnum {
3391 my( $self, $pkgnum ) = @_;
3392 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3393 sort { $a->_date <=> $b->_date }
3394 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3395 'pkgnum' => $pkgnum,
3400 =item cust_credit_void
3402 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3406 sub cust_credit_void {
3409 sort { $a->_date <=> $b->_date }
3410 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3415 Returns all the payments (see L<FS::cust_pay>) for this customer.
3421 my $opt = ref($_[0]) ? shift : { @_ };
3423 return $self->num_cust_pay unless wantarray || keys %$opt;
3425 $opt->{'table'} = 'cust_pay';
3426 $opt->{'hashref'}{'custnum'} = $self->custnum;
3428 map { $_ } #behavior of sort undefined in scalar context
3429 sort { $a->_date <=> $b->_date }
3436 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3437 called automatically when the cust_pay method is used in a scalar context.
3443 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3444 my $sth = dbh->prepare($sql) or die dbh->errstr;
3445 $sth->execute($self->custnum) or die $sth->errstr;
3446 $sth->fetchrow_arrayref->[0];
3449 =item unapplied_cust_pay
3451 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3455 sub unapplied_cust_pay {
3459 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3465 =item cust_pay_pkgnum
3467 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3468 package when using experimental package balances.
3472 sub cust_pay_pkgnum {
3473 my( $self, $pkgnum ) = @_;
3474 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3475 sort { $a->_date <=> $b->_date }
3476 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3477 'pkgnum' => $pkgnum,
3484 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3490 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3491 sort { $a->_date <=> $b->_date }
3492 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3495 =item cust_pay_pending
3497 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3498 (without status "done").
3502 sub cust_pay_pending {
3504 return $self->num_cust_pay_pending unless wantarray;
3505 sort { $a->_date <=> $b->_date }
3506 qsearch( 'cust_pay_pending', {
3507 'custnum' => $self->custnum,
3508 'status' => { op=>'!=', value=>'done' },
3513 =item cust_pay_pending_attempt
3515 Returns all payment attempts / declined payments for this customer, as pending
3516 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3517 a corresponding payment (see L<FS::cust_pay>).
3521 sub cust_pay_pending_attempt {
3523 return $self->num_cust_pay_pending_attempt unless wantarray;
3524 sort { $a->_date <=> $b->_date }
3525 qsearch( 'cust_pay_pending', {
3526 'custnum' => $self->custnum,
3533 =item num_cust_pay_pending
3535 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3536 customer (without status "done"). Also called automatically when the
3537 cust_pay_pending method is used in a scalar context.
3541 sub num_cust_pay_pending {
3544 " SELECT COUNT(*) FROM cust_pay_pending ".
3545 " WHERE custnum = ? AND status != 'done' ",
3550 =item num_cust_pay_pending_attempt
3552 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3553 customer, with status "done" but without a corresp. Also called automatically when the
3554 cust_pay_pending method is used in a scalar context.
3558 sub num_cust_pay_pending_attempt {
3561 " SELECT COUNT(*) FROM cust_pay_pending ".
3562 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3569 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3575 map { $_ } #return $self->num_cust_refund unless wantarray;
3576 sort { $a->_date <=> $b->_date }
3577 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3580 =item display_custnum
3582 Returns the displayed customer number for this customer: agent_custid if
3583 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3587 sub display_custnum {
3590 return $self->agent_custid
3591 if $default_agent_custid && $self->agent_custid;
3593 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3597 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3598 } elsif ( $custnum_display_length ) {
3599 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3601 return $self->custnum;
3607 Returns a name string for this customer, either "Company (Last, First)" or
3614 my $name = $self->contact;
3615 $name = $self->company. " ($name)" if $self->company;
3619 =item service_contact
3621 Returns the L<FS::contact> object for this customer that has the 'Service'
3622 contact class, or undef if there is no such contact. Deprecated; don't use
3627 sub service_contact {
3629 if ( !exists($self->{service_contact}) ) {
3630 my $classnum = $self->scalar_sql(
3631 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3632 ) || 0; #if it's zero, qsearchs will return nothing
3633 my $cust_contact = qsearchs('cust_contact', {
3634 'classnum' => $classnum,
3635 'custnum' => $self->custnum,
3637 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3639 $self->{service_contact};
3644 Returns a name string for this (service/shipping) contact, either
3645 "Company (Last, First)" or "Last, First".
3652 my $name = $self->ship_contact;
3653 $name = $self->company. " ($name)" if $self->company;
3659 Returns a name string for this customer, either "Company" or "First Last".
3665 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3668 =item ship_name_short
3670 Returns a name string for this (service/shipping) contact, either "Company"
3675 sub ship_name_short {
3677 $self->service_contact
3678 ? $self->ship_contact_firstlast
3684 Returns this customer's full (billing) contact name only, "Last, First"
3690 $self->get('last'). ', '. $self->first;
3695 Returns this customer's full (shipping) contact name only, "Last, First"
3701 my $contact = $self->service_contact || $self;
3702 $contact->get('last') . ', ' . $contact->get('first');
3705 =item contact_firstlast
3707 Returns this customers full (billing) contact name only, "First Last".
3711 sub contact_firstlast {
3713 $self->first. ' '. $self->get('last');
3716 =item ship_contact_firstlast
3718 Returns this customer's full (shipping) contact name only, "First Last".
3722 sub ship_contact_firstlast {
3724 my $contact = $self->service_contact || $self;
3725 $contact->get('first') . ' '. $contact->get('last');
3728 sub bill_country_full {
3730 $self->bill_location->country_full;
3733 sub ship_country_full {
3735 $self->ship_location->country_full;
3738 =item county_state_county [ PREFIX ]
3740 Returns a string consisting of just the county, state and country.
3744 sub county_state_country {
3747 if ( @_ && $_[0] && $self->has_ship_address ) {
3748 $locationnum = $self->ship_locationnum;
3750 $locationnum = $self->bill_locationnum;
3752 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3753 $cust_location->county_state_country;
3756 =item geocode DATA_VENDOR
3758 Returns a value for the customer location as encoded by DATA_VENDOR.
3759 Currently this only makes sense for "CCH" as DATA_VENDOR.
3767 Returns a status string for this customer, currently:
3773 No packages have ever been ordered. Displayed as "No packages".
3777 Recurring packages all are new (not yet billed).
3781 One or more recurring packages is active.
3785 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3789 All non-cancelled recurring packages are suspended.
3793 All recurring packages are cancelled.
3797 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3798 cust_main-status_module configuration option.
3802 sub status { shift->cust_status(@_); }
3806 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3807 for my $status ( FS::cust_main->statuses() ) {
3808 my $method = $status.'_sql';
3809 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3810 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3811 $sth->execute( ($self->custnum) x $numnum )
3812 or die "Error executing 'SELECT $sql': ". $sth->errstr;
3813 if ( $sth->fetchrow_arrayref->[0] ) {
3814 $self->hashref->{cust_status} = $status;
3820 =item is_status_delay_cancel
3822 Returns true if customer status is 'suspended'
3823 and all suspended cust_pkg return true for
3824 cust_pkg->is_status_delay_cancel.
3826 This is not a real status, this only meant for hacking display
3827 values, because otherwise treating the customer as suspended is
3828 really the whole point of the delay_cancel option.
3832 sub is_status_delay_cancel {
3834 return 0 unless $self->status eq 'suspended';
3835 foreach my $cust_pkg ($self->ncancelled_pkgs) {
3836 return 0 unless $cust_pkg->is_status_delay_cancel;
3841 =item ucfirst_cust_status
3843 =item ucfirst_status
3845 Deprecated, use the cust_status_label method instead.
3847 Returns the status with the first character capitalized.
3851 sub ucfirst_status {
3852 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3853 local($ucfirst_nowarn) = 1;
3854 shift->ucfirst_cust_status(@_);
3857 sub ucfirst_cust_status {
3858 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
3860 ucfirst($self->cust_status);
3863 =item cust_status_label
3867 Returns the display label for this status.
3871 sub status_label { shift->cust_status_label(@_); }
3873 sub cust_status_label {
3875 __PACKAGE__->statuslabels->{$self->cust_status};
3880 Returns a hex triplet color string for this customer's status.
3884 sub statuscolor { shift->cust_statuscolor(@_); }
3886 sub cust_statuscolor {
3888 __PACKAGE__->statuscolors->{$self->cust_status};
3891 =item tickets [ STATUS ]
3893 Returns an array of hashes representing the customer's RT tickets.
3895 An optional status (or arrayref or hashref of statuses) may be specified.
3901 my $status = ( @_ && $_[0] ) ? shift : '';
3903 my $num = $conf->config('cust_main-max_tickets') || 10;
3906 if ( $conf->config('ticket_system') ) {
3907 unless ( $conf->config('ticket_system-custom_priority_field') ) {
3909 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
3918 foreach my $priority (
3919 $conf->config('ticket_system-custom_priority_field-values'), ''
3921 last if scalar(@tickets) >= $num;
3923 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3924 $num - scalar(@tickets),
3935 =item appointments [ STATUS ]
3937 Returns an array of hashes representing the customer's RT tickets which
3944 my $status = ( @_ && $_[0] ) ? shift : '';
3946 return () unless $conf->config('ticket_system');
3948 my $queueid = $conf->config('ticket_system-appointment-queueid');
3950 @{ FS::TicketSystem->customer_tickets( $self->custnum,
3959 # Return services representing svc_accts in customer support packages
3960 sub support_services {
3962 my %packages = map { $_ => 1 } $conf->config('support_packages');
3964 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
3965 grep { $_->part_svc->svcdb eq 'svc_acct' }
3966 map { $_->cust_svc }
3967 grep { exists $packages{ $_->pkgpart } }
3968 $self->ncancelled_pkgs;
3972 # Return a list of latitude/longitude for one of the services (if any)
3973 sub service_coordinates {
3977 grep { $_->latitude && $_->longitude }
3979 map { $_->cust_svc }
3980 $self->ncancelled_pkgs;
3982 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
3987 Returns a masked version of the named field
3992 my ($self,$field) = @_;
3996 'x'x(length($self->getfield($field))-4).
3997 substr($self->getfield($field), (length($self->getfield($field))-4));
4001 =item payment_history
4003 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4004 cust_credit and cust_refund objects. Each hashref has the following fields:
4006 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4008 I<date> - value of _date field, unix timestamp
4010 I<date_pretty> - user-friendly date
4012 I<description> - user-friendly description of item
4014 I<amount> - impact of item on user's balance
4015 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4016 Not to be confused with the native 'amount' field in cust_credit, see below.
4018 I<amount_pretty> - includes money char
4020 I<balance> - customer balance, chronologically as of this item
4022 I<balance_pretty> - includes money char
4024 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4026 I<paid> - amount paid for cust_pay records, undef for other types
4028 I<credit> - amount credited for cust_credit records, undef for other types.
4029 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4031 I<refund> - amount refunded for cust_refund records, undef for other types
4033 The four table-specific keys always have positive values, whether they reflect charges or payments.
4035 The following options may be passed to this method:
4037 I<line_items> - if true, returns charges ('Line item') rather than invoices
4039 I<start_date> - unix timestamp, only include records on or after.
4040 If specified, an item of type 'Previous' will also be included.
4041 It does not have table-specific fields.
4043 I<end_date> - unix timestamp, only include records before
4045 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4047 I<conf> - optional already-loaded FS::Conf object.
4051 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4052 # and also for sending customer statements, which should both be kept customer-friendly.
4053 # If you add anything that shouldn't be passed on through the API or exposed
4054 # to customers, add a new option to include it, don't include it by default
4055 sub payment_history {
4057 my $opt = ref($_[0]) ? $_[0] : { @_ };
4059 my $conf = $$opt{'conf'} || new FS::Conf;
4060 my $money_char = $conf->config("money_char") || '$',
4062 #first load entire history,
4063 #need previous to calculate previous balance
4064 #loading after end_date shouldn't hurt too much?
4066 if ( $$opt{'line_items'} ) {
4068 foreach my $cust_bill ( $self->cust_bill ) {
4071 'type' => 'Line item',
4072 'description' => $_->desc( $self->locale ).
4073 ( $_->sdate && $_->edate
4074 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4075 ' To '. time2str('%d-%b-%Y', $_->edate)
4078 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4079 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4080 'date' => $cust_bill->_date,
4081 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4083 foreach $cust_bill->cust_bill_pkg;
4090 'type' => 'Invoice',
4091 'description' => 'Invoice #'. $_->display_invnum,
4092 'amount' => sprintf('%.2f', $_->charged ),
4093 'charged' => sprintf('%.2f', $_->charged ),
4094 'date' => $_->_date,
4095 'date_pretty' => $self->time2str_local('short', $_->_date ),
4097 foreach $self->cust_bill;
4102 'type' => 'Payment',
4103 'description' => 'Payment', #XXX type
4104 'amount' => sprintf('%.2f', 0 - $_->paid ),
4105 'paid' => sprintf('%.2f', $_->paid ),
4106 'date' => $_->_date,
4107 'date_pretty' => $self->time2str_local('short', $_->_date ),
4109 foreach $self->cust_pay;
4113 'description' => 'Credit', #more info?
4114 'amount' => sprintf('%.2f', 0 -$_->amount ),
4115 'credit' => sprintf('%.2f', $_->amount ),
4116 'date' => $_->_date,
4117 'date_pretty' => $self->time2str_local('short', $_->_date ),
4119 foreach $self->cust_credit;
4123 'description' => 'Refund', #more info? type, like payment?
4124 'amount' => $_->refund,
4125 'refund' => $_->refund,
4126 'date' => $_->_date,
4127 'date_pretty' => $self->time2str_local('short', $_->_date ),
4129 foreach $self->cust_refund;
4131 #put it all in chronological order
4132 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4134 #calculate balance, filter items outside date range
4138 foreach my $item (@history) {
4139 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4140 $balance += $$item{'amount'};
4141 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4142 $previous += $$item{'amount'};
4145 $$item{'balance'} = sprintf("%.2f",$balance);
4146 foreach my $key ( qw(amount balance) ) {
4147 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4152 # start with previous balance, if there was one
4155 'type' => 'Previous',
4156 'description' => 'Previous balance',
4157 'amount' => sprintf("%.2f",$previous),
4158 'balance' => sprintf("%.2f",$previous),
4159 'date' => $$opt{'start_date'},
4160 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4162 #false laziness with above
4163 foreach my $key ( qw(amount balance) ) {
4164 $$item{$key.'_pretty'} = $$item{$key};
4165 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4167 unshift(@out,$item);
4170 @out = reverse @history if $$opt{'reverse_sort'};
4175 =item save_cust_payby
4177 Saves a new cust_payby for this customer, replacing an existing entry only
4178 in select circumstances. Does not validate input.
4180 If auto is specified, marks this as the customer's primary method, or the
4181 specified weight. Existing payment methods have their weight incremented as
4184 If bill_location is specified with auto, also sets location in cust_main.
4186 Will not insert complete duplicates of existing records, or records in which the
4187 only difference from an existing record is to turn off automatic payment (will
4188 return without error.) Will replace existing records in which the only difference
4189 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4190 Fields marked as preserved are optional, and existing values will not be overwritten with
4191 blanks when replacing.
4193 Accepts the following named parameters:
4203 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4207 optional, set higher than 1 for secondary, etc.
4215 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4223 optional, will be preserved when replacing
4231 CARD only, required, FS::cust_location object
4233 =item paystart_month
4235 CARD only, optional, will be preserved when replacing
4239 CARD only, optional, will be preserved when replacing
4243 CARD only, optional, will be preserved when replacing
4247 CARD only, only used if conf cvv-save is set appropriately
4261 #The code for this option is in place, but it's not currently used
4265 # existing cust_payby object to be replaced (must match custnum)
4267 # stateid/stateid_state/ss are not currently supported in cust_payby,
4268 # might not even work properly in 4.x, but will need to work here if ever added
4270 sub save_cust_payby {
4274 my $old = $opt{'replace'};
4275 my $new = new FS::cust_payby { $old ? $old->hash : () };
4276 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4277 $new->set( 'custnum' => $self->custnum );
4279 my $payby = $opt{'payment_payby'};
4280 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4282 # don't allow turning off auto when replacing
4283 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4285 my @check_existing; # payby relevant to this payment_payby
4287 # set payby based on auto
4288 if ( $payby eq 'CARD' ) {
4289 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4290 @check_existing = qw( CARD DCRD );
4291 } elsif ( $payby eq 'CHEK' ) {
4292 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4293 @check_existing = qw( CHEK DCHK );
4296 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4299 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4300 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4301 $new->set( 'payname' => $opt{'payname'} );
4302 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4304 my $conf = new FS::Conf;
4306 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4307 if ( $payby eq 'CARD' &&
4308 grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save') ) {
4309 $new->set( 'paycvv' => $opt{'paycvv'} );
4311 $new->set( 'paycvv' => '');
4314 local $SIG{HUP} = 'IGNORE';
4315 local $SIG{INT} = 'IGNORE';
4316 local $SIG{QUIT} = 'IGNORE';
4317 local $SIG{TERM} = 'IGNORE';
4318 local $SIG{TSTP} = 'IGNORE';
4319 local $SIG{PIPE} = 'IGNORE';
4321 my $oldAutoCommit = $FS::UID::AutoCommit;
4322 local $FS::UID::AutoCommit = 0;
4325 # set fields specific to payment_payby
4326 if ( $payby eq 'CARD' ) {
4327 if ($opt{'bill_location'}) {
4328 $opt{'bill_location'}->set('custnum' => $self->custnum);
4329 my $error = $opt{'bill_location'}->find_or_insert;
4331 $dbh->rollback if $oldAutoCommit;
4334 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4336 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4337 $new->set( $field => $opt{$field} );
4340 foreach my $field ( qw(paytype paystate) ) {
4341 $new->set( $field => $opt{$field} );
4345 # other cust_payby to compare this to
4346 my @existing = $self->cust_payby(@check_existing);
4348 # fields that can overwrite blanks with values, but not values with blanks
4349 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4351 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4353 # generally, we don't want to overwrite existing cust_payby with this,
4354 # but we can replace if we're only marking it auto or adding a preserved field
4355 # and we can avoid saving a total duplicate or merely turning off auto
4357 foreach my $cust_payby (@existing) {
4358 # check fields that absolutely should not change
4359 foreach my $field ($new->fields) {
4360 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4361 next if grep(/^$field$/, @preserve );
4362 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4364 # now check fields that can replace if one value is blank
4366 foreach my $field (@preserve) {
4368 ( $new->get($field) and !$cust_payby->get($field) ) or
4369 ( $cust_payby->get($field) and !$new->get($field) )
4371 # prevention of overwriting values with blanks happens farther below
4373 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4377 unless ( $replace ) {
4378 # nearly identical, now check weight
4379 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4380 # ignore identical cust_payby, and ignore attempts to turn off auto
4381 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4382 $skip_cust_payby = 1;
4385 # otherwise, only change is to mark this as primary
4387 # if we got this far, we're definitely replacing
4394 $new->set( 'custpaybynum' => $old->custpaybynum );
4395 # don't turn off automatic payment (but allow it to be turned on)
4396 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4398 $new->set( 'payby' => $old->payby );
4399 $new->set( 'weight' => 1 );
4401 # make sure we're not overwriting values with blanks
4402 foreach my $field (@preserve) {
4403 if ( $old->get($field) and !$new->get($field) ) {
4404 $new->set( $field => $old->get($field) );
4409 # only overwrite cust_main bill_location if auto
4410 if ($opt{'auto'} && $opt{'bill_location'}) {
4411 $self->set('bill_location' => $opt{'bill_location'});
4412 my $error = $self->replace;
4414 $dbh->rollback if $oldAutoCommit;
4419 # done with everything except reweighting and saving cust_payby
4420 # still need to commit changes to cust_main and cust_location
4421 if ($skip_cust_payby) {
4422 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4426 # re-weight existing primary cust_pay for this payby
4428 foreach my $cust_payby (@existing) {
4429 # relies on cust_payby return order
4430 last unless $cust_payby->payby !~ /^D/;
4431 last if $cust_payby->weight > 1;
4432 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4433 next if $cust_payby->weight < ($opt{'weight'} || 1);
4434 $cust_payby->weight( $cust_payby->weight + 1 );
4435 my $error = $cust_payby->replace;
4437 $dbh->rollback if $oldAutoCommit;
4438 return "Error reweighting cust_payby: $error";
4443 # finally, save cust_payby
4444 my $error = $old ? $new->replace($old) : $new->insert;
4446 $dbh->rollback if $oldAutoCommit;
4450 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4457 =head1 CLASS METHODS
4463 Class method that returns the list of possible status strings for customers
4464 (see L<the status method|/status>). For example:
4466 @statuses = FS::cust_main->statuses();
4472 keys %{ $self->statuscolors };
4475 =item cust_status_sql
4477 Returns an SQL fragment to determine the status of a cust_main record, as a
4482 sub cust_status_sql {
4484 for my $status ( FS::cust_main->statuses() ) {
4485 my $method = $status.'_sql';
4486 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4495 Returns an SQL expression identifying prospective cust_main records (customers
4496 with no packages ever ordered)
4500 use vars qw($select_count_pkgs);
4501 $select_count_pkgs =
4502 "SELECT COUNT(*) FROM cust_pkg
4503 WHERE cust_pkg.custnum = cust_main.custnum";
4505 sub select_count_pkgs_sql {
4510 " 0 = ( $select_count_pkgs ) ";
4515 Returns an SQL expression identifying ordered cust_main records (customers with
4516 no active packages, but recurring packages not yet setup or one time charges
4522 FS::cust_main->none_active_sql.
4523 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4528 Returns an SQL expression identifying active cust_main records (customers with
4529 active recurring packages).
4534 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4537 =item none_active_sql
4539 Returns an SQL expression identifying cust_main records with no active
4540 recurring packages. This includes customers of status prospect, ordered,
4541 inactive, and suspended.
4545 sub none_active_sql {
4546 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4551 Returns an SQL expression identifying inactive cust_main records (customers with
4552 no active recurring packages, but otherwise unsuspended/uncancelled).
4557 FS::cust_main->none_active_sql.
4558 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4564 Returns an SQL expression identifying suspended cust_main records.
4569 sub suspended_sql { susp_sql(@_); }
4571 FS::cust_main->none_active_sql.
4572 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4578 Returns an SQL expression identifying cancelled cust_main records.
4582 sub cancel_sql { shift->cancelled_sql(@_); }
4585 =item uncancelled_sql
4587 Returns an SQL expression identifying un-cancelled cust_main records.
4591 sub uncancelled_sql { uncancel_sql(@_); }
4592 sub uncancel_sql { "
4593 ( 0 < ( $select_count_pkgs
4594 AND ( cust_pkg.cancel IS NULL
4595 OR cust_pkg.cancel = 0
4598 OR 0 = ( $select_count_pkgs )
4604 Returns an SQL fragment to retreive the balance.
4609 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4610 WHERE cust_bill.custnum = cust_main.custnum )
4611 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4612 WHERE cust_pay.custnum = cust_main.custnum )
4613 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4614 WHERE cust_credit.custnum = cust_main.custnum )
4615 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4616 WHERE cust_refund.custnum = cust_main.custnum )
4619 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4621 Returns an SQL fragment to retreive the balance for this customer, optionally
4622 considering invoices with date earlier than START_TIME, and not
4623 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4624 total_unapplied_payments).
4626 Times are specified as SQL fragments or numeric
4627 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4628 L<Date::Parse> for conversion functions. The empty string can be passed
4629 to disable that time constraint completely.
4631 Available options are:
4635 =item unapplied_date
4637 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)
4642 set to true to remove all customer comparison clauses, for totals
4647 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4652 JOIN clause (typically used with the total option)
4656 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4657 time will be ignored. Note that START_TIME and END_TIME only limit the date
4658 range for invoices and I<unapplied> payments, credits, and refunds.
4664 sub balance_date_sql {
4665 my( $class, $start, $end, %opt ) = @_;
4667 my $cutoff = $opt{'cutoff'};
4669 my $owed = FS::cust_bill->owed_sql($cutoff);
4670 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4671 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4672 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4674 my $j = $opt{'join'} || '';
4676 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4677 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4678 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4679 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4681 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4682 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4683 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4684 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4689 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4691 Returns an SQL fragment to retreive the total unapplied payments for this
4692 customer, only considering payments with date earlier than START_TIME, and
4693 optionally not later than END_TIME.
4695 Times are specified as SQL fragments or numeric
4696 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4697 L<Date::Parse> for conversion functions. The empty string can be passed
4698 to disable that time constraint completely.
4700 Available options are:
4704 sub unapplied_payments_date_sql {
4705 my( $class, $start, $end, %opt ) = @_;
4707 my $cutoff = $opt{'cutoff'};
4709 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4711 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4712 'unapplied_date'=>1 );
4714 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4717 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4719 Helper method for balance_date_sql; name (and usage) subject to change
4720 (suggestions welcome).
4722 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4723 cust_refund, cust_credit or cust_pay).
4725 If TABLE is "cust_bill" or the unapplied_date option is true, only
4726 considers records with date earlier than START_TIME, and optionally not
4727 later than END_TIME .
4731 sub _money_table_where {
4732 my( $class, $table, $start, $end, %opt ) = @_;
4735 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4736 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4737 push @where, "$table._date <= $start" if defined($start) && length($start);
4738 push @where, "$table._date > $end" if defined($end) && length($end);
4740 push @where, @{$opt{'where'}} if $opt{'where'};
4741 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4747 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4748 use FS::cust_main::Search;
4751 FS::cust_main::Search->search(@_);
4760 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4762 Generates a templated notification to the customer (see L<Text::Template>).
4764 OPTIONS is a hash and may include
4766 I<extra_fields> - a hashref of name/value pairs which will be substituted
4767 into the template. These values may override values mentioned below
4768 and those from the customer record.
4770 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4772 The following variables are available in the template instead of or in addition
4773 to the fields of the customer record.
4775 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4779 # a lot like cust_bill::print_latex
4780 sub generate_letter {
4781 my ($self, $template, %options) = @_;
4783 warn "Template $template does not exist" && return
4784 unless $conf->exists($template) || $options{'template_text'};
4786 my $template_source = $options{'template_text'}
4787 ? [ $options{'template_text'} ]
4788 : [ map "$_\n", $conf->config($template) ];
4790 my $letter_template = new Text::Template
4792 SOURCE => $template_source,
4793 DELIMITERS => [ '[@--', '--@]' ],
4795 or die "can't create new Text::Template object: Text::Template::ERROR";
4797 $letter_template->compile()
4798 or die "can't compile template: Text::Template::ERROR";
4800 my %letter_data = map { $_ => $self->$_ } $self->fields;
4802 for (keys %{$options{extra_fields}}){
4803 $letter_data{$_} = $options{extra_fields}->{$_};
4806 unless(exists($letter_data{returnaddress})){
4807 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4808 $self->agent_template)
4810 if ( length($retadd) ) {
4811 $letter_data{returnaddress} = $retadd;
4812 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4813 $letter_data{returnaddress} =
4814 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4818 ( $conf->config('company_name', $self->agentnum),
4819 $conf->config('company_address', $self->agentnum),
4823 $letter_data{returnaddress} = '~';
4827 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4829 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4831 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4833 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4837 ) or die "can't open temp file: $!\n";
4838 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4839 or die "can't write temp file: $!\n";
4841 $letter_data{'logo_file'} = $lh->filename;
4843 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4847 ) or die "can't open temp file: $!\n";
4849 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4851 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4852 return ($1, $letter_data{'logo_file'});
4856 =item print_ps TEMPLATE
4858 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4864 my($file, $lfile) = $self->generate_letter(@_);
4865 my $ps = FS::Misc::generate_ps($file);
4866 unlink($file.'.tex');
4872 =item print TEMPLATE
4874 Prints the filled in template.
4876 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4880 sub queueable_print {
4883 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4884 or die "invalid customer number: " . $opt{custnum};
4886 #do not backport this change to 3.x
4887 # my $error = $self->print( { 'template' => $opt{template} } );
4888 my $error = $self->print( $opt{'template'} );
4889 die $error if $error;
4893 my ($self, $template) = (shift, shift);
4895 [ $self->print_ps($template) ],
4896 'agentnum' => $self->agentnum,
4900 #these three subs should just go away once agent stuff is all config overrides
4902 sub agent_template {
4904 $self->_agent_plandata('agent_templatename');
4907 sub agent_invoice_from {
4909 $self->_agent_plandata('agent_invoice_from');
4912 sub _agent_plandata {
4913 my( $self, $option ) = @_;
4915 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4916 #agent-specific Conf
4918 use FS::part_event::Condition;
4920 my $agentnum = $self->agentnum;
4922 my $regexp = regexp_sql();
4924 my $part_event_option =
4926 'select' => 'part_event_option.*',
4927 'table' => 'part_event_option',
4929 LEFT JOIN part_event USING ( eventpart )
4930 LEFT JOIN part_event_option AS peo_agentnum
4931 ON ( part_event.eventpart = peo_agentnum.eventpart
4932 AND peo_agentnum.optionname = 'agentnum'
4933 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4935 LEFT JOIN part_event_condition
4936 ON ( part_event.eventpart = part_event_condition.eventpart
4937 AND part_event_condition.conditionname = 'cust_bill_age'
4939 LEFT JOIN part_event_condition_option
4940 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4941 AND part_event_condition_option.optionname = 'age'
4944 #'hashref' => { 'optionname' => $option },
4945 #'hashref' => { 'part_event_option.optionname' => $option },
4947 " WHERE part_event_option.optionname = ". dbh->quote($option).
4948 " AND action = 'cust_bill_send_agent' ".
4949 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4950 " AND peo_agentnum.optionname = 'agentnum' ".
4951 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4953 CASE WHEN part_event_condition_option.optionname IS NULL
4955 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4957 , part_event.weight".
4961 unless ( $part_event_option ) {
4962 return $self->agent->invoice_template || ''
4963 if $option eq 'agent_templatename';
4967 $part_event_option->optionvalue;
4971 sub process_o2m_qsearch {
4974 return qsearch($table, @_) unless $table eq 'contact';
4976 my $hashref = shift;
4977 my %hash = %$hashref;
4978 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
4979 or die 'guru meditation #4343';
4981 qsearch({ 'table' => 'contact',
4982 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
4983 'hashref' => \%hash,
4984 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
4985 " cust_contact.custnum = $custnum "
4989 sub process_o2m_qsearchs {
4992 return qsearchs($table, @_) unless $table eq 'contact';
4994 my $hashref = shift;
4995 my %hash = %$hashref;
4996 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
4997 or die 'guru meditation #2121';
4999 qsearchs({ 'table' => 'contact',
5000 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5001 'hashref' => \%hash,
5002 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5003 " cust_contact.custnum = $custnum "
5007 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5009 Subroutine (not a method), designed to be called from the queue.
5011 Takes a list of options and values.
5013 Pulls up the customer record via the custnum option and calls bill_and_collect.
5018 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5020 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5021 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5023 #without this errors don't get rolled back
5024 $args{'fatal'} = 1; # runs from job queue, will be caught
5026 $cust_main->bill_and_collect( %args );
5029 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5031 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5032 C<collect> part. This is used in batch tax calculation, where invoice
5033 generation and collection events have to be completely separated.
5037 sub queued_collect {
5039 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5041 $cust_main->collect(%args);
5044 sub process_bill_and_collect {
5047 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5048 or die "custnum '$param->{custnum}' not found!\n";
5049 $param->{'job'} = $job;
5050 $param->{'fatal'} = 1; # runs from job queue, will be caught
5051 $param->{'retry'} = 1;
5053 $cust_main->bill_and_collect( %$param );
5056 #starting to take quite a while for big dbs
5057 # (JRNL: journaled so it only happens once per database)
5058 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5059 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5060 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5061 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5062 # JRNL leading/trailing spaces in first, last, company
5063 # JRNL migrate to cust_payby
5064 # - otaker upgrade? journal and call it good? (double check to make sure
5065 # we're not still setting otaker here)
5067 #only going to get worse with new location stuff...
5069 sub _upgrade_data { #class method
5070 my ($class, %opts) = @_;
5072 my @statements = ();
5074 #this seems to be the only expensive one.. why does it take so long?
5075 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5077 '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';
5078 FS::upgrade_journal->set_done('cust_main__signupdate');
5082 foreach my $sql ( @statements ) {
5083 my $sth = dbh->prepare($sql) or die dbh->errstr;
5084 $sth->execute or die $sth->errstr;
5085 #warn ( (time - $t). " seconds\n" );
5089 local($ignore_expired_card) = 1;
5090 local($ignore_banned_card) = 1;
5091 local($skip_fuzzyfiles) = 1;
5092 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5094 FS::cust_main::Location->_upgrade_data(%opts);
5096 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5098 foreach my $cust_main ( qsearch({
5099 'table' => 'cust_main',
5101 'extra_sql' => 'WHERE '.
5103 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5104 qw( first last company )
5107 my $error = $cust_main->replace;
5108 die $error if $error;
5111 FS::upgrade_journal->set_done('cust_main__trimspaces');
5115 $class->_upgrade_otaker(%opts);
5125 The delete method should possibly take an FS::cust_main object reference
5126 instead of a scalar customer number.
5128 Bill and collect options should probably be passed as references instead of a
5131 There should probably be a configuration file with a list of allowed credit
5134 No multiple currency support (probably a larger project than just this module).
5136 Birthdates rely on negative epoch values.
5138 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5142 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5143 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5144 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.