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::payinfo_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
83 # 1 is mostly method/subroutine entry and options
84 # 2 traces progress of some operations
85 # 3 is even more information including possibly sensitive data
87 our $me = '[FS::cust_main]';
90 our $ignore_expired_card = 0;
91 our $ignore_banned_card = 0;
92 our $ignore_invalid_card = 0;
94 our $skip_fuzzyfiles = 0;
96 our $ucfirst_nowarn = 0;
98 #this info is in cust_payby as of 4.x
99 #this and the fields themselves can be removed in 5.x
100 our @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
104 our $default_agent_custid;
105 our $custnum_display_length;
106 #ask FS::UID to run this stuff for us later
107 #$FS::UID::callback{'FS::cust_main'} = sub {
108 install_callback FS::UID sub {
109 $conf = new FS::Conf;
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
112 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
117 my ( $hashref, $cache ) = @_;
118 if ( exists $hashref->{'pkgnum'} ) {
119 #@{ $self->{'_pkgnum'} } = ();
120 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
121 $self->{'_pkgnum'} = $subcache;
122 #push @{ $self->{'_pkgnum'} },
123 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
129 FS::cust_main - Object methods for cust_main records
135 $record = new FS::cust_main \%hash;
136 $record = new FS::cust_main { 'column' => 'value' };
138 $error = $record->insert;
140 $error = $new_record->replace($old_record);
142 $error = $record->delete;
144 $error = $record->check;
146 @cust_pkg = $record->all_pkgs;
148 @cust_pkg = $record->ncancelled_pkgs;
150 @cust_pkg = $record->suspended_pkgs;
152 $error = $record->bill;
153 $error = $record->bill %options;
154 $error = $record->bill 'time' => $time;
156 $error = $record->collect;
157 $error = $record->collect %options;
158 $error = $record->collect 'invoice_time' => $time,
163 An FS::cust_main object represents a customer. FS::cust_main inherits from
164 FS::Record. The following fields are currently supported:
170 Primary key (assigned automatically for new customers)
174 Agent (see L<FS::agent>)
178 Advertising source (see L<FS::part_referral>)
190 Cocial security number (optional)
214 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
218 Payment Information (See L<FS::payinfo_Mixin> for data format)
222 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
226 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
230 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
234 Start date month (maestro/solo cards only)
238 Start date year (maestro/solo cards only)
242 Issue number (maestro/solo cards only)
246 Name on card or billing name
250 IP address from which payment information was received
254 Tax exempt, empty or `Y'
258 Order taker (see L<FS::access_user>)
264 =item referral_custnum
266 Referring customer number
270 Enable individual CDR spooling, empty or `Y'
274 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
278 Discourage individual CDR printing, empty or `Y'
282 Allow self-service editing of ticket subjects, empty or 'Y'
284 =item calling_list_exempt
286 Do not call, empty or 'Y'
288 =item invoice_ship_address
290 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
300 Creates a new customer. To add the customer to the database, see L<"insert">.
302 Note that this stores the hash reference, not a distinct copy of the hash it
303 points to. You can ask the object for a copy with the I<hash> method.
307 sub table { 'cust_main'; }
309 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
311 Adds this customer to the database. If there is an error, returns the error,
312 otherwise returns false.
314 Usually the customer's location will not yet exist in the database, and
315 the C<bill_location> and C<ship_location> pseudo-fields must be set to
316 uninserted L<FS::cust_location> objects. These will be inserted and linked
317 (in both directions) to the new customer record. If they're references
318 to the same object, they will become the same location.
320 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
321 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
322 are inserted atomicly, or the transaction is rolled back. Passing an empty
323 hash reference is equivalent to not supplying this parameter. There should be
324 a better explanation of this, but until then, here's an example:
327 tie %hash, 'Tie::RefHash'; #this part is important
329 $cust_pkg => [ $svc_acct ],
332 $cust_main->insert( \%hash );
334 INVOICING_LIST_ARYREF: No longer supported.
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
358 unset), inserts those new contacts with this new customer. Handles CGI
359 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
361 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
362 new stored payment records with this new customer. Handles CGI parameters
363 for an "m2" multiple entry field as passed by edit/cust_main.cgi
369 my $cust_pkgs = @_ ? shift : {};
371 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
372 warn "cust_main::insert using deprecated invoicing list argument";
373 $invoicing_list = shift;
376 warn "$me insert called with options ".
377 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380 return "You are not permitted to change customer invoicing terms."
381 if $self->invoice_terms #i.e. not the default
382 && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
384 local $SIG{HUP} = 'IGNORE';
385 local $SIG{INT} = 'IGNORE';
386 local $SIG{QUIT} = 'IGNORE';
387 local $SIG{TERM} = 'IGNORE';
388 local $SIG{TSTP} = 'IGNORE';
389 local $SIG{PIPE} = 'IGNORE';
391 my $oldAutoCommit = $FS::UID::AutoCommit;
392 local $FS::UID::AutoCommit = 0;
395 my $prepay_identifier = '';
396 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
398 if ( $self->payby eq 'PREPAY' ) {
400 $self->payby(''); #'BILL');
401 $prepay_identifier = $self->payinfo;
404 warn " looking up prepaid card $prepay_identifier\n"
407 my $error = $self->get_prepay( $prepay_identifier,
408 'amount_ref' => \$amount,
409 'seconds_ref' => \$seconds,
410 'upbytes_ref' => \$upbytes,
411 'downbytes_ref' => \$downbytes,
412 'totalbytes_ref' => \$totalbytes,
415 $dbh->rollback if $oldAutoCommit;
416 #return "error applying prepaid card (transaction rolled back): $error";
420 $payby = 'PREP' if $amount;
422 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
425 $self->payby(''); #'BILL');
426 $amount = $self->paid;
431 foreach my $l (qw(bill_location ship_location)) {
433 my $loc = delete $self->hashref->{$l} or next;
435 if ( !$loc->locationnum ) {
436 # warn the location that we're going to insert it with no custnum
437 $loc->set(custnum_pending => 1);
438 warn " inserting $l\n"
440 my $error = $loc->insert;
442 $dbh->rollback if $oldAutoCommit;
443 my $label = $l eq 'ship_location' ? 'service' : 'billing';
444 return "$error (in $label location)";
447 } elsif ( $loc->prospectnum ) {
449 $loc->prospectnum('');
450 $loc->set(custnum_pending => 1);
451 my $error = $loc->replace;
453 $dbh->rollback if $oldAutoCommit;
454 my $label = $l eq 'ship_location' ? 'service' : 'billing';
455 return "$error (moving $label location)";
458 } elsif ( ($loc->custnum || 0) > 0 ) {
459 # then it somehow belongs to another customer--shouldn't happen
460 $dbh->rollback if $oldAutoCommit;
461 return "$l belongs to customer ".$loc->custnum;
463 # else it already belongs to this customer
464 # (happens when ship_location is identical to bill_location)
466 $self->set($l.'num', $loc->locationnum);
468 if ( $self->get($l.'num') eq '' ) {
469 $dbh->rollback if $oldAutoCommit;
474 warn " inserting $self\n"
477 $self->signupdate(time) unless $self->signupdate;
479 $self->auto_agent_custid()
480 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
482 my $error = $self->check_payinfo_cardtype
483 || $self->SUPER::insert;
485 $dbh->rollback if $oldAutoCommit;
486 #return "inserting cust_main record (transaction rolled back): $error";
490 # now set cust_location.custnum
491 foreach my $l (qw(bill_location ship_location)) {
492 warn " setting $l.custnum\n"
494 my $loc = $self->$l or next;
495 unless ( $loc->custnum ) {
496 $loc->set(custnum => $self->custnum);
497 $error ||= $loc->replace;
501 $dbh->rollback if $oldAutoCommit;
502 return "error setting $l custnum: $error";
506 warn " setting customer tags\n"
509 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
510 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
511 'custnum' => $self->custnum };
512 my $error = $cust_tag->insert;
514 $dbh->rollback if $oldAutoCommit;
519 my $prospectnum = delete $options{'prospectnum'};
520 if ( $prospectnum ) {
522 warn " moving contacts and locations from prospect $prospectnum\n"
526 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
527 unless ( $prospect_main ) {
528 $dbh->rollback if $oldAutoCommit;
529 return "Unknown prospectnum $prospectnum";
531 $prospect_main->custnum($self->custnum);
532 $prospect_main->disabled('Y');
533 my $error = $prospect_main->replace;
535 $dbh->rollback if $oldAutoCommit;
539 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
540 my $cust_contact = new FS::cust_contact {
541 'custnum' => $self->custnum,
542 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
543 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
545 my $error = $cust_contact->insert
546 || $prospect_contact->delete;
548 $dbh->rollback if $oldAutoCommit;
553 my @cust_location = $prospect_main->cust_location;
554 my @qual = $prospect_main->qual;
556 foreach my $r ( @cust_location, @qual ) {
558 $r->custnum($self->custnum);
559 my $error = $r->replace;
561 $dbh->rollback if $oldAutoCommit;
565 # since we set invoice_dest on all migrated prospect contacts (for now),
566 # don't process invoicing_list.
567 delete $options{'invoicing_list'};
568 $invoicing_list = undef;
571 warn " setting contacts\n"
574 $invoicing_list ||= $options{'invoicing_list'};
575 if ( $invoicing_list ) {
577 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
580 foreach my $dest (@$invoicing_list ) {
581 if ($dest eq 'POST') {
582 $self->set('postal_invoice', 'Y');
585 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
586 if ( $contact_email ) {
587 my $cust_contact = FS::cust_contact->new({
588 contactnum => $contact_email->contactnum,
589 custnum => $self->custnum,
591 $cust_contact->set('invoice_dest', 'Y');
592 my $error = $cust_contact->insert;
594 $dbh->rollback if $oldAutoCommit;
595 return "$error (linking to email address $dest)";
599 # this email address is not yet linked to any contact
600 $email .= ',' if length($email);
608 my $contact = FS::contact->new({
609 'custnum' => $self->get('custnum'),
610 'last' => $self->get('last'),
611 'first' => $self->get('first'),
612 'emailaddress' => $email,
613 'invoice_dest' => 'Y', # yes, you can set this via the contact
615 my $error = $contact->insert;
617 $dbh->rollback if $oldAutoCommit;
625 if ( my $contact = delete $options{'contact'} ) {
627 foreach my $c ( @$contact ) {
628 $c->custnum($self->custnum);
629 my $error = $c->insert;
631 $dbh->rollback if $oldAutoCommit;
637 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
639 my $error = $self->process_o2m( 'table' => 'contact',
640 'fields' => FS::contact->cgi_contact_fields,
641 'params' => $contact_params,
644 $dbh->rollback if $oldAutoCommit;
649 warn " setting cust_payby\n"
652 if ( $options{cust_payby} ) {
654 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
655 $cust_payby->custnum($self->custnum);
656 my $error = $cust_payby->insert;
658 $dbh->rollback if $oldAutoCommit;
663 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
665 my $error = $self->process_o2m(
666 'table' => 'cust_payby',
667 'fields' => FS::cust_payby->cgi_cust_payby_fields,
668 'params' => $cust_payby_params,
669 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
672 $dbh->rollback if $oldAutoCommit;
678 warn " setting cust_main_exemption\n"
681 my $tax_exemption = delete $options{'tax_exemption'};
682 if ( $tax_exemption ) {
684 $tax_exemption = { map { $_ => '' } @$tax_exemption }
685 if ref($tax_exemption) eq 'ARRAY';
687 foreach my $taxname ( keys %$tax_exemption ) {
688 my $cust_main_exemption = new FS::cust_main_exemption {
689 'custnum' => $self->custnum,
690 'taxname' => $taxname,
691 'exempt_number' => $tax_exemption->{$taxname},
693 my $error = $cust_main_exemption->insert;
695 $dbh->rollback if $oldAutoCommit;
696 return "inserting cust_main_exemption (transaction rolled back): $error";
701 warn " ordering packages\n"
704 $error = $self->order_pkgs( $cust_pkgs,
706 'seconds_ref' => \$seconds,
707 'upbytes_ref' => \$upbytes,
708 'downbytes_ref' => \$downbytes,
709 'totalbytes_ref' => \$totalbytes,
712 $dbh->rollback if $oldAutoCommit;
717 $dbh->rollback if $oldAutoCommit;
718 return "No svc_acct record to apply pre-paid time";
720 if ( $upbytes || $downbytes || $totalbytes ) {
721 $dbh->rollback if $oldAutoCommit;
722 return "No svc_acct record to apply pre-paid data";
726 warn " inserting initial $payby payment of $amount\n"
728 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
730 $dbh->rollback if $oldAutoCommit;
731 return "inserting payment (transaction rolled back): $error";
735 unless ( $import || $skip_fuzzyfiles ) {
736 warn " queueing fuzzyfiles update\n"
738 $error = $self->queue_fuzzyfiles_update;
740 $dbh->rollback if $oldAutoCommit;
741 return "updating fuzzy search cache: $error";
745 # FS::geocode_Mixin::after_insert or something?
746 if ( $conf->config('tax_district_method') and !$import ) {
747 # if anything non-empty, try to look it up
748 my $queue = new FS::queue {
749 'job' => 'FS::geocode_Mixin::process_district_update',
750 'custnum' => $self->custnum,
752 my $error = $queue->insert( ref($self), $self->custnum );
754 $dbh->rollback if $oldAutoCommit;
755 return "queueing tax district update: $error";
760 warn " exporting\n" if $DEBUG > 1;
762 my $export_args = $options{'export_args'} || [];
765 map qsearch( 'part_export', {exportnum=>$_} ),
766 $conf->config('cust_main-exports'); #, $agentnum
768 foreach my $part_export ( @part_export ) {
769 my $error = $part_export->export_insert($self, @$export_args);
771 $dbh->rollback if $oldAutoCommit;
772 return "exporting to ". $part_export->exporttype.
773 " (transaction rolled back): $error";
777 #foreach my $depend_jobnum ( @$depend_jobnums ) {
778 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
780 # foreach my $jobnum ( @jobnums ) {
781 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
782 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
784 # my $error = $queue->depend_insert($depend_jobnum);
786 # $dbh->rollback if $oldAutoCommit;
787 # return "error queuing job dependancy: $error";
794 #if ( exists $options{'jobnums'} ) {
795 # push @{ $options{'jobnums'} }, @jobnums;
798 warn " insert complete; committing transaction\n"
801 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
806 use File::CounterFile;
807 sub auto_agent_custid {
810 my $format = $conf->config('cust_main-auto_agent_custid');
812 if ( $format eq '1YMMXXXXXXXX' ) {
814 my $counter = new File::CounterFile 'cust_main.agent_custid';
817 my $ym = 100000000000 + time2str('%y%m00000000', time);
818 if ( $ym > $counter->value ) {
819 $counter->{'value'} = $agent_custid = $ym;
820 $counter->{'updated'} = 1;
822 $agent_custid = $counter->inc;
828 die "Unknown cust_main-auto_agent_custid format: $format";
831 $self->agent_custid($agent_custid);
835 =item PACKAGE METHODS
837 Documentation on customer package methods has been moved to
838 L<FS::cust_main::Packages>.
840 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
842 Recharges this (existing) customer with the specified prepaid card (see
843 L<FS::prepay_credit>), specified either by I<identifier> or as an
844 FS::prepay_credit object. If there is an error, returns the error, otherwise
847 Optionally, five scalar references can be passed as well. They will have their
848 values filled in with the amount, number of seconds, and number of upload,
849 download, and total bytes applied by this prepaid card.
853 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
854 #the only place that uses these args
855 sub recharge_prepay {
856 my( $self, $prepay_credit, $amountref, $secondsref,
857 $upbytesref, $downbytesref, $totalbytesref ) = @_;
859 local $SIG{HUP} = 'IGNORE';
860 local $SIG{INT} = 'IGNORE';
861 local $SIG{QUIT} = 'IGNORE';
862 local $SIG{TERM} = 'IGNORE';
863 local $SIG{TSTP} = 'IGNORE';
864 local $SIG{PIPE} = 'IGNORE';
866 my $oldAutoCommit = $FS::UID::AutoCommit;
867 local $FS::UID::AutoCommit = 0;
870 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
872 my $error = $self->get_prepay( $prepay_credit,
873 'amount_ref' => \$amount,
874 'seconds_ref' => \$seconds,
875 'upbytes_ref' => \$upbytes,
876 'downbytes_ref' => \$downbytes,
877 'totalbytes_ref' => \$totalbytes,
879 || $self->increment_seconds($seconds)
880 || $self->increment_upbytes($upbytes)
881 || $self->increment_downbytes($downbytes)
882 || $self->increment_totalbytes($totalbytes)
883 || $self->insert_cust_pay_prepay( $amount,
885 ? $prepay_credit->identifier
890 $dbh->rollback if $oldAutoCommit;
894 if ( defined($amountref) ) { $$amountref = $amount; }
895 if ( defined($secondsref) ) { $$secondsref = $seconds; }
896 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
897 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
898 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
900 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
905 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
907 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
908 specified either by I<identifier> or as an FS::prepay_credit object.
910 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
911 incremented by the values of the prepaid card.
913 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
914 check or set this customer's I<agentnum>.
916 If there is an error, returns the error, otherwise returns false.
922 my( $self, $prepay_credit, %opt ) = @_;
924 local $SIG{HUP} = 'IGNORE';
925 local $SIG{INT} = 'IGNORE';
926 local $SIG{QUIT} = 'IGNORE';
927 local $SIG{TERM} = 'IGNORE';
928 local $SIG{TSTP} = 'IGNORE';
929 local $SIG{PIPE} = 'IGNORE';
931 my $oldAutoCommit = $FS::UID::AutoCommit;
932 local $FS::UID::AutoCommit = 0;
935 unless ( ref($prepay_credit) ) {
937 my $identifier = $prepay_credit;
939 $prepay_credit = qsearchs(
941 { 'identifier' => $identifier },
946 unless ( $prepay_credit ) {
947 $dbh->rollback if $oldAutoCommit;
948 return "Invalid prepaid card: ". $identifier;
953 if ( $prepay_credit->agentnum ) {
954 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
955 $dbh->rollback if $oldAutoCommit;
956 return "prepaid card not valid for agent ". $self->agentnum;
958 $self->agentnum($prepay_credit->agentnum);
961 my $error = $prepay_credit->delete;
963 $dbh->rollback if $oldAutoCommit;
964 return "removing prepay_credit (transaction rolled back): $error";
967 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
968 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
975 =item increment_upbytes SECONDS
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of upbytes. If there is an error, returns the error,
979 otherwise returns false.
983 sub increment_upbytes {
984 _increment_column( shift, 'upbytes', @_);
987 =item increment_downbytes SECONDS
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of downbytes. If there is an error, returns the error,
991 otherwise returns false.
995 sub increment_downbytes {
996 _increment_column( shift, 'downbytes', @_);
999 =item increment_totalbytes SECONDS
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of totalbytes. If there is an error, returns the error,
1003 otherwise returns false.
1007 sub increment_totalbytes {
1008 _increment_column( shift, 'totalbytes', @_);
1011 =item increment_seconds SECONDS
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds. If there is an error, returns the error,
1015 otherwise returns false.
1019 sub increment_seconds {
1020 _increment_column( shift, 'seconds', @_);
1023 =item _increment_column AMOUNT
1025 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1026 the specified number of seconds or bytes. If there is an error, returns
1027 the error, otherwise returns false.
1031 sub _increment_column {
1032 my( $self, $column, $amount ) = @_;
1033 warn "$me increment_column called: $column, $amount\n"
1036 return '' unless $amount;
1038 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1039 $self->ncancelled_pkgs;
1041 if ( ! @cust_pkg ) {
1042 return 'No packages with primary or single services found'.
1043 ' to apply pre-paid time';
1044 } elsif ( scalar(@cust_pkg) > 1 ) {
1045 #maybe have a way to specify the package/account?
1046 return 'Multiple packages found to apply pre-paid time';
1049 my $cust_pkg = $cust_pkg[0];
1050 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1054 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1056 if ( ! @cust_svc ) {
1057 return 'No account found to apply pre-paid time';
1058 } elsif ( scalar(@cust_svc) > 1 ) {
1059 return 'Multiple accounts found to apply pre-paid time';
1062 my $svc_acct = $cust_svc[0]->svc_x;
1063 warn " found service svcnum ". $svc_acct->pkgnum.
1064 ' ('. $svc_acct->email. ")\n"
1067 $column = "increment_$column";
1068 $svc_acct->$column($amount);
1072 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1074 Inserts a prepayment in the specified amount for this customer. An optional
1075 second argument can specify the prepayment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1080 sub insert_cust_pay_prepay {
1081 shift->insert_cust_pay('PREP', @_);
1084 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1086 Inserts a cash payment in the specified amount for this customer. An optional
1087 second argument can specify the payment identifier for tracking purposes.
1088 If there is an error, returns the error, otherwise returns false.
1092 sub insert_cust_pay_cash {
1093 shift->insert_cust_pay('CASH', @_);
1096 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1098 Inserts a Western Union payment in the specified amount for this customer. An
1099 optional second argument can specify the prepayment identifier for tracking
1100 purposes. If there is an error, returns the error, otherwise returns false.
1104 sub insert_cust_pay_west {
1105 shift->insert_cust_pay('WEST', @_);
1108 sub insert_cust_pay {
1109 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1110 my $payinfo = scalar(@_) ? shift : '';
1112 my $cust_pay = new FS::cust_pay {
1113 'custnum' => $self->custnum,
1114 'paid' => sprintf('%.2f', $amount),
1115 #'_date' => #date the prepaid card was purchased???
1117 'payinfo' => $payinfo,
1123 =item delete [ OPTION => VALUE ... ]
1125 This deletes the customer. If there is an error, returns the error, otherwise
1128 This will completely remove all traces of the customer record. This is not
1129 what you want when a customer cancels service; for that, cancel all of the
1130 customer's packages (see L</cancel>).
1132 If the customer has any uncancelled packages, you need to pass a new (valid)
1133 customer number for those packages to be transferred to, as the "new_customer"
1134 option. Cancelled packages will be deleted. Did I mention that this is NOT
1135 what you want when a customer cancels service and that you really should be
1136 looking at L<FS::cust_pkg/cancel>?
1138 You can't delete a customer with invoices (see L<FS::cust_bill>),
1139 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1140 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1141 set the "delete_financials" option to a true value.
1146 my( $self, %opt ) = @_;
1148 local $SIG{HUP} = 'IGNORE';
1149 local $SIG{INT} = 'IGNORE';
1150 local $SIG{QUIT} = 'IGNORE';
1151 local $SIG{TERM} = 'IGNORE';
1152 local $SIG{TSTP} = 'IGNORE';
1153 local $SIG{PIPE} = 'IGNORE';
1155 my $oldAutoCommit = $FS::UID::AutoCommit;
1156 local $FS::UID::AutoCommit = 0;
1159 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1160 $dbh->rollback if $oldAutoCommit;
1161 return "Can't delete a master agent customer";
1164 #use FS::access_user
1165 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1166 $dbh->rollback if $oldAutoCommit;
1167 return "Can't delete a master employee customer";
1170 tie my %financial_tables, 'Tie::IxHash',
1171 'cust_bill' => 'invoices',
1172 'cust_statement' => 'statements',
1173 'cust_credit' => 'credits',
1174 'cust_pay' => 'payments',
1175 'cust_refund' => 'refunds',
1178 foreach my $table ( keys %financial_tables ) {
1180 my @records = $self->$table();
1182 if ( @records && ! $opt{'delete_financials'} ) {
1183 $dbh->rollback if $oldAutoCommit;
1184 return "Can't delete a customer with ". $financial_tables{$table};
1187 foreach my $record ( @records ) {
1188 my $error = $record->delete;
1190 $dbh->rollback if $oldAutoCommit;
1191 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1197 my @cust_pkg = $self->ncancelled_pkgs;
1199 my $new_custnum = $opt{'new_custnum'};
1200 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1201 $dbh->rollback if $oldAutoCommit;
1202 return "Invalid new customer number: $new_custnum";
1204 foreach my $cust_pkg ( @cust_pkg ) {
1205 my %hash = $cust_pkg->hash;
1206 $hash{'custnum'} = $new_custnum;
1207 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1208 my $error = $new_cust_pkg->replace($cust_pkg,
1209 options => { $cust_pkg->options },
1212 $dbh->rollback if $oldAutoCommit;
1217 my @cancelled_cust_pkg = $self->all_pkgs;
1218 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1219 my $error = $cust_pkg->delete;
1221 $dbh->rollback if $oldAutoCommit;
1226 #cust_tax_adjustment in financials?
1227 #cust_pay_pending? ouch
1228 foreach my $table (qw(
1229 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1230 cust_payby cust_location cust_main_note cust_tax_adjustment
1231 cust_pay_void cust_pay_batch queue cust_tax_exempt
1233 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1234 my $error = $record->delete;
1236 $dbh->rollback if $oldAutoCommit;
1242 my $sth = $dbh->prepare(
1243 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1245 my $errstr = $dbh->errstr;
1246 $dbh->rollback if $oldAutoCommit;
1249 $sth->execute($self->custnum) or do {
1250 my $errstr = $sth->errstr;
1251 $dbh->rollback if $oldAutoCommit;
1257 my $ticket_dbh = '';
1258 if ($conf->config('ticket_system') eq 'RT_Internal') {
1260 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1261 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1262 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1263 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1266 if ( $ticket_dbh ) {
1268 my $ticket_sth = $ticket_dbh->prepare(
1269 'DELETE FROM Links WHERE Target = ?'
1271 my $errstr = $ticket_dbh->errstr;
1272 $dbh->rollback if $oldAutoCommit;
1275 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1277 my $errstr = $ticket_sth->errstr;
1278 $dbh->rollback if $oldAutoCommit;
1282 #check and see if the customer is the only link on the ticket, and
1283 #if so, set the ticket to deleted status in RT?
1284 #maybe someday, for now this will at least fix tickets not displaying
1288 #delete the customer record
1290 my $error = $self->SUPER::delete;
1292 $dbh->rollback if $oldAutoCommit;
1296 # cust_main exports!
1298 #my $export_args = $options{'export_args'} || [];
1301 map qsearch( 'part_export', {exportnum=>$_} ),
1302 $conf->config('cust_main-exports'); #, $agentnum
1304 foreach my $part_export ( @part_export ) {
1305 my $error = $part_export->export_delete( $self ); #, @$export_args);
1307 $dbh->rollback if $oldAutoCommit;
1308 return "exporting to ". $part_export->exporttype.
1309 " (transaction rolled back): $error";
1313 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1318 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1320 Replaces the OLD_RECORD with this one in the database. If there is an error,
1321 returns the error, otherwise returns false.
1323 To change the customer's address, set the pseudo-fields C<bill_location> and
1324 C<ship_location>. The address will still only change if at least one of the
1325 address fields differs from the existing values.
1327 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1328 set as the contact email address for a default contact with the same name as
1331 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1332 I<contact_params>, I<invoicing_list>.
1334 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1335 of tax names and exemption numbers. FS::cust_main_exemption records will be
1336 deleted and inserted as appropriate.
1338 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1339 groups (describing the customer's payment methods and contacts, respectively)
1340 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1341 and L<FS::contact> for the fields these can contain.
1343 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1344 should be used instead if possible.
1351 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1353 : $self->replace_old;
1357 warn "$me replace called\n"
1360 my $curuser = $FS::CurrentUser::CurrentUser;
1361 return "You are not permitted to create complimentary accounts."
1362 if $self->complimentary eq 'Y'
1363 && $self->complimentary ne $old->complimentary
1364 && ! $curuser->access_right('Complimentary customer');
1366 local($ignore_expired_card) = 1
1367 if $old->payby =~ /^(CARD|DCRD)$/
1368 && $self->payby =~ /^(CARD|DCRD)$/
1369 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1371 local($ignore_banned_card) = 1
1372 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1373 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1374 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1376 if ( $self->payby =~ /^(CARD|DCRD)$/
1377 && $old->payinfo ne $self->payinfo
1378 && $old->paymask ne $self->paymask )
1380 my $error = $self->check_payinfo_cardtype;
1381 return $error if $error;
1384 return "Invoicing locale is required"
1387 && $conf->exists('cust_main-require_locale');
1389 return "You are not permitted to change customer invoicing terms."
1390 if $old->invoice_terms ne $self->invoice_terms
1391 && ! $curuser->access_right('Edit customer invoice terms');
1393 local $SIG{HUP} = 'IGNORE';
1394 local $SIG{INT} = 'IGNORE';
1395 local $SIG{QUIT} = 'IGNORE';
1396 local $SIG{TERM} = 'IGNORE';
1397 local $SIG{TSTP} = 'IGNORE';
1398 local $SIG{PIPE} = 'IGNORE';
1400 my $oldAutoCommit = $FS::UID::AutoCommit;
1401 local $FS::UID::AutoCommit = 0;
1404 for my $l (qw(bill_location ship_location)) {
1405 #my $old_loc = $old->$l;
1406 my $new_loc = $self->$l or next;
1408 # find the existing location if there is one
1409 $new_loc->set('custnum' => $self->custnum);
1410 my $error = $new_loc->find_or_insert;
1412 $dbh->rollback if $oldAutoCommit;
1415 $self->set($l.'num', $new_loc->locationnum);
1419 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1420 warn "cust_main::replace: using deprecated invoicing list argument";
1421 $invoicing_list = shift @param;
1424 my %options = @param;
1426 $invoicing_list ||= $options{invoicing_list};
1428 my @contacts = map { $_->contact } $self->cust_contact;
1429 # find a contact that matches the customer's name
1430 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1431 and $_->last eq $old->get('last') }
1433 $implicit_contact ||= FS::contact->new({
1434 'custnum' => $self->custnum,
1435 'locationnum' => $self->get('bill_locationnum'),
1438 # for any of these that are already contact emails, link to the existing
1440 if ( $invoicing_list ) {
1443 # kind of like process_m2m on these, except:
1444 # - the other side is two tables in a join
1445 # - and we might have to create new contact_emails
1446 # - and possibly a new contact
1448 # Find existing invoice emails that aren't on the implicit contact.
1449 # Any of these that are not on the new invoicing list will be removed.
1450 my %old_email_cust_contact;
1451 foreach my $cust_contact ($self->cust_contact) {
1452 next if !$cust_contact->invoice_dest;
1453 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1455 foreach my $contact_email ($cust_contact->contact->contact_email) {
1456 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1460 foreach my $dest (@$invoicing_list) {
1462 if ($dest eq 'POST') {
1464 $self->set('postal_invoice', 'Y');
1466 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1468 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1472 # See if it belongs to some other contact; if so, link it.
1473 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1475 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1476 my $cust_contact = qsearchs('cust_contact', {
1477 contactnum => $contact_email->contactnum,
1478 custnum => $self->custnum,
1479 }) || FS::cust_contact->new({
1480 contactnum => $contact_email->contactnum,
1481 custnum => $self->custnum,
1483 $cust_contact->set('invoice_dest', 'Y');
1484 my $error = $cust_contact->custcontactnum ?
1485 $cust_contact->replace : $cust_contact->insert;
1487 $dbh->rollback if $oldAutoCommit;
1488 return "$error (linking to email address $dest)";
1492 # This email address is not yet linked to any contact, so it will
1493 # be added to the implicit contact.
1494 $email .= ',' if length($email);
1500 foreach my $remove_dest (keys %old_email_cust_contact) {
1501 my $cust_contact = $old_email_cust_contact{$remove_dest};
1502 # These were not in the list of requested destinations, so take them off.
1503 $cust_contact->set('invoice_dest', '');
1504 my $error = $cust_contact->replace;
1506 $dbh->rollback if $oldAutoCommit;
1507 return "$error (unlinking email address $remove_dest)";
1511 # make sure it keeps up with the changed customer name, if any
1512 $implicit_contact->set('last', $self->get('last'));
1513 $implicit_contact->set('first', $self->get('first'));
1514 $implicit_contact->set('emailaddress', $email);
1515 $implicit_contact->set('invoice_dest', 'Y');
1516 $implicit_contact->set('custnum', $self->custnum);
1517 my $i_cust_contact =
1518 qsearchs('cust_contact', {
1519 contactnum => $implicit_contact->contactnum,
1520 custnum => $self->custnum,
1523 if ( $i_cust_contact ) {
1524 $implicit_contact->set($_, $i_cust_contact->$_)
1525 foreach qw( classnum selfservice_access comment );
1529 if ( $implicit_contact->contactnum ) {
1530 $error = $implicit_contact->replace;
1531 } elsif ( length($email) ) { # don't create a new contact if not needed
1532 $error = $implicit_contact->insert;
1536 $dbh->rollback if $oldAutoCommit;
1537 return "$error (adding email address $email)";
1542 # replace the customer record
1543 my $error = $self->SUPER::replace($old);
1546 $dbh->rollback if $oldAutoCommit;
1550 # now move packages to the new service location
1551 $self->set('ship_location', ''); #flush cache
1552 if ( $old->ship_locationnum and # should only be null during upgrade...
1553 $old->ship_locationnum != $self->ship_locationnum ) {
1554 $error = $old->ship_location->move_to($self->ship_location);
1556 $dbh->rollback if $oldAutoCommit;
1560 # don't move packages based on the billing location, but
1561 # disable it if it's no longer in use
1562 if ( $old->bill_locationnum and
1563 $old->bill_locationnum != $self->bill_locationnum ) {
1564 $error = $old->bill_location->disable_if_unused;
1566 $dbh->rollback if $oldAutoCommit;
1571 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1573 #this could be more efficient than deleting and re-inserting, if it matters
1574 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1575 my $error = $cust_tag->delete;
1577 $dbh->rollback if $oldAutoCommit;
1581 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1582 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1583 'custnum' => $self->custnum };
1584 my $error = $cust_tag->insert;
1586 $dbh->rollback if $oldAutoCommit;
1593 my $tax_exemption = delete $options{'tax_exemption'};
1594 if ( $tax_exemption ) {
1596 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1597 if ref($tax_exemption) eq 'ARRAY';
1599 my %cust_main_exemption =
1600 map { $_->taxname => $_ }
1601 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1603 foreach my $taxname ( keys %$tax_exemption ) {
1605 if ( $cust_main_exemption{$taxname} &&
1606 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1609 delete $cust_main_exemption{$taxname};
1613 my $cust_main_exemption = new FS::cust_main_exemption {
1614 'custnum' => $self->custnum,
1615 'taxname' => $taxname,
1616 'exempt_number' => $tax_exemption->{$taxname},
1618 my $error = $cust_main_exemption->insert;
1620 $dbh->rollback if $oldAutoCommit;
1621 return "inserting cust_main_exemption (transaction rolled back): $error";
1625 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1626 my $error = $cust_main_exemption->delete;
1628 $dbh->rollback if $oldAutoCommit;
1629 return "deleting cust_main_exemption (transaction rolled back): $error";
1635 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1637 my $error = $self->process_o2m(
1638 'table' => 'cust_payby',
1639 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1640 'params' => $cust_payby_params,
1641 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1644 $dbh->rollback if $oldAutoCommit;
1650 if ( my $contact_params = delete $options{'contact_params'} ) {
1652 # this can potentially replace contacts that were created by the
1653 # invoicing list argument, but the UI shouldn't allow both of them
1656 my $error = $self->process_o2m(
1657 'table' => 'contact',
1658 'fields' => FS::contact->cgi_contact_fields,
1659 'params' => $contact_params,
1662 $dbh->rollback if $oldAutoCommit;
1668 unless ( $import || $skip_fuzzyfiles ) {
1669 $error = $self->queue_fuzzyfiles_update;
1671 $dbh->rollback if $oldAutoCommit;
1672 return "updating fuzzy search cache: $error";
1676 # tax district update in cust_location
1678 # cust_main exports!
1680 my $export_args = $options{'export_args'} || [];
1683 map qsearch( 'part_export', {exportnum=>$_} ),
1684 $conf->config('cust_main-exports'); #, $agentnum
1686 foreach my $part_export ( @part_export ) {
1687 my $error = $part_export->export_replace( $self, $old, @$export_args);
1689 $dbh->rollback if $oldAutoCommit;
1690 return "exporting to ". $part_export->exporttype.
1691 " (transaction rolled back): $error";
1695 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1700 =item queue_fuzzyfiles_update
1702 Used by insert & replace to update the fuzzy search cache
1706 use FS::cust_main::Search;
1707 sub queue_fuzzyfiles_update {
1710 local $SIG{HUP} = 'IGNORE';
1711 local $SIG{INT} = 'IGNORE';
1712 local $SIG{QUIT} = 'IGNORE';
1713 local $SIG{TERM} = 'IGNORE';
1714 local $SIG{TSTP} = 'IGNORE';
1715 local $SIG{PIPE} = 'IGNORE';
1717 my $oldAutoCommit = $FS::UID::AutoCommit;
1718 local $FS::UID::AutoCommit = 0;
1721 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1722 my $queue = new FS::queue {
1723 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1725 my @args = "cust_main.$field", $self->get($field);
1726 my $error = $queue->insert( @args );
1728 $dbh->rollback if $oldAutoCommit;
1729 return "queueing job (transaction rolled back): $error";
1734 push @locations, $self->bill_location if $self->bill_locationnum;
1735 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1736 foreach my $location (@locations) {
1737 my $queue = new FS::queue {
1738 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1740 my @args = 'cust_location.address1', $location->address1;
1741 my $error = $queue->insert( @args );
1743 $dbh->rollback if $oldAutoCommit;
1744 return "queueing job (transaction rolled back): $error";
1748 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1755 Checks all fields to make sure this is a valid customer record. If there is
1756 an error, returns the error, otherwise returns false. Called by the insert
1757 and replace methods.
1764 warn "$me check BEFORE: \n". $self->_dump
1768 $self->ut_numbern('custnum')
1769 || $self->ut_number('agentnum')
1770 || $self->ut_textn('agent_custid')
1771 || $self->ut_number('refnum')
1772 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1773 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1774 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1775 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1776 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1777 || $self->ut_textn('custbatch')
1778 || $self->ut_name('last')
1779 || $self->ut_name('first')
1780 || $self->ut_snumbern('signupdate')
1781 || $self->ut_snumbern('birthdate')
1782 || $self->ut_namen('spouse_last')
1783 || $self->ut_namen('spouse_first')
1784 || $self->ut_snumbern('spouse_birthdate')
1785 || $self->ut_snumbern('anniversary_date')
1786 || $self->ut_textn('company')
1787 || $self->ut_textn('ship_company')
1788 || $self->ut_anything('comments')
1789 || $self->ut_numbern('referral_custnum')
1790 || $self->ut_textn('stateid')
1791 || $self->ut_textn('stateid_state')
1792 || $self->ut_textn('invoice_terms')
1793 || $self->ut_floatn('cdr_termination_percentage')
1794 || $self->ut_floatn('credit_limit')
1795 || $self->ut_numbern('billday')
1796 || $self->ut_numbern('prorate_day')
1797 || $self->ut_flag('force_prorate_day')
1798 || $self->ut_flag('edit_subject')
1799 || $self->ut_flag('calling_list_exempt')
1800 || $self->ut_flag('invoice_noemail')
1801 || $self->ut_flag('message_noemail')
1802 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1803 || $self->ut_currencyn('currency')
1804 || $self->ut_textn('po_number')
1805 || $self->ut_enum('complimentary', [ '', 'Y' ])
1806 || $self->ut_flag('invoice_ship_address')
1807 || $self->ut_flag('invoice_dest')
1810 foreach (qw(company ship_company)) {
1811 my $company = $self->get($_);
1812 $company =~ s/^\s+//;
1813 $company =~ s/\s+$//;
1814 $company =~ s/\s+/ /g;
1815 $self->set($_, $company);
1818 #barf. need message catalogs. i18n. etc.
1819 $error .= "Please select an advertising source."
1820 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1821 return $error if $error;
1823 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1824 or return "Unknown agent";
1826 if ( $self->currency ) {
1827 my $agent_currency = qsearchs( 'agent_currency', {
1828 'agentnum' => $agent->agentnum,
1829 'currency' => $self->currency,
1831 or return "Agent ". $agent->agent.
1832 " not permitted to offer ". $self->currency. " invoicing";
1835 return "Unknown refnum"
1836 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1838 return "Unknown referring custnum: ". $self->referral_custnum
1839 unless ! $self->referral_custnum
1840 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1842 if ( $self->ss eq '' ) {
1847 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1848 or return "Illegal social security number: ". $self->ss;
1849 $self->ss("$1-$2-$3");
1852 #turn off invoice_ship_address if ship & bill are the same
1853 if ($self->bill_locationnum eq $self->ship_locationnum) {
1854 $self->invoice_ship_address('');
1857 # cust_main_county verification now handled by cust_location check
1860 $self->ut_phonen('daytime', $self->country)
1861 || $self->ut_phonen('night', $self->country)
1862 || $self->ut_phonen('fax', $self->country)
1863 || $self->ut_phonen('mobile', $self->country)
1865 return $error if $error;
1867 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1869 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1872 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1874 : FS::Msgcat::_gettext('daytime');
1875 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1877 : FS::Msgcat::_gettext('night');
1879 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1881 : FS::Msgcat::_gettext('mobile');
1883 return "$daytime_label, $night_label or $mobile_label is required"
1887 ### start of stuff moved to cust_payby
1888 # then mostly kept here to support upgrades (can remove in 5.x)
1889 # but modified to allow everything to be empty
1891 if ( $self->payby ) {
1892 FS::payby->can_payby($self->table, $self->payby)
1893 or return "Illegal payby: ". $self->payby;
1898 $error = $self->ut_numbern('paystart_month')
1899 || $self->ut_numbern('paystart_year')
1900 || $self->ut_numbern('payissue')
1901 || $self->ut_textn('paytype')
1903 return $error if $error;
1905 if ( $self->payip eq '' ) {
1908 $error = $self->ut_ip('payip');
1909 return $error if $error;
1912 # If it is encrypted and the private key is not availaible then we can't
1913 # check the credit card.
1914 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1916 # Need some kind of global flag to accept invalid cards, for testing
1918 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1919 $self->payby =~ /^(CARD|DCRD)$/ ) {
1921 my $payinfo = $self->payinfo;
1922 $payinfo =~ s/\D//g;
1923 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1924 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1926 $self->payinfo($payinfo);
1928 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1930 return gettext('unknown_card_type')
1931 if $self->payinfo !~ /^99\d{14}$/ #token
1932 && cardtype($self->payinfo) eq "Unknown";
1934 unless ( $ignore_banned_card ) {
1935 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1937 if ( $ban->bantype eq 'warn' ) {
1938 #or others depending on value of $ban->reason ?
1939 return '_duplicate_card'.
1940 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1941 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1942 ' (ban# '. $ban->bannum. ')'
1943 unless $self->override_ban_warn;
1945 return 'Banned credit card: banned on '.
1946 time2str('%a %h %o at %r', $ban->_date).
1947 ' by '. $ban->otaker.
1948 ' (ban# '. $ban->bannum. ')';
1953 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1954 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1955 $self->paycvv =~ /^(\d{4})$/
1956 or return "CVV2 (CID) for American Express cards is four digits.";
1959 $self->paycvv =~ /^(\d{3})$/
1960 or return "CVV2 (CVC2/CID) is three digits.";
1967 my $cardtype = cardtype($payinfo);
1968 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1970 return "Start date or issue number is required for $cardtype cards"
1971 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1973 return "Start month must be between 1 and 12"
1974 if $self->paystart_month
1975 and $self->paystart_month < 1 || $self->paystart_month > 12;
1977 return "Start year must be 1990 or later"
1978 if $self->paystart_year
1979 and $self->paystart_year < 1990;
1981 return "Issue number must be beween 1 and 99"
1983 and $self->payissue < 1 || $self->payissue > 99;
1986 $self->paystart_month('');
1987 $self->paystart_year('');
1988 $self->payissue('');
1991 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1992 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1994 my $payinfo = $self->payinfo;
1995 $payinfo =~ s/[^\d\@\.]//g;
1996 if ( $conf->config('echeck-country') eq 'CA' ) {
1997 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1998 or return 'invalid echeck account@branch.bank';
1999 $payinfo = "$1\@$2.$3";
2000 } elsif ( $conf->config('echeck-country') eq 'US' ) {
2001 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2002 $payinfo = "$1\@$2";
2004 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2005 $payinfo = "$1\@$2";
2007 $self->payinfo($payinfo);
2010 unless ( $ignore_banned_card ) {
2011 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2013 if ( $ban->bantype eq 'warn' ) {
2014 #or others depending on value of $ban->reason ?
2015 return '_duplicate_ach' unless $self->override_ban_warn;
2017 return 'Banned ACH account: banned on '.
2018 time2str('%a %h %o at %r', $ban->_date).
2019 ' by '. $ban->otaker.
2020 ' (ban# '. $ban->bannum. ')';
2025 } elsif ( $self->payby eq 'LECB' ) {
2027 my $payinfo = $self->payinfo;
2028 $payinfo =~ s/\D//g;
2029 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2031 $self->payinfo($payinfo);
2034 } elsif ( $self->payby eq 'BILL' ) {
2036 $error = $self->ut_textn('payinfo');
2037 return "Illegal P.O. number: ". $self->payinfo if $error;
2040 } elsif ( $self->payby eq 'COMP' ) {
2042 my $curuser = $FS::CurrentUser::CurrentUser;
2043 if ( ! $self->custnum
2044 && ! $curuser->access_right('Complimentary customer')
2047 return "You are not permitted to create complimentary accounts."
2050 $error = $self->ut_textn('payinfo');
2051 return "Illegal comp account issuer: ". $self->payinfo if $error;
2054 } elsif ( $self->payby eq 'PREPAY' ) {
2056 my $payinfo = $self->payinfo;
2057 $payinfo =~ s/\W//g; #anything else would just confuse things
2058 $self->payinfo($payinfo);
2059 $error = $self->ut_alpha('payinfo');
2060 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2061 return "Unknown prepayment identifier"
2062 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2067 return "You are not permitted to create complimentary accounts."
2069 && $self->complimentary eq 'Y'
2070 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2072 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2073 return "Expiration date required"
2074 # shouldn't payinfo_check do this?
2075 unless ! $self->payby
2076 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2080 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2081 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2082 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2083 ( $m, $y ) = ( $2, "19$1" );
2084 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2085 ( $m, $y ) = ( $3, "20$2" );
2087 return "Illegal expiration date: ". $self->paydate;
2089 $m = sprintf('%02d',$m);
2090 $self->paydate("$y-$m-01");
2091 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2092 return gettext('expired_card')
2094 && !$ignore_expired_card
2095 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2098 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2099 ( ! $conf->exists('require_cardname')
2100 || $self->payby !~ /^(CARD|DCRD)$/ )
2102 $self->payname( $self->first. " ". $self->getfield('last') );
2105 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2106 $self->payname =~ /^([\w \,\.\-\']*)$/
2107 or return gettext('illegal_name'). " payname: ". $self->payname;
2110 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2111 or return gettext('illegal_name'). " payname: ". $self->payname;
2117 ### end of stuff moved to cust_payby
2119 return "Please select an invoicing locale"
2122 && $conf->exists('cust_main-require_locale');
2124 return "Please select a customer class"
2125 if ! $self->classnum
2126 && $conf->exists('cust_main-require_classnum');
2128 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2129 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2133 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2135 warn "$me check AFTER: \n". $self->_dump
2138 $self->SUPER::check;
2141 sub check_payinfo_cardtype {
2144 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2146 my $payinfo = $self->payinfo;
2147 $payinfo =~ s/\D//g;
2149 return '' if $self->tokenized($payinfo); #token
2151 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2152 my $cardtype = cardtype($payinfo);
2154 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2162 Additional checks for replace only.
2167 my ($new,$old) = @_;
2168 #preserve old value if global config is set
2169 if ($old && $conf->exists('invoice-ship_address')) {
2170 $new->invoice_ship_address($old->invoice_ship_address);
2177 Returns a list of fields which have ship_ duplicates.
2182 qw( last first company
2184 address1 address2 city county state zip country
2186 daytime night fax mobile
2190 =item has_ship_address
2192 Returns true if this customer record has a separate shipping address.
2196 sub has_ship_address {
2198 $self->bill_locationnum != $self->ship_locationnum;
2203 Returns a list of key/value pairs, with the following keys: address1,
2204 adddress2, city, county, state, zip, country, district, and geocode. The
2205 shipping address is used if present.
2211 $self->ship_location->location_hash;
2216 Returns all locations (see L<FS::cust_location>) for this customer.
2223 'table' => 'cust_location',
2224 'hashref' => { 'custnum' => $self->custnum,
2225 'prospectnum' => '',
2227 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2233 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2239 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2242 =item cust_payby PAYBY
2244 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2246 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2247 Does not validate PAYBY.
2255 'table' => 'cust_payby',
2256 'hashref' => { 'custnum' => $self->custnum },
2257 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2259 $search->{'extra_sql'} = ' AND payby IN ( '.
2260 join(',', map dbh->quote($_), @payby).
2267 =item has_cust_payby_auto
2269 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2273 sub has_cust_payby_auto {
2276 'table' => 'cust_payby',
2277 'hashref' => { 'custnum' => $self->custnum, },
2278 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2279 'order_by' => 'LIMIT 1',
2286 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2287 and L<FS::cust_pkg>) for this customer, except those on hold.
2289 Returns a list: an empty list on success or a list of errors.
2295 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2300 Unsuspends all suspended packages in the on-hold state (those without setup
2301 dates) for this customer.
2307 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2312 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2314 Returns a list: an empty list on success or a list of errors.
2320 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2323 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2325 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2326 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2327 of a list of pkgparts; the hashref has the following keys:
2331 =item pkgparts - listref of pkgparts
2333 =item (other options are passed to the suspend method)
2338 Returns a list: an empty list on success or a list of errors.
2342 sub suspend_if_pkgpart {
2344 my (@pkgparts, %opt);
2345 if (ref($_[0]) eq 'HASH'){
2346 @pkgparts = @{$_[0]{pkgparts}};
2351 grep { $_->suspend(%opt) }
2352 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2353 $self->unsuspended_pkgs;
2356 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2358 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2359 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2360 instead of a list of pkgparts; the hashref has the following keys:
2364 =item pkgparts - listref of pkgparts
2366 =item (other options are passed to the suspend method)
2370 Returns a list: an empty list on success or a list of errors.
2374 sub suspend_unless_pkgpart {
2376 my (@pkgparts, %opt);
2377 if (ref($_[0]) eq 'HASH'){
2378 @pkgparts = @{$_[0]{pkgparts}};
2383 grep { $_->suspend(%opt) }
2384 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2385 $self->unsuspended_pkgs;
2388 =item cancel [ OPTION => VALUE ... ]
2390 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2391 The cancellation time will be now.
2395 Always returns a list: an empty list on success or a list of errors.
2402 warn "$me cancel called on customer ". $self->custnum. " with options ".
2403 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2405 my @pkgs = $self->ncancelled_pkgs;
2407 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2410 =item cancel_pkgs OPTIONS
2412 Cancels a specified list of packages. OPTIONS can include:
2416 =item cust_pkg - an arrayref of the packages. Required.
2418 =item time - the cancellation time, used to calculate final bills and
2419 unused-time credits if any. Will be passed through to the bill() and
2420 FS::cust_pkg::cancel() methods.
2422 =item quiet - can be set true to supress email cancellation notices.
2424 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2425 reasonnum of an existing reason, or passing a hashref will create a new reason.
2426 The hashref should have the following keys:
2427 typenum - Reason type (see L<FS::reason_type>)
2428 reason - Text of the new reason.
2430 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2431 for the individual packages, parallel to the C<cust_pkg> argument. The
2432 reason and reason_otaker arguments will be taken from those objects.
2434 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2436 =item nobill - can be set true to skip billing if it might otherwise be done.
2441 my( $self, %opt ) = @_;
2443 # we're going to cancel services, which is not reversible
2444 die "cancel_pkgs cannot be run inside a transaction"
2445 if $FS::UID::AutoCommit == 0;
2447 local $FS::UID::AutoCommit = 0;
2449 return ( 'access denied' )
2450 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2452 if ( $opt{'ban'} ) {
2454 foreach my $cust_payby ( $self->cust_payby ) {
2456 #well, if they didn't get decrypted on search, then we don't have to
2457 # try again... queue a job for the server that does have decryption
2458 # capability if we're in a paranoid multi-server implementation?
2459 return ( "Can't (yet) ban encrypted credit cards" )
2460 if $cust_payby->is_encrypted($cust_payby->payinfo);
2462 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2463 my $error = $ban->insert;
2473 my @pkgs = @{ delete $opt{'cust_pkg'} };
2474 my $cancel_time = $opt{'time'} || time;
2476 # bill all packages first, so we don't lose usage, service counts for
2477 # bulk billing, etc.
2478 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2480 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2482 'time' => $cancel_time );
2484 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2486 return ( "Error billing during cancellation: $error" );
2491 $FS::UID::AutoCommit = 1;
2493 # now cancel all services, the same way we would for individual packages.
2494 # if any of them fail, cancel the rest anyway.
2495 my @cust_svc = map { $_->cust_svc } @pkgs;
2496 my @sorted_cust_svc =
2498 sort { $a->[1] <=> $b->[1] }
2499 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2501 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2504 foreach my $cust_svc (@sorted_cust_svc) {
2505 my $part_svc = $cust_svc->part_svc;
2506 next if ( defined($part_svc) and $part_svc->preserve );
2507 my $error = $cust_svc->cancel; # immediate cancel, no date option
2508 push @errors, $error if $error;
2514 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2515 $self->custnum. "\n"
2519 if ($opt{'cust_pkg_reason'}) {
2520 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2526 my $cpr = shift @cprs;
2528 $lopt{'reason'} = $cpr->reasonnum;
2529 $lopt{'reason_otaker'} = $cpr->otaker;
2531 warn "no reason found when canceling package ".$_->pkgnum."\n";
2532 # we're not actually required to pass a reason to cust_pkg::cancel,
2533 # but if we're getting to this point, something has gone awry.
2534 $null_reason ||= FS::reason->new_or_existing(
2535 reason => 'unknown reason',
2536 type => 'Cancel Reason',
2539 $lopt{'reason'} = $null_reason->reasonnum;
2540 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2543 my $error = $_->cancel(%lopt);
2544 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2550 sub _banned_pay_hashref {
2561 'payby' => $payby2ban{$self->payby},
2562 'payinfo' => $self->payinfo,
2563 #don't ever *search* on reason! #'reason' =>
2569 Returns all notes (see L<FS::cust_main_note>) for this customer.
2574 my($self,$orderby_classnum) = (shift,shift);
2575 my $orderby = "sticky DESC, _date DESC";
2576 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2577 qsearch( 'cust_main_note',
2578 { 'custnum' => $self->custnum },
2580 "ORDER BY $orderby",
2586 Returns the agent (see L<FS::agent>) for this customer.
2590 Returns the agent name (see L<FS::agent>) for this customer.
2596 $self->agent->agent;
2601 Returns any tags associated with this customer, as FS::cust_tag objects,
2602 or an empty list if there are no tags.
2606 Returns any tags associated with this customer, as FS::part_tag objects,
2607 or an empty list if there are no tags.
2613 map $_->part_tag, $self->cust_tag;
2619 Returns the customer class, as an FS::cust_class object, or the empty string
2620 if there is no customer class.
2624 Returns the customer category name, or the empty string if there is no customer
2631 my $cust_class = $self->cust_class;
2633 ? $cust_class->categoryname
2639 Returns the customer class name, or the empty string if there is no customer
2646 my $cust_class = $self->cust_class;
2648 ? $cust_class->classname
2654 Returns the external tax status, as an FS::tax_status object, or the empty
2655 string if there is no tax status.
2661 if ( $self->taxstatusnum ) {
2662 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2670 Returns the tax status code if there is one.
2676 my $tax_status = $self->tax_status;
2678 ? $tax_status->taxstatus
2682 =item BILLING METHODS
2684 Documentation on billing methods has been moved to
2685 L<FS::cust_main::Billing>.
2687 =item REALTIME BILLING METHODS
2689 Documentation on realtime billing methods has been moved to
2690 L<FS::cust_main::Billing_Realtime>.
2694 Removes the I<paycvv> field from the database directly.
2696 If there is an error, returns the error, otherwise returns false.
2698 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2704 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2705 or return dbh->errstr;
2706 $sth->execute($self->custnum)
2707 or return $sth->errstr;
2714 Returns the total owed for this customer on all invoices
2715 (see L<FS::cust_bill/owed>).
2721 $self->total_owed_date(2145859200); #12/31/2037
2724 =item total_owed_date TIME
2726 Returns the total owed for this customer on all invoices with date earlier than
2727 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2728 see L<Time::Local> and L<Date::Parse> for conversion functions.
2732 sub total_owed_date {
2736 my $custnum = $self->custnum;
2738 my $owed_sql = FS::cust_bill->owed_sql;
2741 SELECT SUM($owed_sql) FROM cust_bill
2742 WHERE custnum = $custnum
2746 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2750 =item total_owed_pkgnum PKGNUM
2752 Returns the total owed on all invoices for this customer's specific package
2753 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2757 sub total_owed_pkgnum {
2758 my( $self, $pkgnum ) = @_;
2759 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2762 =item total_owed_date_pkgnum TIME PKGNUM
2764 Returns the total owed for this customer's specific package when using
2765 experimental package balances on all invoices with date earlier than
2766 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2767 see L<Time::Local> and L<Date::Parse> for conversion functions.
2771 sub total_owed_date_pkgnum {
2772 my( $self, $time, $pkgnum ) = @_;
2775 foreach my $cust_bill (
2776 grep { $_->_date <= $time }
2777 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2779 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2781 sprintf( "%.2f", $total_bill );
2787 Returns the total amount of all payments.
2794 $total += $_->paid foreach $self->cust_pay;
2795 sprintf( "%.2f", $total );
2798 =item total_unapplied_credits
2800 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2801 customer. See L<FS::cust_credit/credited>.
2803 =item total_credited
2805 Old name for total_unapplied_credits. Don't use.
2809 sub total_credited {
2810 #carp "total_credited deprecated, use total_unapplied_credits";
2811 shift->total_unapplied_credits(@_);
2814 sub total_unapplied_credits {
2817 my $custnum = $self->custnum;
2819 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2822 SELECT SUM($unapplied_sql) FROM cust_credit
2823 WHERE custnum = $custnum
2826 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2830 =item total_unapplied_credits_pkgnum PKGNUM
2832 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2833 customer. See L<FS::cust_credit/credited>.
2837 sub total_unapplied_credits_pkgnum {
2838 my( $self, $pkgnum ) = @_;
2839 my $total_credit = 0;
2840 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2841 sprintf( "%.2f", $total_credit );
2845 =item total_unapplied_payments
2847 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2848 See L<FS::cust_pay/unapplied>.
2852 sub total_unapplied_payments {
2855 my $custnum = $self->custnum;
2857 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2860 SELECT SUM($unapplied_sql) FROM cust_pay
2861 WHERE custnum = $custnum
2864 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2868 =item total_unapplied_payments_pkgnum PKGNUM
2870 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2871 specific package when using experimental package balances. See
2872 L<FS::cust_pay/unapplied>.
2876 sub total_unapplied_payments_pkgnum {
2877 my( $self, $pkgnum ) = @_;
2878 my $total_unapplied = 0;
2879 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2880 sprintf( "%.2f", $total_unapplied );
2884 =item total_unapplied_refunds
2886 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2887 customer. See L<FS::cust_refund/unapplied>.
2891 sub total_unapplied_refunds {
2893 my $custnum = $self->custnum;
2895 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2898 SELECT SUM($unapplied_sql) FROM cust_refund
2899 WHERE custnum = $custnum
2902 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2908 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2909 total_unapplied_credits minus total_unapplied_payments).
2915 $self->balance_date_range;
2918 =item balance_date TIME
2920 Returns the balance for this customer, only considering invoices with date
2921 earlier than TIME (total_owed_date minus total_credited minus
2922 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2923 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2930 $self->balance_date_range(shift);
2933 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2935 Returns the balance for this customer, optionally considering invoices with
2936 date earlier than START_TIME, and not later than END_TIME
2937 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2939 Times are specified as SQL fragments or numeric
2940 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2941 L<Date::Parse> for conversion functions. The empty string can be passed
2942 to disable that time constraint completely.
2944 Accepts the same options as L<balance_date_sql>:
2948 =item unapplied_date
2950 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)
2954 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2955 time will be ignored. Note that START_TIME and END_TIME only limit the date
2956 range for invoices and I<unapplied> payments, credits, and refunds.
2962 sub balance_date_range {
2964 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2965 ') FROM cust_main WHERE custnum='. $self->custnum;
2966 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2969 =item balance_pkgnum PKGNUM
2971 Returns the balance for this customer's specific package when using
2972 experimental package balances (total_owed plus total_unrefunded, minus
2973 total_unapplied_credits minus total_unapplied_payments)
2977 sub balance_pkgnum {
2978 my( $self, $pkgnum ) = @_;
2981 $self->total_owed_pkgnum($pkgnum)
2982 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2983 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2984 - $self->total_unapplied_credits_pkgnum($pkgnum)
2985 - $self->total_unapplied_payments_pkgnum($pkgnum)
2991 Returns a hash of useful information for making a payment.
3001 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3002 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3003 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3007 For credit card transactions:
3019 For electronic check transactions:
3034 $return{balance} = $self->balance;
3036 $return{payname} = $self->payname
3037 || ( $self->first. ' '. $self->get('last') );
3039 $return{$_} = $self->bill_location->$_
3040 for qw(address1 address2 city state zip);
3042 $return{payby} = $self->payby;
3043 $return{stateid_state} = $self->stateid_state;
3045 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3046 $return{card_type} = cardtype($self->payinfo);
3047 $return{payinfo} = $self->paymask;
3049 @return{'month', 'year'} = $self->paydate_monthyear;
3053 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3054 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3055 $return{payinfo1} = $payinfo1;
3056 $return{payinfo2} = $payinfo2;
3057 $return{paytype} = $self->paytype;
3058 $return{paystate} = $self->paystate;
3062 #doubleclick protection
3064 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3072 Returns the next payment expiration date for this customer. If they have no
3073 payment methods that will expire, returns 0.
3079 # filter out the ones that individually return 0, but then return 0 if
3080 # there are no results
3081 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3082 min( @epochs ) || 0;
3085 =item paydate_epoch_sql
3087 Returns an SQL expression to get the next payment expiration date for a
3088 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3089 dates, so that it's safe to test for "will it expire before date X" for any
3094 sub paydate_epoch_sql {
3096 my $paydate = FS::cust_payby->paydate_epoch_sql;
3097 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3101 my( $self, $taxname ) = @_;
3103 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3104 'taxname' => $taxname,
3109 =item cust_main_exemption
3111 =item invoicing_list
3113 Returns a list of email addresses (with svcnum entries expanded), and the word
3114 'POST' if the customer receives postal invoices.
3118 sub invoicing_list {
3119 my( $self, $arrayref ) = @_;
3122 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3125 my @emails = $self->invoicing_list_emailonly;
3126 push @emails, 'POST' if $self->get('postal_invoice');
3131 =item check_invoicing_list ARRAYREF
3133 Checks these arguements as valid input for the invoicing_list method. If there
3134 is an error, returns the error, otherwise returns false.
3138 sub check_invoicing_list {
3139 my( $self, $arrayref ) = @_;
3141 foreach my $address ( @$arrayref ) {
3143 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3144 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3147 my $cust_main_invoice = new FS::cust_main_invoice ( {
3148 'custnum' => $self->custnum,
3151 my $error = $self->custnum
3152 ? $cust_main_invoice->check
3153 : $cust_main_invoice->checkdest
3155 return $error if $error;
3159 return "Email address required"
3160 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3161 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3168 Returns the email addresses of all accounts provisioned for this customer.
3175 foreach my $cust_pkg ( $self->all_pkgs ) {
3176 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3178 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3179 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3181 $list{$_}=1 foreach map { $_->email } @svc_acct;
3186 =item invoicing_list_addpost
3188 Adds postal invoicing to this customer. If this customer is already configured
3189 to receive postal invoices, does nothing.
3193 sub invoicing_list_addpost {
3195 if ( $self->get('postal_invoice') eq '' ) {
3196 $self->set('postal_invoice', 'Y');
3197 my $error = $self->replace;
3198 warn $error if $error; # should fail harder, but this is traditional
3202 =item invoicing_list_emailonly
3204 Returns the list of email invoice recipients (invoicing_list without non-email
3205 destinations such as POST and FAX).
3209 sub invoicing_list_emailonly {
3211 warn "$me invoicing_list_emailonly called"
3213 return () if !$self->custnum; # not yet inserted
3214 return map { $_->emailaddress }
3216 table => 'cust_contact',
3217 select => 'emailaddress',
3218 addl_from => ' JOIN contact USING (contactnum) '.
3219 ' JOIN contact_email USING (contactnum)',
3220 hashref => { 'custnum' => $self->custnum, },
3221 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3225 =item invoicing_list_emailonly_scalar
3227 Returns the list of email invoice recipients (invoicing_list without non-email
3228 destinations such as POST and FAX) as a comma-separated scalar.
3232 sub invoicing_list_emailonly_scalar {
3234 warn "$me invoicing_list_emailonly_scalar called"
3236 join(', ', $self->invoicing_list_emailonly);
3239 =item contact_list [ CLASSNUM, ... ]
3241 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3242 a list of contact classnums is given, returns only contacts in those
3243 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3244 are marked as invoice destinations. If '0' is given, also returns contacts
3247 If no arguments are given, returns all contacts for the customer.
3255 select => 'contact.*, cust_contact.invoice_dest',
3256 addl_from => ' JOIN cust_contact USING (contactnum)',
3257 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3263 if ( $_ eq 'invoice' ) {
3264 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3265 } elsif ( $_ eq '0' ) {
3266 push @orwhere, 'cust_contact.classnum is null';
3267 } elsif ( /^\d+$/ ) {
3268 push @classnums, $_;
3270 die "bad classnum argument '$_'";
3275 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3278 $search->{extra_sql} .= ' AND (' .
3279 join(' OR ', map "( $_ )", @orwhere) .
3286 =item contact_list_email [ CLASSNUM, ... ]
3288 Same as L</contact_list>, but returns email destinations instead of contact
3293 sub contact_list_email {
3295 my @contacts = $self->contact_list(@_);
3297 foreach my $contact (@contacts) {
3298 foreach my $contact_email ($contact->contact_email) {
3299 push @emails, Email::Address->new( $contact->firstlast,
3300 $contact_email->emailaddress
3307 =item referral_custnum_cust_main
3309 Returns the customer who referred this customer (or the empty string, if
3310 this customer was not referred).
3312 Note the difference with referral_cust_main method: This method,
3313 referral_custnum_cust_main returns the single customer (if any) who referred
3314 this customer, while referral_cust_main returns an array of customers referred
3319 sub referral_custnum_cust_main {
3321 return '' unless $self->referral_custnum;
3322 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3325 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3327 Returns an array of customers referred by this customer (referral_custnum set
3328 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3329 customers referred by customers referred by this customer and so on, inclusive.
3330 The default behavior is DEPTH 1 (no recursion).
3332 Note the difference with referral_custnum_cust_main method: This method,
3333 referral_cust_main, returns an array of customers referred BY this customer,
3334 while referral_custnum_cust_main returns the single customer (if any) who
3335 referred this customer.
3339 sub referral_cust_main {
3341 my $depth = @_ ? shift : 1;
3342 my $exclude = @_ ? shift : {};
3345 map { $exclude->{$_->custnum}++; $_; }
3346 grep { ! $exclude->{ $_->custnum } }
3347 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3351 map { $_->referral_cust_main($depth-1, $exclude) }
3358 =item referral_cust_main_ncancelled
3360 Same as referral_cust_main, except only returns customers with uncancelled
3365 sub referral_cust_main_ncancelled {
3367 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3370 =item referral_cust_pkg [ DEPTH ]
3372 Like referral_cust_main, except returns a flat list of all unsuspended (and
3373 uncancelled) packages for each customer. The number of items in this list may
3374 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3378 sub referral_cust_pkg {
3380 my $depth = @_ ? shift : 1;
3382 map { $_->unsuspended_pkgs }
3383 grep { $_->unsuspended_pkgs }
3384 $self->referral_cust_main($depth);
3387 =item referring_cust_main
3389 Returns the single cust_main record for the customer who referred this customer
3390 (referral_custnum), or false.
3394 sub referring_cust_main {
3396 return '' unless $self->referral_custnum;
3397 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3400 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3402 Applies a credit to this customer. If there is an error, returns the error,
3403 otherwise returns false.
3405 REASON can be a text string, an FS::reason object, or a scalar reference to
3406 a reasonnum. If a text string, it will be automatically inserted as a new
3407 reason, and a 'reason_type' option must be passed to indicate the
3408 FS::reason_type for the new reason.
3410 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3411 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3412 I<commission_pkgnum>.
3414 Any other options are passed to FS::cust_credit::insert.
3419 my( $self, $amount, $reason, %options ) = @_;
3421 my $cust_credit = new FS::cust_credit {
3422 'custnum' => $self->custnum,
3423 'amount' => $amount,
3426 if ( ref($reason) ) {
3428 if ( ref($reason) eq 'SCALAR' ) {
3429 $cust_credit->reasonnum( $$reason );
3431 $cust_credit->reasonnum( $reason->reasonnum );
3435 $cust_credit->set('reason', $reason)
3438 $cust_credit->$_( delete $options{$_} )
3439 foreach grep exists($options{$_}),
3440 qw( addlinfo eventnum ),
3441 map "commission_$_", qw( agentnum salesnum pkgnum );
3443 $cust_credit->insert(%options);
3447 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3449 Creates a one-time charge for this customer. If there is an error, returns
3450 the error, otherwise returns false.
3452 New-style, with a hashref of options:
3454 my $error = $cust_main->charge(
3458 'start_date' => str2time('7/4/2009'),
3459 'pkg' => 'Description',
3460 'comment' => 'Comment',
3461 'additional' => [], #extra invoice detail
3462 'classnum' => 1, #pkg_class
3464 'setuptax' => '', # or 'Y' for tax exempt
3466 'locationnum'=> 1234, # optional
3469 'taxclass' => 'Tax class',
3472 'taxproduct' => 2, #part_pkg_taxproduct
3473 'override' => {}, #XXX describe
3475 #will be filled in with the new object
3476 'cust_pkg_ref' => \$cust_pkg,
3478 #generate an invoice immediately
3480 'invoice_terms' => '', #with these terms
3486 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3490 #super false laziness w/quotation::charge
3493 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3494 my ( $pkg, $comment, $additional );
3495 my ( $setuptax, $taxclass ); #internal taxes
3496 my ( $taxproduct, $override ); #vendor (CCH) taxes
3498 my $separate_bill = '';
3499 my $cust_pkg_ref = '';
3500 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3502 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3503 if ( ref( $_[0] ) ) {
3504 $amount = $_[0]->{amount};
3505 $setup_cost = $_[0]->{setup_cost};
3506 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3507 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3508 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3509 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3510 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3511 : '$'. sprintf("%.2f",$amount);
3512 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3513 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3514 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3515 $additional = $_[0]->{additional} || [];
3516 $taxproduct = $_[0]->{taxproductnum};
3517 $override = { '' => $_[0]->{tax_override} };
3518 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3519 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3520 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3521 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3522 $separate_bill = $_[0]->{separate_bill} || '';
3523 $discountnum = $_[0]->{setup_discountnum};
3524 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3525 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3531 $pkg = @_ ? shift : 'One-time charge';
3532 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3534 $taxclass = @_ ? shift : '';
3538 local $SIG{HUP} = 'IGNORE';
3539 local $SIG{INT} = 'IGNORE';
3540 local $SIG{QUIT} = 'IGNORE';
3541 local $SIG{TERM} = 'IGNORE';
3542 local $SIG{TSTP} = 'IGNORE';
3543 local $SIG{PIPE} = 'IGNORE';
3545 my $oldAutoCommit = $FS::UID::AutoCommit;
3546 local $FS::UID::AutoCommit = 0;
3549 my $part_pkg = new FS::part_pkg ( {
3551 'comment' => $comment,
3555 'classnum' => ( $classnum ? $classnum : '' ),
3556 'setuptax' => $setuptax,
3557 'taxclass' => $taxclass,
3558 'taxproductnum' => $taxproduct,
3559 'setup_cost' => $setup_cost,
3562 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3563 ( 0 .. @$additional - 1 )
3565 'additional_count' => scalar(@$additional),
3566 'setup_fee' => $amount,
3569 my $error = $part_pkg->insert( options => \%options,
3570 tax_overrides => $override,
3573 $dbh->rollback if $oldAutoCommit;
3577 my $pkgpart = $part_pkg->pkgpart;
3578 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3579 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3580 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3581 $error = $type_pkgs->insert;
3583 $dbh->rollback if $oldAutoCommit;
3588 my $cust_pkg = new FS::cust_pkg ( {
3589 'custnum' => $self->custnum,
3590 'pkgpart' => $pkgpart,
3591 'quantity' => $quantity,
3592 'start_date' => $start_date,
3593 'no_auto' => $no_auto,
3594 'separate_bill' => $separate_bill,
3595 'locationnum' => $locationnum,
3596 'setup_discountnum' => $discountnum,
3597 'setup_discountnum_amount' => $discountnum_amount,
3598 'setup_discountnum_percent' => $discountnum_percent,
3601 $error = $cust_pkg->insert;
3603 $dbh->rollback if $oldAutoCommit;
3605 } elsif ( $cust_pkg_ref ) {
3606 ${$cust_pkg_ref} = $cust_pkg;
3610 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3611 'pkg_list' => [ $cust_pkg ],
3614 $dbh->rollback if $oldAutoCommit;
3619 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3624 #=item charge_postal_fee
3626 #Applies a one time charge this customer. If there is an error,
3627 #returns the error, returns the cust_pkg charge object or false
3628 #if there was no charge.
3632 # This should be a customer event. For that to work requires that bill
3633 # also be a customer event.
3635 sub charge_postal_fee {
3638 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3639 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3641 my $cust_pkg = new FS::cust_pkg ( {
3642 'custnum' => $self->custnum,
3643 'pkgpart' => $pkgpart,
3647 my $error = $cust_pkg->insert;
3648 $error ? $error : $cust_pkg;
3651 =item num_cust_attachment_deleted
3653 Returns the number of deleted attachments for this customer (see
3654 L<FS::num_cust_attachment>).
3658 sub num_cust_attachments_deleted {
3661 " SELECT COUNT(*) FROM cust_attachment ".
3662 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3669 Returns the most recent invnum (invoice number) for this customer.
3676 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3681 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3683 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3685 Optionally, a list or hashref of additional arguments to the qsearch call can
3692 my $opt = ref($_[0]) ? shift : { @_ };
3694 #return $self->num_cust_bill unless wantarray || keys %$opt;
3696 $opt->{'table'} = 'cust_bill';
3697 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3698 $opt->{'hashref'}{'custnum'} = $self->custnum;
3699 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3701 map { $_ } #behavior of sort undefined in scalar context
3702 sort { $a->_date <=> $b->_date }
3706 =item open_cust_bill
3708 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3713 sub open_cust_bill {
3717 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3723 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3725 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3729 sub legacy_cust_bill {
3732 #return $self->num_legacy_cust_bill unless wantarray;
3734 map { $_ } #behavior of sort undefined in scalar context
3735 sort { $a->_date <=> $b->_date }
3736 qsearch({ 'table' => 'legacy_cust_bill',
3737 'hashref' => { 'custnum' => $self->custnum, },
3738 'order_by' => 'ORDER BY _date ASC',
3742 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3744 Returns all the statements (see L<FS::cust_statement>) for this customer.
3746 Optionally, a list or hashref of additional arguments to the qsearch call can
3751 =item cust_bill_void
3753 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3757 sub cust_bill_void {
3760 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3761 sort { $a->_date <=> $b->_date }
3762 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3765 sub cust_statement {
3767 my $opt = ref($_[0]) ? shift : { @_ };
3769 #return $self->num_cust_statement unless wantarray || keys %$opt;
3771 $opt->{'table'} = 'cust_statement';
3772 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3773 $opt->{'hashref'}{'custnum'} = $self->custnum;
3774 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3776 map { $_ } #behavior of sort undefined in scalar context
3777 sort { $a->_date <=> $b->_date }
3781 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3783 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3785 Optionally, a list or hashref of additional arguments to the qsearch call can
3786 be passed following the SVCDB.
3793 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3794 warn "$me svc_x requires a svcdb";
3797 my $opt = ref($_[0]) ? shift : { @_ };
3799 $opt->{'table'} = $svcdb;
3800 $opt->{'addl_from'} =
3801 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3802 ($opt->{'addl_from'} || '');
3804 my $custnum = $self->custnum;
3805 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3806 my $where = "cust_pkg.custnum = $custnum";
3808 my $extra_sql = $opt->{'extra_sql'} || '';
3809 if ( keys %{ $opt->{'hashref'} } ) {
3810 $extra_sql = " AND $where $extra_sql";
3813 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3814 $extra_sql = "WHERE $where AND $1";
3817 $extra_sql = "WHERE $where $extra_sql";
3820 $opt->{'extra_sql'} = $extra_sql;
3825 # required for use as an eventtable;
3828 $self->svc_x('svc_acct', @_);
3833 Returns all the credits (see L<FS::cust_credit>) for this customer.
3840 #return $self->num_cust_credit unless wantarray;
3842 map { $_ } #behavior of sort undefined in scalar context
3843 sort { $a->_date <=> $b->_date }
3844 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3847 =item cust_credit_pkgnum
3849 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3850 package when using experimental package balances.
3854 sub cust_credit_pkgnum {
3855 my( $self, $pkgnum ) = @_;
3856 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3857 sort { $a->_date <=> $b->_date }
3858 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3859 'pkgnum' => $pkgnum,
3864 =item cust_credit_void
3866 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3870 sub cust_credit_void {
3873 sort { $a->_date <=> $b->_date }
3874 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3879 Returns all the payments (see L<FS::cust_pay>) for this customer.
3885 my $opt = ref($_[0]) ? shift : { @_ };
3887 return $self->num_cust_pay unless wantarray || keys %$opt;
3889 $opt->{'table'} = 'cust_pay';
3890 $opt->{'hashref'}{'custnum'} = $self->custnum;
3892 map { $_ } #behavior of sort undefined in scalar context
3893 sort { $a->_date <=> $b->_date }
3900 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3901 called automatically when the cust_pay method is used in a scalar context.
3907 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3908 my $sth = dbh->prepare($sql) or die dbh->errstr;
3909 $sth->execute($self->custnum) or die $sth->errstr;
3910 $sth->fetchrow_arrayref->[0];
3913 =item unapplied_cust_pay
3915 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3919 sub unapplied_cust_pay {
3923 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3929 =item cust_pay_pkgnum
3931 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3932 package when using experimental package balances.
3936 sub cust_pay_pkgnum {
3937 my( $self, $pkgnum ) = @_;
3938 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3939 sort { $a->_date <=> $b->_date }
3940 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3941 'pkgnum' => $pkgnum,
3948 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3954 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3955 sort { $a->_date <=> $b->_date }
3956 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3959 =item cust_pay_pending
3961 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3962 (without status "done").
3966 sub cust_pay_pending {
3968 return $self->num_cust_pay_pending unless wantarray;
3969 sort { $a->_date <=> $b->_date }
3970 qsearch( 'cust_pay_pending', {
3971 'custnum' => $self->custnum,
3972 'status' => { op=>'!=', value=>'done' },
3977 =item cust_pay_pending_attempt
3979 Returns all payment attempts / declined payments for this customer, as pending
3980 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3981 a corresponding payment (see L<FS::cust_pay>).
3985 sub cust_pay_pending_attempt {
3987 return $self->num_cust_pay_pending_attempt unless wantarray;
3988 sort { $a->_date <=> $b->_date }
3989 qsearch( 'cust_pay_pending', {
3990 'custnum' => $self->custnum,
3997 =item num_cust_pay_pending
3999 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4000 customer (without status "done"). Also called automatically when the
4001 cust_pay_pending method is used in a scalar context.
4005 sub num_cust_pay_pending {
4008 " SELECT COUNT(*) FROM cust_pay_pending ".
4009 " WHERE custnum = ? AND status != 'done' ",
4014 =item num_cust_pay_pending_attempt
4016 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4017 customer, with status "done" but without a corresp. Also called automatically when the
4018 cust_pay_pending method is used in a scalar context.
4022 sub num_cust_pay_pending_attempt {
4025 " SELECT COUNT(*) FROM cust_pay_pending ".
4026 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4033 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4039 map { $_ } #return $self->num_cust_refund unless wantarray;
4040 sort { $a->_date <=> $b->_date }
4041 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4044 =item display_custnum
4046 Returns the displayed customer number for this customer: agent_custid if
4047 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4051 sub display_custnum {
4054 return $self->agent_custid
4055 if $default_agent_custid && $self->agent_custid;
4057 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4061 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4062 } elsif ( $custnum_display_length ) {
4063 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4065 return $self->custnum;
4071 Returns a name string for this customer, either "Company (Last, First)" or
4078 my $name = $self->contact;
4079 $name = $self->company. " ($name)" if $self->company;
4083 =item batch_payment_payname
4085 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
4086 based on if a company name exists and is the account being used a business account.
4090 sub batch_payment_payname {
4092 my $cust_pay_batch = shift;
4095 if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
4096 else { $name = $self->first .' '. $self->last; }
4098 $name = $self->company
4099 if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
4104 =item service_contact
4106 Returns the L<FS::contact> object for this customer that has the 'Service'
4107 contact class, or undef if there is no such contact. Deprecated; don't use
4112 sub service_contact {
4114 if ( !exists($self->{service_contact}) ) {
4115 my $classnum = $self->scalar_sql(
4116 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4117 ) || 0; #if it's zero, qsearchs will return nothing
4118 my $cust_contact = qsearchs('cust_contact', {
4119 'classnum' => $classnum,
4120 'custnum' => $self->custnum,
4122 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4124 $self->{service_contact};
4129 Returns a name string for this (service/shipping) contact, either
4130 "Company (Last, First)" or "Last, First".
4137 my $name = $self->ship_contact;
4138 $name = $self->company. " ($name)" if $self->company;
4144 Returns a name string for this customer, either "Company" or "First Last".
4150 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4153 =item ship_name_short
4155 Returns a name string for this (service/shipping) contact, either "Company"
4160 sub ship_name_short {
4162 $self->service_contact
4163 ? $self->ship_contact_firstlast
4169 Returns this customer's full (billing) contact name only, "Last, First"
4175 $self->get('last'). ', '. $self->first;
4180 Returns this customer's full (shipping) contact name only, "Last, First"
4186 my $contact = $self->service_contact || $self;
4187 $contact->get('last') . ', ' . $contact->get('first');
4190 =item contact_firstlast
4192 Returns this customers full (billing) contact name only, "First Last".
4196 sub contact_firstlast {
4198 $self->first. ' '. $self->get('last');
4201 =item ship_contact_firstlast
4203 Returns this customer's full (shipping) contact name only, "First Last".
4207 sub ship_contact_firstlast {
4209 my $contact = $self->service_contact || $self;
4210 $contact->get('first') . ' '. $contact->get('last');
4213 sub bill_country_full {
4215 $self->bill_location->country_full;
4218 sub ship_country_full {
4220 $self->ship_location->country_full;
4223 =item county_state_county [ PREFIX ]
4225 Returns a string consisting of just the county, state and country.
4229 sub county_state_country {
4232 if ( @_ && $_[0] && $self->has_ship_address ) {
4233 $locationnum = $self->ship_locationnum;
4235 $locationnum = $self->bill_locationnum;
4237 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4238 $cust_location->county_state_country;
4241 =item geocode DATA_VENDOR
4243 Returns a value for the customer location as encoded by DATA_VENDOR.
4244 Currently this only makes sense for "CCH" as DATA_VENDOR.
4252 Returns a status string for this customer, currently:
4258 No packages have ever been ordered. Displayed as "No packages".
4262 Recurring packages all are new (not yet billed).
4266 One or more recurring packages is active.
4270 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4274 All non-cancelled recurring packages are suspended.
4278 All recurring packages are cancelled.
4282 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4283 cust_main-status_module configuration option.
4287 sub status { shift->cust_status(@_); }
4291 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4292 for my $status ( FS::cust_main->statuses() ) {
4293 my $method = $status.'_sql';
4294 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4295 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4296 $sth->execute( ($self->custnum) x $numnum )
4297 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4298 if ( $sth->fetchrow_arrayref->[0] ) {
4299 $self->hashref->{cust_status} = $status;
4305 =item is_status_delay_cancel
4307 Returns true if customer status is 'suspended'
4308 and all suspended cust_pkg return true for
4309 cust_pkg->is_status_delay_cancel.
4311 This is not a real status, this only meant for hacking display
4312 values, because otherwise treating the customer as suspended is
4313 really the whole point of the delay_cancel option.
4317 sub is_status_delay_cancel {
4319 return 0 unless $self->status eq 'suspended';
4320 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4321 return 0 unless $cust_pkg->is_status_delay_cancel;
4326 =item ucfirst_cust_status
4328 =item ucfirst_status
4330 Deprecated, use the cust_status_label method instead.
4332 Returns the status with the first character capitalized.
4336 sub ucfirst_status {
4337 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4338 local($ucfirst_nowarn) = 1;
4339 shift->ucfirst_cust_status(@_);
4342 sub ucfirst_cust_status {
4343 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4345 ucfirst($self->cust_status);
4348 =item cust_status_label
4352 Returns the display label for this status.
4356 sub status_label { shift->cust_status_label(@_); }
4358 sub cust_status_label {
4360 __PACKAGE__->statuslabels->{$self->cust_status};
4365 Returns a hex triplet color string for this customer's status.
4369 sub statuscolor { shift->cust_statuscolor(@_); }
4371 sub cust_statuscolor {
4373 __PACKAGE__->statuscolors->{$self->cust_status};
4376 =item tickets [ STATUS ]
4378 Returns an array of hashes representing the customer's RT tickets.
4380 An optional status (or arrayref or hashref of statuses) may be specified.
4386 my $status = ( @_ && $_[0] ) ? shift : '';
4388 my $num = $conf->config('cust_main-max_tickets') || 10;
4391 if ( $conf->config('ticket_system') ) {
4392 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4394 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4403 foreach my $priority (
4404 $conf->config('ticket_system-custom_priority_field-values'), ''
4406 last if scalar(@tickets) >= $num;
4408 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4409 $num - scalar(@tickets),
4420 =item appointments [ STATUS ]
4422 Returns an array of hashes representing the customer's RT tickets which
4429 my $status = ( @_ && $_[0] ) ? shift : '';
4431 return () unless $conf->config('ticket_system');
4433 my $queueid = $conf->config('ticket_system-appointment-queueid');
4435 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4444 # Return services representing svc_accts in customer support packages
4445 sub support_services {
4447 my %packages = map { $_ => 1 } $conf->config('support_packages');
4449 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4450 grep { $_->part_svc->svcdb eq 'svc_acct' }
4451 map { $_->cust_svc }
4452 grep { exists $packages{ $_->pkgpart } }
4453 $self->ncancelled_pkgs;
4457 # Return a list of latitude/longitude for one of the services (if any)
4458 sub service_coordinates {
4462 grep { $_->latitude && $_->longitude }
4464 map { $_->cust_svc }
4465 $self->ncancelled_pkgs;
4467 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4472 Returns a masked version of the named field
4477 my ($self,$field) = @_;
4481 'x'x(length($self->getfield($field))-4).
4482 substr($self->getfield($field), (length($self->getfield($field))-4));
4486 =item payment_history
4488 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4489 cust_credit and cust_refund objects. Each hashref has the following fields:
4491 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4493 I<date> - value of _date field, unix timestamp
4495 I<date_pretty> - user-friendly date
4497 I<description> - user-friendly description of item
4499 I<amount> - impact of item on user's balance
4500 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4501 Not to be confused with the native 'amount' field in cust_credit, see below.
4503 I<amount_pretty> - includes money char
4505 I<balance> - customer balance, chronologically as of this item
4507 I<balance_pretty> - includes money char
4509 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4511 I<paid> - amount paid for cust_pay records, undef for other types
4513 I<credit> - amount credited for cust_credit records, undef for other types.
4514 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4516 I<refund> - amount refunded for cust_refund records, undef for other types
4518 The four table-specific keys always have positive values, whether they reflect charges or payments.
4520 The following options may be passed to this method:
4522 I<line_items> - if true, returns charges ('Line item') rather than invoices
4524 I<start_date> - unix timestamp, only include records on or after.
4525 If specified, an item of type 'Previous' will also be included.
4526 It does not have table-specific fields.
4528 I<end_date> - unix timestamp, only include records before
4530 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4532 I<conf> - optional already-loaded FS::Conf object.
4536 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4537 # and also for sending customer statements, which should both be kept customer-friendly.
4538 # If you add anything that shouldn't be passed on through the API or exposed
4539 # to customers, add a new option to include it, don't include it by default
4540 sub payment_history {
4542 my $opt = ref($_[0]) ? $_[0] : { @_ };
4544 my $conf = $$opt{'conf'} || new FS::Conf;
4545 my $money_char = $conf->config("money_char") || '$',
4547 #first load entire history,
4548 #need previous to calculate previous balance
4549 #loading after end_date shouldn't hurt too much?
4551 if ( $$opt{'line_items'} ) {
4553 foreach my $cust_bill ( $self->cust_bill ) {
4556 'type' => 'Line item',
4557 'description' => $_->desc( $self->locale ).
4558 ( $_->sdate && $_->edate
4559 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4560 ' To '. time2str('%d-%b-%Y', $_->edate)
4563 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4564 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4565 'date' => $cust_bill->_date,
4566 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4568 foreach $cust_bill->cust_bill_pkg;
4575 'type' => 'Invoice',
4576 'description' => 'Invoice #'. $_->display_invnum,
4577 'amount' => sprintf('%.2f', $_->charged ),
4578 'charged' => sprintf('%.2f', $_->charged ),
4579 'date' => $_->_date,
4580 'date_pretty' => $self->time2str_local('short', $_->_date ),
4582 foreach $self->cust_bill;
4587 'type' => 'Payment',
4588 'description' => 'Payment', #XXX type
4589 'amount' => sprintf('%.2f', 0 - $_->paid ),
4590 'paid' => sprintf('%.2f', $_->paid ),
4591 'date' => $_->_date,
4592 'date_pretty' => $self->time2str_local('short', $_->_date ),
4594 foreach $self->cust_pay;
4598 'description' => 'Credit', #more info?
4599 'amount' => sprintf('%.2f', 0 -$_->amount ),
4600 'credit' => sprintf('%.2f', $_->amount ),
4601 'date' => $_->_date,
4602 'date_pretty' => $self->time2str_local('short', $_->_date ),
4604 foreach $self->cust_credit;
4608 'description' => 'Refund', #more info? type, like payment?
4609 'amount' => $_->refund,
4610 'refund' => $_->refund,
4611 'date' => $_->_date,
4612 'date_pretty' => $self->time2str_local('short', $_->_date ),
4614 foreach $self->cust_refund;
4616 #put it all in chronological order
4617 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4619 #calculate balance, filter items outside date range
4623 foreach my $item (@history) {
4624 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4625 $balance += $$item{'amount'};
4626 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4627 $previous += $$item{'amount'};
4630 $$item{'balance'} = sprintf("%.2f",$balance);
4631 foreach my $key ( qw(amount balance) ) {
4632 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4637 # start with previous balance, if there was one
4640 'type' => 'Previous',
4641 'description' => 'Previous balance',
4642 'amount' => sprintf("%.2f",$previous),
4643 'balance' => sprintf("%.2f",$previous),
4644 'date' => $$opt{'start_date'},
4645 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4647 #false laziness with above
4648 foreach my $key ( qw(amount balance) ) {
4649 $$item{$key.'_pretty'} = $$item{$key};
4650 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4652 unshift(@out,$item);
4655 @out = reverse @history if $$opt{'reverse_sort'};
4660 =item save_cust_payby
4662 Saves a new cust_payby for this customer, replacing an existing entry only
4663 in select circumstances. Does not validate input.
4665 If auto is specified, marks this as the customer's primary method, or the
4666 specified weight. Existing payment methods have their weight incremented as
4669 If bill_location is specified with auto, also sets location in cust_main.
4671 Will not insert complete duplicates of existing records, or records in which the
4672 only difference from an existing record is to turn off automatic payment (will
4673 return without error.) Will replace existing records in which the only difference
4674 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4675 Fields marked as preserved are optional, and existing values will not be overwritten with
4676 blanks when replacing.
4678 Accepts the following named parameters:
4688 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4692 optional, set higher than 1 for secondary, etc.
4700 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4708 optional, will be preserved when replacing
4716 CARD only, required, FS::cust_location object
4718 =item paystart_month
4720 CARD only, optional, will be preserved when replacing
4724 CARD only, optional, will be preserved when replacing
4728 CARD only, optional, will be preserved when replacing
4732 CARD only, only used if conf cvv-save is set appropriately
4742 =item saved_cust_payby
4744 scalar reference, for returning saved object
4750 #The code for this option is in place, but it's not currently used
4754 # existing cust_payby object to be replaced (must match custnum)
4756 # stateid/stateid_state/ss are not currently supported in cust_payby,
4757 # might not even work properly in 4.x, but will need to work here if ever added
4759 sub save_cust_payby {
4763 my $old = $opt{'replace'};
4764 my $new = new FS::cust_payby { $old ? $old->hash : () };
4765 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4766 $new->set( 'custnum' => $self->custnum );
4768 my $payby = $opt{'payment_payby'};
4769 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4771 # don't allow turning off auto when replacing
4772 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4774 my @check_existing; # payby relevant to this payment_payby
4776 # set payby based on auto
4777 if ( $payby eq 'CARD' ) {
4778 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4779 @check_existing = qw( CARD DCRD );
4780 } elsif ( $payby eq 'CHEK' ) {
4781 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4782 @check_existing = qw( CHEK DCHK );
4785 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4788 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4789 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4790 $new->set( 'payname' => $opt{'payname'} );
4791 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4793 my $conf = new FS::Conf;
4795 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4796 if ( $payby eq 'CARD' &&
4797 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4798 || $conf->exists('business-onlinepayment-verification')
4801 $new->set( 'paycvv' => $opt{'paycvv'} );
4803 $new->set( 'paycvv' => '');
4806 local $SIG{HUP} = 'IGNORE';
4807 local $SIG{INT} = 'IGNORE';
4808 local $SIG{QUIT} = 'IGNORE';
4809 local $SIG{TERM} = 'IGNORE';
4810 local $SIG{TSTP} = 'IGNORE';
4811 local $SIG{PIPE} = 'IGNORE';
4813 my $oldAutoCommit = $FS::UID::AutoCommit;
4814 local $FS::UID::AutoCommit = 0;
4817 # set fields specific to payment_payby
4818 if ( $payby eq 'CARD' ) {
4819 if ($opt{'bill_location'}) {
4820 $opt{'bill_location'}->set('custnum' => $self->custnum);
4821 my $error = $opt{'bill_location'}->find_or_insert;
4823 $dbh->rollback if $oldAutoCommit;
4826 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4828 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4829 $new->set( $field => $opt{$field} );
4832 foreach my $field ( qw(paytype paystate) ) {
4833 $new->set( $field => $opt{$field} );
4837 # other cust_payby to compare this to
4838 my @existing = $self->cust_payby(@check_existing);
4840 # fields that can overwrite blanks with values, but not values with blanks
4841 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4843 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4845 # generally, we don't want to overwrite existing cust_payby with this,
4846 # but we can replace if we're only marking it auto or adding a preserved field
4847 # and we can avoid saving a total duplicate or merely turning off auto
4849 foreach my $cust_payby (@existing) {
4850 # check fields that absolutely should not change
4851 foreach my $field ($new->fields) {
4852 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4853 next if grep(/^$field$/, @preserve );
4854 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4855 # check if paymask exists, if so stop and don't save, no need for a duplicate.
4856 return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4858 # now check fields that can replace if one value is blank
4860 foreach my $field (@preserve) {
4862 ( $new->get($field) and !$cust_payby->get($field) ) or
4863 ( $cust_payby->get($field) and !$new->get($field) )
4865 # prevention of overwriting values with blanks happens farther below
4867 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4871 unless ( $replace ) {
4872 # nearly identical, now check weight
4873 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4874 # ignore identical cust_payby, and ignore attempts to turn off auto
4875 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4876 $skip_cust_payby = 1;
4879 # otherwise, only change is to mark this as primary
4881 # if we got this far, we're definitely replacing
4888 $new->set( 'custpaybynum' => $old->custpaybynum );
4889 # don't turn off automatic payment (but allow it to be turned on)
4890 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4892 $new->set( 'payby' => $old->payby );
4893 $new->set( 'weight' => 1 );
4895 # make sure we're not overwriting values with blanks
4896 foreach my $field (@preserve) {
4897 if ( $old->get($field) and !$new->get($field) ) {
4898 $new->set( $field => $old->get($field) );
4903 # only overwrite cust_main bill_location if auto
4904 if ($opt{'auto'} && $opt{'bill_location'}) {
4905 $self->set('bill_location' => $opt{'bill_location'});
4906 my $error = $self->replace;
4908 $dbh->rollback if $oldAutoCommit;
4913 # done with everything except reweighting and saving cust_payby
4914 # still need to commit changes to cust_main and cust_location
4915 if ($skip_cust_payby) {
4916 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4920 # re-weight existing primary cust_pay for this payby
4922 foreach my $cust_payby (@existing) {
4923 # relies on cust_payby return order
4924 last unless $cust_payby->payby !~ /^D/;
4925 last if $cust_payby->weight > 1;
4926 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4927 next if $cust_payby->weight < ($opt{'weight'} || 1);
4928 $cust_payby->weight( $cust_payby->weight + 1 );
4929 my $error = $cust_payby->replace;
4931 $dbh->rollback if $oldAutoCommit;
4932 return "Error reweighting cust_payby: $error";
4937 # finally, save cust_payby
4938 my $error = $old ? $new->replace($old) : $new->insert;
4940 $dbh->rollback if $oldAutoCommit;
4944 ${$opt{'saved_cust_payby'}} = $new
4945 if $opt{'saved_cust_payby'};
4947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4952 =item remove_cvv_from_cust_payby PAYINFO
4954 Removes paycvv from associated cust_payby with matching PAYINFO.
4958 sub remove_cvv_from_cust_payby {
4959 my ($self,$payinfo) = @_;
4961 my $oldAutoCommit = $FS::UID::AutoCommit;
4962 local $FS::UID::AutoCommit = 0;
4965 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4966 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4967 $cust_payby->paycvv('');
4968 my $error = $cust_payby->replace;
4970 $dbh->rollback if $oldAutoCommit;
4975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4981 =head1 CLASS METHODS
4987 Class method that returns the list of possible status strings for customers
4988 (see L<the status method|/status>). For example:
4990 @statuses = FS::cust_main->statuses();
4996 keys %{ $self->statuscolors };
4999 =item cust_status_sql
5001 Returns an SQL fragment to determine the status of a cust_main record, as a
5006 sub cust_status_sql {
5008 for my $status ( FS::cust_main->statuses() ) {
5009 my $method = $status.'_sql';
5010 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
5019 Returns an SQL expression identifying prospective cust_main records (customers
5020 with no packages ever ordered)
5024 use vars qw($select_count_pkgs);
5025 $select_count_pkgs =
5026 "SELECT COUNT(*) FROM cust_pkg
5027 WHERE cust_pkg.custnum = cust_main.custnum";
5029 sub select_count_pkgs_sql {
5034 " 0 = ( $select_count_pkgs ) ";
5039 Returns an SQL expression identifying ordered cust_main records (customers with
5040 no active packages, but recurring packages not yet setup or one time charges
5046 FS::cust_main->none_active_sql.
5047 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5052 Returns an SQL expression identifying active cust_main records (customers with
5053 active recurring packages).
5058 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5061 =item none_active_sql
5063 Returns an SQL expression identifying cust_main records with no active
5064 recurring packages. This includes customers of status prospect, ordered,
5065 inactive, and suspended.
5069 sub none_active_sql {
5070 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5075 Returns an SQL expression identifying inactive cust_main records (customers with
5076 no active recurring packages, but otherwise unsuspended/uncancelled).
5081 FS::cust_main->none_active_sql.
5082 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5088 Returns an SQL expression identifying suspended cust_main records.
5093 sub suspended_sql { susp_sql(@_); }
5095 FS::cust_main->none_active_sql.
5096 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5102 Returns an SQL expression identifying cancelled cust_main records.
5106 sub cancel_sql { shift->cancelled_sql(@_); }
5109 =item uncancelled_sql
5111 Returns an SQL expression identifying un-cancelled cust_main records.
5115 sub uncancelled_sql { uncancel_sql(@_); }
5118 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5123 Returns an SQL fragment to retreive the balance.
5128 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5129 WHERE cust_bill.custnum = cust_main.custnum )
5130 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5131 WHERE cust_pay.custnum = cust_main.custnum )
5132 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5133 WHERE cust_credit.custnum = cust_main.custnum )
5134 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5135 WHERE cust_refund.custnum = cust_main.custnum )
5138 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5140 Returns an SQL fragment to retreive the balance for this customer, optionally
5141 considering invoices with date earlier than START_TIME, and not
5142 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5143 total_unapplied_payments).
5145 Times are specified as SQL fragments or numeric
5146 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5147 L<Date::Parse> for conversion functions. The empty string can be passed
5148 to disable that time constraint completely.
5150 Available options are:
5154 =item unapplied_date
5156 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)
5161 set to true to remove all customer comparison clauses, for totals
5166 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5171 JOIN clause (typically used with the total option)
5175 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5176 time will be ignored. Note that START_TIME and END_TIME only limit the date
5177 range for invoices and I<unapplied> payments, credits, and refunds.
5183 sub balance_date_sql {
5184 my( $class, $start, $end, %opt ) = @_;
5186 my $cutoff = $opt{'cutoff'};
5188 my $owed = FS::cust_bill->owed_sql($cutoff);
5189 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5190 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5191 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5193 my $j = $opt{'join'} || '';
5195 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5196 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5197 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5198 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5200 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5201 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5202 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5203 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5208 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5210 Returns an SQL fragment to retreive the total unapplied payments for this
5211 customer, only considering payments with date earlier than START_TIME, and
5212 optionally not later than END_TIME.
5214 Times are specified as SQL fragments or numeric
5215 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5216 L<Date::Parse> for conversion functions. The empty string can be passed
5217 to disable that time constraint completely.
5219 Available options are:
5223 sub unapplied_payments_date_sql {
5224 my( $class, $start, $end, %opt ) = @_;
5226 my $cutoff = $opt{'cutoff'};
5228 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5230 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5231 'unapplied_date'=>1 );
5233 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5236 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5238 Helper method for balance_date_sql; name (and usage) subject to change
5239 (suggestions welcome).
5241 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5242 cust_refund, cust_credit or cust_pay).
5244 If TABLE is "cust_bill" or the unapplied_date option is true, only
5245 considers records with date earlier than START_TIME, and optionally not
5246 later than END_TIME .
5250 sub _money_table_where {
5251 my( $class, $table, $start, $end, %opt ) = @_;
5254 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5255 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5256 push @where, "$table._date <= $start" if defined($start) && length($start);
5257 push @where, "$table._date > $end" if defined($end) && length($end);
5259 push @where, @{$opt{'where'}} if $opt{'where'};
5260 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5266 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5267 use FS::cust_main::Search;
5270 FS::cust_main::Search->search(@_);
5279 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5281 #Deprecated. Use event notification and message templates
5282 #(L<FS::msg_template>) instead.
5284 #Sends a templated email notification to the customer (see L<Text::Template>).
5286 #OPTIONS is a hash and may include
5288 #I<from> - the email sender (default is invoice_from)
5290 #I<to> - comma-separated scalar or arrayref of recipients
5291 # (default is invoicing_list)
5293 #I<subject> - The subject line of the sent email notification
5294 # (default is "Notice from company_name")
5296 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5299 #The following variables are vavailable in the template.
5301 #I<$first> - the customer first name
5302 #I<$last> - the customer last name
5303 #I<$company> - the customer company
5304 #I<$payby> - a description of the method of payment for the customer
5305 # # would be nice to use FS::payby::shortname
5306 #I<$payinfo> - the account information used to collect for this customer
5307 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5312 # my ($self, $template, %options) = @_;
5314 # return unless $conf->exists($template);
5316 # my $from = $conf->invoice_from_full($self->agentnum)
5317 # if $conf->exists('invoice_from', $self->agentnum);
5318 # $from = $options{from} if exists($options{from});
5320 # my $to = join(',', $self->invoicing_list_emailonly);
5321 # $to = $options{to} if exists($options{to});
5323 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5324 # if $conf->exists('company_name', $self->agentnum);
5325 # $subject = $options{subject} if exists($options{subject});
5327 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5328 # SOURCE => [ map "$_\n",
5329 # $conf->config($template)]
5331 # or die "can't create new Text::Template object: Text::Template::ERROR";
5332 # $notify_template->compile()
5333 # or die "can't compile template: Text::Template::ERROR";
5335 # $FS::notify_template::_template::company_name =
5336 # $conf->config('company_name', $self->agentnum);
5337 # $FS::notify_template::_template::company_address =
5338 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5340 # my $paydate = $self->paydate || '2037-12-31';
5341 # $FS::notify_template::_template::first = $self->first;
5342 # $FS::notify_template::_template::last = $self->last;
5343 # $FS::notify_template::_template::company = $self->company;
5344 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5345 # my $payby = $self->payby;
5346 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5347 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5349 # #credit cards expire at the end of the month/year of their exp date
5350 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5351 # $FS::notify_template::_template::payby = 'credit card';
5352 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5353 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5355 # }elsif ($payby eq 'COMP') {
5356 # $FS::notify_template::_template::payby = 'complimentary account';
5358 # $FS::notify_template::_template::payby = 'current method';
5360 # $FS::notify_template::_template::expdate = $expire_time;
5362 # for (keys %{$options{extra_fields}}){
5364 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5367 # send_email(from => $from,
5369 # subject => $subject,
5370 # body => $notify_template->fill_in( PACKAGE =>
5371 # 'FS::notify_template::_template' ),
5376 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5378 Generates a templated notification to the customer (see L<Text::Template>).
5380 OPTIONS is a hash and may include
5382 I<extra_fields> - a hashref of name/value pairs which will be substituted
5383 into the template. These values may override values mentioned below
5384 and those from the customer record.
5386 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5388 The following variables are available in the template instead of or in addition
5389 to the fields of the customer record.
5391 I<$payby> - a description of the method of payment for the customer
5392 # would be nice to use FS::payby::shortname
5393 I<$payinfo> - the masked account information used to collect for this customer
5394 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5395 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5399 # a lot like cust_bill::print_latex
5400 sub generate_letter {
5401 my ($self, $template, %options) = @_;
5403 warn "Template $template does not exist" && return
5404 unless $conf->exists($template) || $options{'template_text'};
5406 my $template_source = $options{'template_text'}
5407 ? [ $options{'template_text'} ]
5408 : [ map "$_\n", $conf->config($template) ];
5410 my $letter_template = new Text::Template
5412 SOURCE => $template_source,
5413 DELIMITERS => [ '[@--', '--@]' ],
5415 or die "can't create new Text::Template object: Text::Template::ERROR";
5417 $letter_template->compile()
5418 or die "can't compile template: Text::Template::ERROR";
5420 my %letter_data = map { $_ => $self->$_ } $self->fields;
5421 $letter_data{payinfo} = $self->mask_payinfo;
5423 #my $paydate = $self->paydate || '2037-12-31';
5424 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5426 my $payby = $self->payby;
5427 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5428 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5430 #credit cards expire at the end of the month/year of their exp date
5431 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5432 $letter_data{payby} = 'credit card';
5433 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5434 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5436 }elsif ($payby eq 'COMP') {
5437 $letter_data{payby} = 'complimentary account';
5439 $letter_data{payby} = 'current method';
5441 $letter_data{expdate} = $expire_time;
5443 for (keys %{$options{extra_fields}}){
5444 $letter_data{$_} = $options{extra_fields}->{$_};
5447 unless(exists($letter_data{returnaddress})){
5448 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5449 $self->agent_template)
5451 if ( length($retadd) ) {
5452 $letter_data{returnaddress} = $retadd;
5453 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5454 $letter_data{returnaddress} =
5455 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5459 ( $conf->config('company_name', $self->agentnum),
5460 $conf->config('company_address', $self->agentnum),
5464 $letter_data{returnaddress} = '~';
5468 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5470 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5472 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5474 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5478 ) or die "can't open temp file: $!\n";
5479 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5480 or die "can't write temp file: $!\n";
5482 $letter_data{'logo_file'} = $lh->filename;
5484 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5488 ) or die "can't open temp file: $!\n";
5490 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5492 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5493 return ($1, $letter_data{'logo_file'});
5497 =item print_ps TEMPLATE
5499 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5505 my($file, $lfile) = $self->generate_letter(@_);
5506 my $ps = FS::Misc::generate_ps($file);
5507 unlink($file.'.tex');
5513 =item print TEMPLATE
5515 Prints the filled in template.
5517 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5521 sub queueable_print {
5524 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5525 or die "invalid customer number: " . $opt{custnum};
5527 #do not backport this change to 3.x
5528 # my $error = $self->print( { 'template' => $opt{template} } );
5529 my $error = $self->print( $opt{'template'} );
5530 die $error if $error;
5534 my ($self, $template) = (shift, shift);
5536 [ $self->print_ps($template) ],
5537 'agentnum' => $self->agentnum,
5541 #these three subs should just go away once agent stuff is all config overrides
5543 sub agent_template {
5545 $self->_agent_plandata('agent_templatename');
5548 sub agent_invoice_from {
5550 $self->_agent_plandata('agent_invoice_from');
5553 sub _agent_plandata {
5554 my( $self, $option ) = @_;
5556 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5557 #agent-specific Conf
5559 use FS::part_event::Condition;
5561 my $agentnum = $self->agentnum;
5563 my $regexp = regexp_sql();
5565 my $part_event_option =
5567 'select' => 'part_event_option.*',
5568 'table' => 'part_event_option',
5570 LEFT JOIN part_event USING ( eventpart )
5571 LEFT JOIN part_event_option AS peo_agentnum
5572 ON ( part_event.eventpart = peo_agentnum.eventpart
5573 AND peo_agentnum.optionname = 'agentnum'
5574 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5576 LEFT JOIN part_event_condition
5577 ON ( part_event.eventpart = part_event_condition.eventpart
5578 AND part_event_condition.conditionname = 'cust_bill_age'
5580 LEFT JOIN part_event_condition_option
5581 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5582 AND part_event_condition_option.optionname = 'age'
5585 #'hashref' => { 'optionname' => $option },
5586 #'hashref' => { 'part_event_option.optionname' => $option },
5588 " WHERE part_event_option.optionname = ". dbh->quote($option).
5589 " AND action = 'cust_bill_send_agent' ".
5590 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5591 " AND peo_agentnum.optionname = 'agentnum' ".
5592 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5594 CASE WHEN part_event_condition_option.optionname IS NULL
5596 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5598 , part_event.weight".
5602 unless ( $part_event_option ) {
5603 return $self->agent->invoice_template || ''
5604 if $option eq 'agent_templatename';
5608 $part_event_option->optionvalue;
5612 sub process_o2m_qsearch {
5615 return qsearch($table, @_) unless $table eq 'contact';
5617 my $hashref = shift;
5618 my %hash = %$hashref;
5619 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5620 or die 'guru meditation #4343';
5622 qsearch({ 'table' => 'contact',
5623 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5624 'hashref' => \%hash,
5625 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5626 " cust_contact.custnum = $custnum "
5630 sub process_o2m_qsearchs {
5633 return qsearchs($table, @_) unless $table eq 'contact';
5635 my $hashref = shift;
5636 my %hash = %$hashref;
5637 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5638 or die 'guru meditation #2121';
5640 qsearchs({ 'table' => 'contact',
5641 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5642 'hashref' => \%hash,
5643 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5644 " cust_contact.custnum = $custnum "
5648 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5650 Subroutine (not a method), designed to be called from the queue.
5652 Takes a list of options and values.
5654 Pulls up the customer record via the custnum option and calls bill_and_collect.
5659 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5661 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5662 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5664 #without this errors don't get rolled back
5665 $args{'fatal'} = 1; # runs from job queue, will be caught
5667 $cust_main->bill_and_collect( %args );
5670 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5672 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5673 C<collect> part. This is used in batch tax calculation, where invoice
5674 generation and collection events have to be completely separated.
5678 sub queued_collect {
5680 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5682 $cust_main->collect(%args);
5685 sub process_bill_and_collect {
5688 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5689 or die "custnum '$param->{custnum}' not found!\n";
5690 $param->{'job'} = $job;
5691 $param->{'fatal'} = 1; # runs from job queue, will be caught
5692 $param->{'retry'} = 1;
5694 $cust_main->bill_and_collect( %$param );
5697 #starting to take quite a while for big dbs
5698 # (JRNL: journaled so it only happens once per database)
5699 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5700 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5701 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5702 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5703 # JRNL leading/trailing spaces in first, last, company
5704 # JRNL migrate to cust_payby
5705 # - otaker upgrade? journal and call it good? (double check to make sure
5706 # we're not still setting otaker here)
5708 #only going to get worse with new location stuff...
5710 sub _upgrade_data { #class method
5711 my ($class, %opts) = @_;
5714 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5717 #this seems to be the only expensive one.. why does it take so long?
5718 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5720 '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';
5721 FS::upgrade_journal->set_done('cust_main__signupdate');
5724 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5726 # fix yyyy-m-dd formatted paydates
5727 if ( driver_name =~ /^mysql/i ) {
5729 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5730 } else { # the SQL standard
5732 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5734 FS::upgrade_journal->set_done('cust_main__paydate');
5737 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5739 push @statements, #fix the weird BILL with a cc# in payinfo problem
5741 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5743 FS::upgrade_journal->set_done('cust_main__payinfo');
5748 foreach my $sql ( @statements ) {
5749 my $sth = dbh->prepare($sql) or die dbh->errstr;
5750 $sth->execute or die $sth->errstr;
5751 #warn ( (time - $t). " seconds\n" );
5755 local($ignore_expired_card) = 1;
5756 local($ignore_banned_card) = 1;
5757 local($skip_fuzzyfiles) = 1;
5758 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5760 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5762 #we don't want to decrypt them, just stuff them as-is into cust_payby
5763 local(@encrypted_fields) = ();
5765 local($FS::cust_payby::ignore_expired_card) = 1;
5766 local($FS::cust_payby::ignore_banned_card) = 1;
5767 local($FS::cust_payby::ignore_cardtype) = 1;
5769 my @payfields = qw( payby payinfo paycvv paymask
5770 paydate paystart_month paystart_year payissue
5771 payname paystate paytype payip
5774 my $search = new FS::Cursor {
5775 'table' => 'cust_main',
5776 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5779 while (my $cust_main = $search->fetch) {
5781 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5783 my $cust_payby = new FS::cust_payby {
5784 'custnum' => $cust_main->custnum,
5786 map { $_ => $cust_main->$_(); } @payfields
5789 my $error = $cust_payby->insert;
5790 die $error if $error;
5794 # at the time we do this, also migrate paytype into cust_pay_batch
5795 # so that batches that are open before the migration can still be
5797 if ( $cust_main->get('paytype') ) {
5798 my @cust_pay_batch = qsearch('cust_pay_batch', {
5799 'custnum' => $cust_main->custnum,
5803 foreach my $cust_pay_batch (@cust_pay_batch) {
5804 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5805 my $error = $cust_pay_batch->replace;
5806 die "$error (setting cust_pay_batch.paytype)" if $error;
5810 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5812 $cust_main->invoice_attn( $cust_main->payname )
5813 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5814 $cust_main->po_number( $cust_main->payinfo )
5815 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5817 $cust_main->setfield($_, '') foreach @payfields;
5818 my $error = $cust_main->replace;
5819 die "Error upgradging payment information for custnum ".
5820 $cust_main->custnum. ": $error"
5825 FS::upgrade_journal->set_done('cust_main__cust_payby');
5828 FS::cust_main::Location->_upgrade_data(%opts);
5830 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5832 foreach my $cust_main ( qsearch({
5833 'table' => 'cust_main',
5835 'extra_sql' => 'WHERE '.
5837 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5838 qw( first last company )
5841 my $error = $cust_main->replace;
5842 die $error if $error;
5845 FS::upgrade_journal->set_done('cust_main__trimspaces');
5849 $class->_upgrade_otaker(%opts);
5851 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5852 # existing records will be encrypted in queueable_upgrade (below)
5853 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5854 eval "use FS::Setup";
5856 FS::Setup::enable_encryption();
5861 sub queueable_upgrade {
5864 ### encryption gets turned on in _upgrade_data, above
5866 eval "use FS::upgrade_journal";
5869 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
5870 # clear that out before encrypting/tokenizing anything else
5871 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5872 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5873 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5874 my $sth = dbh->prepare($sql) or die dbh->errstr;
5875 $sth->execute or die $sth->errstr;
5877 FS::upgrade_journal->set_done('clear_payinfo_history');
5880 # fix Tokenized paycardtype and encrypt old records
5881 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5882 || ! FS::upgrade_journal->is_done('encryption_check')
5886 # allow replacement of closed cust_pay/cust_refund records
5887 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5889 # because it looks like nothing's changing
5890 local $FS::Record::no_update_diff = 1;
5892 # commit everything immediately
5893 local $FS::UID::AutoCommit = 1;
5895 # encrypt what's there
5896 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5897 my $tclass = 'FS::'.$table;
5900 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
5901 my $record = $tclass->by_key($recnum);
5902 next unless $record; # small chance it's been deleted, that's ok
5903 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5904 # window for possible conflict is practically nonexistant,
5905 # but just in case...
5906 $record = $record->select_for_update;
5907 if (!$record->custnum && $table eq 'cust_pay_pending') {
5908 $record->set('custnum_pending',1);
5910 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5912 local($ignore_expired_card) = 1;
5913 local($ignore_banned_card) = 1;
5914 local($skip_fuzzyfiles) = 1;
5915 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5917 my $error = $record->replace;
5918 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5922 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5923 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5926 # now that everything's encrypted, tokenize...
5927 FS::cust_main::Billing_Realtime::token_check(@_);
5930 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5931 # cust_payby might get deleted while this runs
5933 sub _upgrade_next_recnum {
5934 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5935 my $recnum = shift @$recnums;
5936 return $recnum if $recnum;
5937 my $tclass = 'FS::'.$table;
5938 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5939 my $sql = 'SELECT '.$tclass->primary_key.
5941 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5942 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5943 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5944 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5945 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5946 $sth->execute() or die $sth->errstr;
5948 while (my $rec = $sth->fetchrow_hashref) {
5949 push @$recnums, $rec->{$tclass->primary_key};
5952 $$lastrecnum = $$recnums[-1];
5953 return shift @$recnums;
5962 The delete method should possibly take an FS::cust_main object reference
5963 instead of a scalar customer number.
5965 Bill and collect options should probably be passed as references instead of a
5968 There should probably be a configuration file with a list of allowed credit
5971 No multiple currency support (probably a larger project than just this module).
5973 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5975 Birthdates rely on negative epoch values.
5977 The payby for card/check batches is broken. With mixed batching, bad
5980 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5984 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5985 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5986 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.