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 $implicit_contact->set($_, $i_cust_contact->$_)
1524 foreach qw( classnum selfservice_access comment );
1527 if ( $implicit_contact->contactnum ) {
1528 $error = $implicit_contact->replace;
1529 } elsif ( length($email) ) { # don't create a new contact if not needed
1530 $error = $implicit_contact->insert;
1534 $dbh->rollback if $oldAutoCommit;
1535 return "$error (adding email address $email)";
1540 # replace the customer record
1541 my $error = $self->SUPER::replace($old);
1544 $dbh->rollback if $oldAutoCommit;
1548 # now move packages to the new service location
1549 $self->set('ship_location', ''); #flush cache
1550 if ( $old->ship_locationnum and # should only be null during upgrade...
1551 $old->ship_locationnum != $self->ship_locationnum ) {
1552 $error = $old->ship_location->move_to($self->ship_location);
1554 $dbh->rollback if $oldAutoCommit;
1558 # don't move packages based on the billing location, but
1559 # disable it if it's no longer in use
1560 if ( $old->bill_locationnum and
1561 $old->bill_locationnum != $self->bill_locationnum ) {
1562 $error = $old->bill_location->disable_if_unused;
1564 $dbh->rollback if $oldAutoCommit;
1569 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1571 #this could be more efficient than deleting and re-inserting, if it matters
1572 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1573 my $error = $cust_tag->delete;
1575 $dbh->rollback if $oldAutoCommit;
1579 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1580 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1581 'custnum' => $self->custnum };
1582 my $error = $cust_tag->insert;
1584 $dbh->rollback if $oldAutoCommit;
1591 my $tax_exemption = delete $options{'tax_exemption'};
1592 if ( $tax_exemption ) {
1594 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1595 if ref($tax_exemption) eq 'ARRAY';
1597 my %cust_main_exemption =
1598 map { $_->taxname => $_ }
1599 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1601 foreach my $taxname ( keys %$tax_exemption ) {
1603 if ( $cust_main_exemption{$taxname} &&
1604 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1607 delete $cust_main_exemption{$taxname};
1611 my $cust_main_exemption = new FS::cust_main_exemption {
1612 'custnum' => $self->custnum,
1613 'taxname' => $taxname,
1614 'exempt_number' => $tax_exemption->{$taxname},
1616 my $error = $cust_main_exemption->insert;
1618 $dbh->rollback if $oldAutoCommit;
1619 return "inserting cust_main_exemption (transaction rolled back): $error";
1623 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1624 my $error = $cust_main_exemption->delete;
1626 $dbh->rollback if $oldAutoCommit;
1627 return "deleting cust_main_exemption (transaction rolled back): $error";
1633 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1635 my $error = $self->process_o2m(
1636 'table' => 'cust_payby',
1637 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1638 'params' => $cust_payby_params,
1639 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1642 $dbh->rollback if $oldAutoCommit;
1648 if ( my $contact_params = delete $options{'contact_params'} ) {
1650 # this can potentially replace contacts that were created by the
1651 # invoicing list argument, but the UI shouldn't allow both of them
1654 my $error = $self->process_o2m(
1655 'table' => 'contact',
1656 'fields' => FS::contact->cgi_contact_fields,
1657 'params' => $contact_params,
1660 $dbh->rollback if $oldAutoCommit;
1666 unless ( $import || $skip_fuzzyfiles ) {
1667 $error = $self->queue_fuzzyfiles_update;
1669 $dbh->rollback if $oldAutoCommit;
1670 return "updating fuzzy search cache: $error";
1674 # tax district update in cust_location
1676 # cust_main exports!
1678 my $export_args = $options{'export_args'} || [];
1681 map qsearch( 'part_export', {exportnum=>$_} ),
1682 $conf->config('cust_main-exports'); #, $agentnum
1684 foreach my $part_export ( @part_export ) {
1685 my $error = $part_export->export_replace( $self, $old, @$export_args);
1687 $dbh->rollback if $oldAutoCommit;
1688 return "exporting to ". $part_export->exporttype.
1689 " (transaction rolled back): $error";
1693 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1698 =item queue_fuzzyfiles_update
1700 Used by insert & replace to update the fuzzy search cache
1704 use FS::cust_main::Search;
1705 sub queue_fuzzyfiles_update {
1708 local $SIG{HUP} = 'IGNORE';
1709 local $SIG{INT} = 'IGNORE';
1710 local $SIG{QUIT} = 'IGNORE';
1711 local $SIG{TERM} = 'IGNORE';
1712 local $SIG{TSTP} = 'IGNORE';
1713 local $SIG{PIPE} = 'IGNORE';
1715 my $oldAutoCommit = $FS::UID::AutoCommit;
1716 local $FS::UID::AutoCommit = 0;
1719 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1720 my $queue = new FS::queue {
1721 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1723 my @args = "cust_main.$field", $self->get($field);
1724 my $error = $queue->insert( @args );
1726 $dbh->rollback if $oldAutoCommit;
1727 return "queueing job (transaction rolled back): $error";
1732 push @locations, $self->bill_location if $self->bill_locationnum;
1733 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1734 foreach my $location (@locations) {
1735 my $queue = new FS::queue {
1736 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1738 my @args = 'cust_location.address1', $location->address1;
1739 my $error = $queue->insert( @args );
1741 $dbh->rollback if $oldAutoCommit;
1742 return "queueing job (transaction rolled back): $error";
1746 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1753 Checks all fields to make sure this is a valid customer record. If there is
1754 an error, returns the error, otherwise returns false. Called by the insert
1755 and replace methods.
1762 warn "$me check BEFORE: \n". $self->_dump
1766 $self->ut_numbern('custnum')
1767 || $self->ut_number('agentnum')
1768 || $self->ut_textn('agent_custid')
1769 || $self->ut_number('refnum')
1770 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1771 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1772 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1773 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1774 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1775 || $self->ut_textn('custbatch')
1776 || $self->ut_name('last')
1777 || $self->ut_name('first')
1778 || $self->ut_snumbern('signupdate')
1779 || $self->ut_snumbern('birthdate')
1780 || $self->ut_namen('spouse_last')
1781 || $self->ut_namen('spouse_first')
1782 || $self->ut_snumbern('spouse_birthdate')
1783 || $self->ut_snumbern('anniversary_date')
1784 || $self->ut_textn('company')
1785 || $self->ut_textn('ship_company')
1786 || $self->ut_anything('comments')
1787 || $self->ut_numbern('referral_custnum')
1788 || $self->ut_textn('stateid')
1789 || $self->ut_textn('stateid_state')
1790 || $self->ut_textn('invoice_terms')
1791 || $self->ut_floatn('cdr_termination_percentage')
1792 || $self->ut_floatn('credit_limit')
1793 || $self->ut_numbern('billday')
1794 || $self->ut_numbern('prorate_day')
1795 || $self->ut_flag('force_prorate_day')
1796 || $self->ut_flag('edit_subject')
1797 || $self->ut_flag('calling_list_exempt')
1798 || $self->ut_flag('invoice_noemail')
1799 || $self->ut_flag('message_noemail')
1800 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1801 || $self->ut_currencyn('currency')
1802 || $self->ut_textn('po_number')
1803 || $self->ut_enum('complimentary', [ '', 'Y' ])
1804 || $self->ut_flag('invoice_ship_address')
1805 || $self->ut_flag('invoice_dest')
1808 foreach (qw(company ship_company)) {
1809 my $company = $self->get($_);
1810 $company =~ s/^\s+//;
1811 $company =~ s/\s+$//;
1812 $company =~ s/\s+/ /g;
1813 $self->set($_, $company);
1816 #barf. need message catalogs. i18n. etc.
1817 $error .= "Please select an advertising source."
1818 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1819 return $error if $error;
1821 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1822 or return "Unknown agent";
1824 if ( $self->currency ) {
1825 my $agent_currency = qsearchs( 'agent_currency', {
1826 'agentnum' => $agent->agentnum,
1827 'currency' => $self->currency,
1829 or return "Agent ". $agent->agent.
1830 " not permitted to offer ". $self->currency. " invoicing";
1833 return "Unknown refnum"
1834 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1836 return "Unknown referring custnum: ". $self->referral_custnum
1837 unless ! $self->referral_custnum
1838 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1840 if ( $self->ss eq '' ) {
1845 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1846 or return "Illegal social security number: ". $self->ss;
1847 $self->ss("$1-$2-$3");
1850 #turn off invoice_ship_address if ship & bill are the same
1851 if ($self->bill_locationnum eq $self->ship_locationnum) {
1852 $self->invoice_ship_address('');
1855 # cust_main_county verification now handled by cust_location check
1858 $self->ut_phonen('daytime', $self->country)
1859 || $self->ut_phonen('night', $self->country)
1860 || $self->ut_phonen('fax', $self->country)
1861 || $self->ut_phonen('mobile', $self->country)
1863 return $error if $error;
1865 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1867 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1870 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1872 : FS::Msgcat::_gettext('daytime');
1873 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1875 : FS::Msgcat::_gettext('night');
1877 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1879 : FS::Msgcat::_gettext('mobile');
1881 return "$daytime_label, $night_label or $mobile_label is required"
1885 ### start of stuff moved to cust_payby
1886 # then mostly kept here to support upgrades (can remove in 5.x)
1887 # but modified to allow everything to be empty
1889 if ( $self->payby ) {
1890 FS::payby->can_payby($self->table, $self->payby)
1891 or return "Illegal payby: ". $self->payby;
1896 $error = $self->ut_numbern('paystart_month')
1897 || $self->ut_numbern('paystart_year')
1898 || $self->ut_numbern('payissue')
1899 || $self->ut_textn('paytype')
1901 return $error if $error;
1903 if ( $self->payip eq '' ) {
1906 $error = $self->ut_ip('payip');
1907 return $error if $error;
1910 # If it is encrypted and the private key is not availaible then we can't
1911 # check the credit card.
1912 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1914 # Need some kind of global flag to accept invalid cards, for testing
1916 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1917 $self->payby =~ /^(CARD|DCRD)$/ ) {
1919 my $payinfo = $self->payinfo;
1920 $payinfo =~ s/\D//g;
1921 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1922 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1924 $self->payinfo($payinfo);
1926 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1928 return gettext('unknown_card_type')
1929 if $self->payinfo !~ /^99\d{14}$/ #token
1930 && cardtype($self->payinfo) eq "Unknown";
1932 unless ( $ignore_banned_card ) {
1933 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1935 if ( $ban->bantype eq 'warn' ) {
1936 #or others depending on value of $ban->reason ?
1937 return '_duplicate_card'.
1938 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1939 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1940 ' (ban# '. $ban->bannum. ')'
1941 unless $self->override_ban_warn;
1943 return 'Banned credit card: banned on '.
1944 time2str('%a %h %o at %r', $ban->_date).
1945 ' by '. $ban->otaker.
1946 ' (ban# '. $ban->bannum. ')';
1951 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1952 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1953 $self->paycvv =~ /^(\d{4})$/
1954 or return "CVV2 (CID) for American Express cards is four digits.";
1957 $self->paycvv =~ /^(\d{3})$/
1958 or return "CVV2 (CVC2/CID) is three digits.";
1965 my $cardtype = cardtype($payinfo);
1966 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1968 return "Start date or issue number is required for $cardtype cards"
1969 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1971 return "Start month must be between 1 and 12"
1972 if $self->paystart_month
1973 and $self->paystart_month < 1 || $self->paystart_month > 12;
1975 return "Start year must be 1990 or later"
1976 if $self->paystart_year
1977 and $self->paystart_year < 1990;
1979 return "Issue number must be beween 1 and 99"
1981 and $self->payissue < 1 || $self->payissue > 99;
1984 $self->paystart_month('');
1985 $self->paystart_year('');
1986 $self->payissue('');
1989 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1990 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1992 my $payinfo = $self->payinfo;
1993 $payinfo =~ s/[^\d\@\.]//g;
1994 if ( $conf->config('echeck-country') eq 'CA' ) {
1995 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1996 or return 'invalid echeck account@branch.bank';
1997 $payinfo = "$1\@$2.$3";
1998 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1999 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2000 $payinfo = "$1\@$2";
2002 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2003 $payinfo = "$1\@$2";
2005 $self->payinfo($payinfo);
2008 unless ( $ignore_banned_card ) {
2009 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2011 if ( $ban->bantype eq 'warn' ) {
2012 #or others depending on value of $ban->reason ?
2013 return '_duplicate_ach' unless $self->override_ban_warn;
2015 return 'Banned ACH account: banned on '.
2016 time2str('%a %h %o at %r', $ban->_date).
2017 ' by '. $ban->otaker.
2018 ' (ban# '. $ban->bannum. ')';
2023 } elsif ( $self->payby eq 'LECB' ) {
2025 my $payinfo = $self->payinfo;
2026 $payinfo =~ s/\D//g;
2027 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2029 $self->payinfo($payinfo);
2032 } elsif ( $self->payby eq 'BILL' ) {
2034 $error = $self->ut_textn('payinfo');
2035 return "Illegal P.O. number: ". $self->payinfo if $error;
2038 } elsif ( $self->payby eq 'COMP' ) {
2040 my $curuser = $FS::CurrentUser::CurrentUser;
2041 if ( ! $self->custnum
2042 && ! $curuser->access_right('Complimentary customer')
2045 return "You are not permitted to create complimentary accounts."
2048 $error = $self->ut_textn('payinfo');
2049 return "Illegal comp account issuer: ". $self->payinfo if $error;
2052 } elsif ( $self->payby eq 'PREPAY' ) {
2054 my $payinfo = $self->payinfo;
2055 $payinfo =~ s/\W//g; #anything else would just confuse things
2056 $self->payinfo($payinfo);
2057 $error = $self->ut_alpha('payinfo');
2058 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2059 return "Unknown prepayment identifier"
2060 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2065 return "You are not permitted to create complimentary accounts."
2067 && $self->complimentary eq 'Y'
2068 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2070 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2071 return "Expiration date required"
2072 # shouldn't payinfo_check do this?
2073 unless ! $self->payby
2074 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2078 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2079 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2080 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2081 ( $m, $y ) = ( $2, "19$1" );
2082 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2083 ( $m, $y ) = ( $3, "20$2" );
2085 return "Illegal expiration date: ". $self->paydate;
2087 $m = sprintf('%02d',$m);
2088 $self->paydate("$y-$m-01");
2089 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2090 return gettext('expired_card')
2092 && !$ignore_expired_card
2093 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2096 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2097 ( ! $conf->exists('require_cardname')
2098 || $self->payby !~ /^(CARD|DCRD)$/ )
2100 $self->payname( $self->first. " ". $self->getfield('last') );
2103 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2104 $self->payname =~ /^([\w \,\.\-\']*)$/
2105 or return gettext('illegal_name'). " payname: ". $self->payname;
2108 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2109 or return gettext('illegal_name'). " payname: ". $self->payname;
2115 ### end of stuff moved to cust_payby
2117 return "Please select an invoicing locale"
2120 && $conf->exists('cust_main-require_locale');
2122 return "Please select a customer class"
2123 if ! $self->classnum
2124 && $conf->exists('cust_main-require_classnum');
2126 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2127 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2131 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2133 warn "$me check AFTER: \n". $self->_dump
2136 $self->SUPER::check;
2139 sub check_payinfo_cardtype {
2142 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2144 my $payinfo = $self->payinfo;
2145 $payinfo =~ s/\D//g;
2147 return '' if $self->tokenized($payinfo); #token
2149 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2150 my $cardtype = cardtype($payinfo);
2152 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2160 Additional checks for replace only.
2165 my ($new,$old) = @_;
2166 #preserve old value if global config is set
2167 if ($old && $conf->exists('invoice-ship_address')) {
2168 $new->invoice_ship_address($old->invoice_ship_address);
2175 Returns a list of fields which have ship_ duplicates.
2180 qw( last first company
2182 address1 address2 city county state zip country
2184 daytime night fax mobile
2188 =item has_ship_address
2190 Returns true if this customer record has a separate shipping address.
2194 sub has_ship_address {
2196 $self->bill_locationnum != $self->ship_locationnum;
2201 Returns a list of key/value pairs, with the following keys: address1,
2202 adddress2, city, county, state, zip, country, district, and geocode. The
2203 shipping address is used if present.
2209 $self->ship_location->location_hash;
2214 Returns all locations (see L<FS::cust_location>) for this customer.
2221 'table' => 'cust_location',
2222 'hashref' => { 'custnum' => $self->custnum,
2223 'prospectnum' => '',
2225 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2231 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2237 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2240 =item cust_payby PAYBY
2242 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2244 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2245 Does not validate PAYBY.
2253 'table' => 'cust_payby',
2254 'hashref' => { 'custnum' => $self->custnum },
2255 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2257 $search->{'extra_sql'} = ' AND payby IN ( '.
2258 join(',', map dbh->quote($_), @payby).
2265 =item has_cust_payby_auto
2267 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2271 sub has_cust_payby_auto {
2274 'table' => 'cust_payby',
2275 'hashref' => { 'custnum' => $self->custnum, },
2276 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2277 'order_by' => 'LIMIT 1',
2284 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2285 and L<FS::cust_pkg>) for this customer, except those on hold.
2287 Returns a list: an empty list on success or a list of errors.
2293 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2298 Unsuspends all suspended packages in the on-hold state (those without setup
2299 dates) for this customer.
2305 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2310 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2312 Returns a list: an empty list on success or a list of errors.
2318 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2321 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2323 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2324 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2325 of a list of pkgparts; the hashref has the following keys:
2329 =item pkgparts - listref of pkgparts
2331 =item (other options are passed to the suspend method)
2336 Returns a list: an empty list on success or a list of errors.
2340 sub suspend_if_pkgpart {
2342 my (@pkgparts, %opt);
2343 if (ref($_[0]) eq 'HASH'){
2344 @pkgparts = @{$_[0]{pkgparts}};
2349 grep { $_->suspend(%opt) }
2350 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2351 $self->unsuspended_pkgs;
2354 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2356 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2357 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2358 instead of a list of pkgparts; the hashref has the following keys:
2362 =item pkgparts - listref of pkgparts
2364 =item (other options are passed to the suspend method)
2368 Returns a list: an empty list on success or a list of errors.
2372 sub suspend_unless_pkgpart {
2374 my (@pkgparts, %opt);
2375 if (ref($_[0]) eq 'HASH'){
2376 @pkgparts = @{$_[0]{pkgparts}};
2381 grep { $_->suspend(%opt) }
2382 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2383 $self->unsuspended_pkgs;
2386 =item cancel [ OPTION => VALUE ... ]
2388 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2389 The cancellation time will be now.
2393 Always returns a list: an empty list on success or a list of errors.
2400 warn "$me cancel called on customer ". $self->custnum. " with options ".
2401 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2403 my @pkgs = $self->ncancelled_pkgs;
2405 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2408 =item cancel_pkgs OPTIONS
2410 Cancels a specified list of packages. OPTIONS can include:
2414 =item cust_pkg - an arrayref of the packages. Required.
2416 =item time - the cancellation time, used to calculate final bills and
2417 unused-time credits if any. Will be passed through to the bill() and
2418 FS::cust_pkg::cancel() methods.
2420 =item quiet - can be set true to supress email cancellation notices.
2422 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2423 reasonnum of an existing reason, or passing a hashref will create a new reason.
2424 The hashref should have the following keys:
2425 typenum - Reason type (see L<FS::reason_type>)
2426 reason - Text of the new reason.
2428 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2429 for the individual packages, parallel to the C<cust_pkg> argument. The
2430 reason and reason_otaker arguments will be taken from those objects.
2432 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2434 =item nobill - can be set true to skip billing if it might otherwise be done.
2439 my( $self, %opt ) = @_;
2441 # we're going to cancel services, which is not reversible
2442 die "cancel_pkgs cannot be run inside a transaction"
2443 if $FS::UID::AutoCommit == 0;
2445 local $FS::UID::AutoCommit = 0;
2447 return ( 'access denied' )
2448 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2450 if ( $opt{'ban'} ) {
2452 foreach my $cust_payby ( $self->cust_payby ) {
2454 #well, if they didn't get decrypted on search, then we don't have to
2455 # try again... queue a job for the server that does have decryption
2456 # capability if we're in a paranoid multi-server implementation?
2457 return ( "Can't (yet) ban encrypted credit cards" )
2458 if $cust_payby->is_encrypted($cust_payby->payinfo);
2460 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2461 my $error = $ban->insert;
2471 my @pkgs = @{ delete $opt{'cust_pkg'} };
2472 my $cancel_time = $opt{'time'} || time;
2474 # bill all packages first, so we don't lose usage, service counts for
2475 # bulk billing, etc.
2476 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2478 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2480 'time' => $cancel_time );
2482 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2484 return ( "Error billing during cancellation: $error" );
2489 $FS::UID::AutoCommit = 1;
2491 # now cancel all services, the same way we would for individual packages.
2492 # if any of them fail, cancel the rest anyway.
2493 my @cust_svc = map { $_->cust_svc } @pkgs;
2494 my @sorted_cust_svc =
2496 sort { $a->[1] <=> $b->[1] }
2497 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2499 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2502 foreach my $cust_svc (@sorted_cust_svc) {
2503 my $part_svc = $cust_svc->part_svc;
2504 next if ( defined($part_svc) and $part_svc->preserve );
2505 my $error = $cust_svc->cancel; # immediate cancel, no date option
2506 push @errors, $error if $error;
2512 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2513 $self->custnum. "\n"
2517 if ($opt{'cust_pkg_reason'}) {
2518 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2524 my $cpr = shift @cprs;
2526 $lopt{'reason'} = $cpr->reasonnum;
2527 $lopt{'reason_otaker'} = $cpr->otaker;
2529 warn "no reason found when canceling package ".$_->pkgnum."\n";
2530 # we're not actually required to pass a reason to cust_pkg::cancel,
2531 # but if we're getting to this point, something has gone awry.
2532 $null_reason ||= FS::reason->new_or_existing(
2533 reason => 'unknown reason',
2534 type => 'Cancel Reason',
2537 $lopt{'reason'} = $null_reason->reasonnum;
2538 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2541 my $error = $_->cancel(%lopt);
2542 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2548 sub _banned_pay_hashref {
2559 'payby' => $payby2ban{$self->payby},
2560 'payinfo' => $self->payinfo,
2561 #don't ever *search* on reason! #'reason' =>
2567 Returns all notes (see L<FS::cust_main_note>) for this customer.
2572 my($self,$orderby_classnum) = (shift,shift);
2573 my $orderby = "sticky DESC, _date DESC";
2574 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2575 qsearch( 'cust_main_note',
2576 { 'custnum' => $self->custnum },
2578 "ORDER BY $orderby",
2584 Returns the agent (see L<FS::agent>) for this customer.
2588 Returns the agent name (see L<FS::agent>) for this customer.
2594 $self->agent->agent;
2599 Returns any tags associated with this customer, as FS::cust_tag objects,
2600 or an empty list if there are no tags.
2604 Returns any tags associated with this customer, as FS::part_tag objects,
2605 or an empty list if there are no tags.
2611 map $_->part_tag, $self->cust_tag;
2617 Returns the customer class, as an FS::cust_class object, or the empty string
2618 if there is no customer class.
2622 Returns the customer category name, or the empty string if there is no customer
2629 my $cust_class = $self->cust_class;
2631 ? $cust_class->categoryname
2637 Returns the customer class name, or the empty string if there is no customer
2644 my $cust_class = $self->cust_class;
2646 ? $cust_class->classname
2652 Returns the external tax status, as an FS::tax_status object, or the empty
2653 string if there is no tax status.
2659 if ( $self->taxstatusnum ) {
2660 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2668 Returns the tax status code if there is one.
2674 my $tax_status = $self->tax_status;
2676 ? $tax_status->taxstatus
2680 =item BILLING METHODS
2682 Documentation on billing methods has been moved to
2683 L<FS::cust_main::Billing>.
2685 =item REALTIME BILLING METHODS
2687 Documentation on realtime billing methods has been moved to
2688 L<FS::cust_main::Billing_Realtime>.
2692 Removes the I<paycvv> field from the database directly.
2694 If there is an error, returns the error, otherwise returns false.
2696 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2702 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2703 or return dbh->errstr;
2704 $sth->execute($self->custnum)
2705 or return $sth->errstr;
2712 Returns the total owed for this customer on all invoices
2713 (see L<FS::cust_bill/owed>).
2719 $self->total_owed_date(2145859200); #12/31/2037
2722 =item total_owed_date TIME
2724 Returns the total owed for this customer on all invoices with date earlier than
2725 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2726 see L<Time::Local> and L<Date::Parse> for conversion functions.
2730 sub total_owed_date {
2734 my $custnum = $self->custnum;
2736 my $owed_sql = FS::cust_bill->owed_sql;
2739 SELECT SUM($owed_sql) FROM cust_bill
2740 WHERE custnum = $custnum
2744 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2748 =item total_owed_pkgnum PKGNUM
2750 Returns the total owed on all invoices for this customer's specific package
2751 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2755 sub total_owed_pkgnum {
2756 my( $self, $pkgnum ) = @_;
2757 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2760 =item total_owed_date_pkgnum TIME PKGNUM
2762 Returns the total owed for this customer's specific package when using
2763 experimental package balances on all invoices with date earlier than
2764 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2765 see L<Time::Local> and L<Date::Parse> for conversion functions.
2769 sub total_owed_date_pkgnum {
2770 my( $self, $time, $pkgnum ) = @_;
2773 foreach my $cust_bill (
2774 grep { $_->_date <= $time }
2775 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2777 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2779 sprintf( "%.2f", $total_bill );
2785 Returns the total amount of all payments.
2792 $total += $_->paid foreach $self->cust_pay;
2793 sprintf( "%.2f", $total );
2796 =item total_unapplied_credits
2798 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2799 customer. See L<FS::cust_credit/credited>.
2801 =item total_credited
2803 Old name for total_unapplied_credits. Don't use.
2807 sub total_credited {
2808 #carp "total_credited deprecated, use total_unapplied_credits";
2809 shift->total_unapplied_credits(@_);
2812 sub total_unapplied_credits {
2815 my $custnum = $self->custnum;
2817 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2820 SELECT SUM($unapplied_sql) FROM cust_credit
2821 WHERE custnum = $custnum
2824 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2828 =item total_unapplied_credits_pkgnum PKGNUM
2830 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2831 customer. See L<FS::cust_credit/credited>.
2835 sub total_unapplied_credits_pkgnum {
2836 my( $self, $pkgnum ) = @_;
2837 my $total_credit = 0;
2838 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2839 sprintf( "%.2f", $total_credit );
2843 =item total_unapplied_payments
2845 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2846 See L<FS::cust_pay/unapplied>.
2850 sub total_unapplied_payments {
2853 my $custnum = $self->custnum;
2855 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2858 SELECT SUM($unapplied_sql) FROM cust_pay
2859 WHERE custnum = $custnum
2862 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2866 =item total_unapplied_payments_pkgnum PKGNUM
2868 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2869 specific package when using experimental package balances. See
2870 L<FS::cust_pay/unapplied>.
2874 sub total_unapplied_payments_pkgnum {
2875 my( $self, $pkgnum ) = @_;
2876 my $total_unapplied = 0;
2877 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2878 sprintf( "%.2f", $total_unapplied );
2882 =item total_unapplied_refunds
2884 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2885 customer. See L<FS::cust_refund/unapplied>.
2889 sub total_unapplied_refunds {
2891 my $custnum = $self->custnum;
2893 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2896 SELECT SUM($unapplied_sql) FROM cust_refund
2897 WHERE custnum = $custnum
2900 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2906 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2907 total_unapplied_credits minus total_unapplied_payments).
2913 $self->balance_date_range;
2916 =item balance_date TIME
2918 Returns the balance for this customer, only considering invoices with date
2919 earlier than TIME (total_owed_date minus total_credited minus
2920 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2921 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2928 $self->balance_date_range(shift);
2931 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2933 Returns the balance for this customer, optionally considering invoices with
2934 date earlier than START_TIME, and not later than END_TIME
2935 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2937 Times are specified as SQL fragments or numeric
2938 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2939 L<Date::Parse> for conversion functions. The empty string can be passed
2940 to disable that time constraint completely.
2942 Accepts the same options as L<balance_date_sql>:
2946 =item unapplied_date
2948 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)
2952 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2953 time will be ignored. Note that START_TIME and END_TIME only limit the date
2954 range for invoices and I<unapplied> payments, credits, and refunds.
2960 sub balance_date_range {
2962 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2963 ') FROM cust_main WHERE custnum='. $self->custnum;
2964 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2967 =item balance_pkgnum PKGNUM
2969 Returns the balance for this customer's specific package when using
2970 experimental package balances (total_owed plus total_unrefunded, minus
2971 total_unapplied_credits minus total_unapplied_payments)
2975 sub balance_pkgnum {
2976 my( $self, $pkgnum ) = @_;
2979 $self->total_owed_pkgnum($pkgnum)
2980 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2981 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2982 - $self->total_unapplied_credits_pkgnum($pkgnum)
2983 - $self->total_unapplied_payments_pkgnum($pkgnum)
2989 Returns a hash of useful information for making a payment.
2999 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3000 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3001 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3005 For credit card transactions:
3017 For electronic check transactions:
3032 $return{balance} = $self->balance;
3034 $return{payname} = $self->payname
3035 || ( $self->first. ' '. $self->get('last') );
3037 $return{$_} = $self->bill_location->$_
3038 for qw(address1 address2 city state zip);
3040 $return{payby} = $self->payby;
3041 $return{stateid_state} = $self->stateid_state;
3043 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3044 $return{card_type} = cardtype($self->payinfo);
3045 $return{payinfo} = $self->paymask;
3047 @return{'month', 'year'} = $self->paydate_monthyear;
3051 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3052 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3053 $return{payinfo1} = $payinfo1;
3054 $return{payinfo2} = $payinfo2;
3055 $return{paytype} = $self->paytype;
3056 $return{paystate} = $self->paystate;
3060 #doubleclick protection
3062 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3070 Returns the next payment expiration date for this customer. If they have no
3071 payment methods that will expire, returns 0.
3077 # filter out the ones that individually return 0, but then return 0 if
3078 # there are no results
3079 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3080 min( @epochs ) || 0;
3083 =item paydate_epoch_sql
3085 Returns an SQL expression to get the next payment expiration date for a
3086 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3087 dates, so that it's safe to test for "will it expire before date X" for any
3092 sub paydate_epoch_sql {
3094 my $paydate = FS::cust_payby->paydate_epoch_sql;
3095 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3099 my( $self, $taxname ) = @_;
3101 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3102 'taxname' => $taxname,
3107 =item cust_main_exemption
3109 =item invoicing_list
3111 Returns a list of email addresses (with svcnum entries expanded), and the word
3112 'POST' if the customer receives postal invoices.
3116 sub invoicing_list {
3117 my( $self, $arrayref ) = @_;
3120 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3123 my @emails = $self->invoicing_list_emailonly;
3124 push @emails, 'POST' if $self->get('postal_invoice');
3129 =item check_invoicing_list ARRAYREF
3131 Checks these arguements as valid input for the invoicing_list method. If there
3132 is an error, returns the error, otherwise returns false.
3136 sub check_invoicing_list {
3137 my( $self, $arrayref ) = @_;
3139 foreach my $address ( @$arrayref ) {
3141 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3142 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3145 my $cust_main_invoice = new FS::cust_main_invoice ( {
3146 'custnum' => $self->custnum,
3149 my $error = $self->custnum
3150 ? $cust_main_invoice->check
3151 : $cust_main_invoice->checkdest
3153 return $error if $error;
3157 return "Email address required"
3158 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3159 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3166 Returns the email addresses of all accounts provisioned for this customer.
3173 foreach my $cust_pkg ( $self->all_pkgs ) {
3174 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3176 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3177 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3179 $list{$_}=1 foreach map { $_->email } @svc_acct;
3184 =item invoicing_list_addpost
3186 Adds postal invoicing to this customer. If this customer is already configured
3187 to receive postal invoices, does nothing.
3191 sub invoicing_list_addpost {
3193 if ( $self->get('postal_invoice') eq '' ) {
3194 $self->set('postal_invoice', 'Y');
3195 my $error = $self->replace;
3196 warn $error if $error; # should fail harder, but this is traditional
3200 =item invoicing_list_emailonly
3202 Returns the list of email invoice recipients (invoicing_list without non-email
3203 destinations such as POST and FAX).
3207 sub invoicing_list_emailonly {
3209 warn "$me invoicing_list_emailonly called"
3211 return () if !$self->custnum; # not yet inserted
3212 return map { $_->emailaddress }
3214 table => 'cust_contact',
3215 select => 'emailaddress',
3216 addl_from => ' JOIN contact USING (contactnum) '.
3217 ' JOIN contact_email USING (contactnum)',
3218 hashref => { 'custnum' => $self->custnum, },
3219 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3223 =item invoicing_list_emailonly_scalar
3225 Returns the list of email invoice recipients (invoicing_list without non-email
3226 destinations such as POST and FAX) as a comma-separated scalar.
3230 sub invoicing_list_emailonly_scalar {
3232 warn "$me invoicing_list_emailonly_scalar called"
3234 join(', ', $self->invoicing_list_emailonly);
3237 =item contact_list [ CLASSNUM, ... ]
3239 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3240 a list of contact classnums is given, returns only contacts in those
3241 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3242 are marked as invoice destinations. If '0' is given, also returns contacts
3245 If no arguments are given, returns all contacts for the customer.
3253 select => 'contact.*, cust_contact.invoice_dest',
3254 addl_from => ' JOIN cust_contact USING (contactnum)',
3255 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3261 if ( $_ eq 'invoice' ) {
3262 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3263 } elsif ( $_ eq '0' ) {
3264 push @orwhere, 'cust_contact.classnum is null';
3265 } elsif ( /^\d+$/ ) {
3266 push @classnums, $_;
3268 die "bad classnum argument '$_'";
3273 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3276 $search->{extra_sql} .= ' AND (' .
3277 join(' OR ', map "( $_ )", @orwhere) .
3284 =item contact_list_email [ CLASSNUM, ... ]
3286 Same as L</contact_list>, but returns email destinations instead of contact
3291 sub contact_list_email {
3293 my @contacts = $self->contact_list(@_);
3295 foreach my $contact (@contacts) {
3296 foreach my $contact_email ($contact->contact_email) {
3297 push @emails, Email::Address->new( $contact->firstlast,
3298 $contact_email->emailaddress
3305 =item referral_custnum_cust_main
3307 Returns the customer who referred this customer (or the empty string, if
3308 this customer was not referred).
3310 Note the difference with referral_cust_main method: This method,
3311 referral_custnum_cust_main returns the single customer (if any) who referred
3312 this customer, while referral_cust_main returns an array of customers referred
3317 sub referral_custnum_cust_main {
3319 return '' unless $self->referral_custnum;
3320 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3323 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3325 Returns an array of customers referred by this customer (referral_custnum set
3326 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3327 customers referred by customers referred by this customer and so on, inclusive.
3328 The default behavior is DEPTH 1 (no recursion).
3330 Note the difference with referral_custnum_cust_main method: This method,
3331 referral_cust_main, returns an array of customers referred BY this customer,
3332 while referral_custnum_cust_main returns the single customer (if any) who
3333 referred this customer.
3337 sub referral_cust_main {
3339 my $depth = @_ ? shift : 1;
3340 my $exclude = @_ ? shift : {};
3343 map { $exclude->{$_->custnum}++; $_; }
3344 grep { ! $exclude->{ $_->custnum } }
3345 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3349 map { $_->referral_cust_main($depth-1, $exclude) }
3356 =item referral_cust_main_ncancelled
3358 Same as referral_cust_main, except only returns customers with uncancelled
3363 sub referral_cust_main_ncancelled {
3365 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3368 =item referral_cust_pkg [ DEPTH ]
3370 Like referral_cust_main, except returns a flat list of all unsuspended (and
3371 uncancelled) packages for each customer. The number of items in this list may
3372 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3376 sub referral_cust_pkg {
3378 my $depth = @_ ? shift : 1;
3380 map { $_->unsuspended_pkgs }
3381 grep { $_->unsuspended_pkgs }
3382 $self->referral_cust_main($depth);
3385 =item referring_cust_main
3387 Returns the single cust_main record for the customer who referred this customer
3388 (referral_custnum), or false.
3392 sub referring_cust_main {
3394 return '' unless $self->referral_custnum;
3395 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3398 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3400 Applies a credit to this customer. If there is an error, returns the error,
3401 otherwise returns false.
3403 REASON can be a text string, an FS::reason object, or a scalar reference to
3404 a reasonnum. If a text string, it will be automatically inserted as a new
3405 reason, and a 'reason_type' option must be passed to indicate the
3406 FS::reason_type for the new reason.
3408 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3409 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3410 I<commission_pkgnum>.
3412 Any other options are passed to FS::cust_credit::insert.
3417 my( $self, $amount, $reason, %options ) = @_;
3419 my $cust_credit = new FS::cust_credit {
3420 'custnum' => $self->custnum,
3421 'amount' => $amount,
3424 if ( ref($reason) ) {
3426 if ( ref($reason) eq 'SCALAR' ) {
3427 $cust_credit->reasonnum( $$reason );
3429 $cust_credit->reasonnum( $reason->reasonnum );
3433 $cust_credit->set('reason', $reason)
3436 $cust_credit->$_( delete $options{$_} )
3437 foreach grep exists($options{$_}),
3438 qw( addlinfo eventnum ),
3439 map "commission_$_", qw( agentnum salesnum pkgnum );
3441 $cust_credit->insert(%options);
3445 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3447 Creates a one-time charge for this customer. If there is an error, returns
3448 the error, otherwise returns false.
3450 New-style, with a hashref of options:
3452 my $error = $cust_main->charge(
3456 'start_date' => str2time('7/4/2009'),
3457 'pkg' => 'Description',
3458 'comment' => 'Comment',
3459 'additional' => [], #extra invoice detail
3460 'classnum' => 1, #pkg_class
3462 'setuptax' => '', # or 'Y' for tax exempt
3464 'locationnum'=> 1234, # optional
3467 'taxclass' => 'Tax class',
3470 'taxproduct' => 2, #part_pkg_taxproduct
3471 'override' => {}, #XXX describe
3473 #will be filled in with the new object
3474 'cust_pkg_ref' => \$cust_pkg,
3476 #generate an invoice immediately
3478 'invoice_terms' => '', #with these terms
3484 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3488 #super false laziness w/quotation::charge
3491 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3492 my ( $pkg, $comment, $additional );
3493 my ( $setuptax, $taxclass ); #internal taxes
3494 my ( $taxproduct, $override ); #vendor (CCH) taxes
3496 my $separate_bill = '';
3497 my $cust_pkg_ref = '';
3498 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3500 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3501 if ( ref( $_[0] ) ) {
3502 $amount = $_[0]->{amount};
3503 $setup_cost = $_[0]->{setup_cost};
3504 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3505 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3506 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3507 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3508 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3509 : '$'. sprintf("%.2f",$amount);
3510 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3511 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3512 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3513 $additional = $_[0]->{additional} || [];
3514 $taxproduct = $_[0]->{taxproductnum};
3515 $override = { '' => $_[0]->{tax_override} };
3516 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3517 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3518 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3519 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3520 $separate_bill = $_[0]->{separate_bill} || '';
3521 $discountnum = $_[0]->{setup_discountnum};
3522 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3523 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3529 $pkg = @_ ? shift : 'One-time charge';
3530 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3532 $taxclass = @_ ? shift : '';
3536 local $SIG{HUP} = 'IGNORE';
3537 local $SIG{INT} = 'IGNORE';
3538 local $SIG{QUIT} = 'IGNORE';
3539 local $SIG{TERM} = 'IGNORE';
3540 local $SIG{TSTP} = 'IGNORE';
3541 local $SIG{PIPE} = 'IGNORE';
3543 my $oldAutoCommit = $FS::UID::AutoCommit;
3544 local $FS::UID::AutoCommit = 0;
3547 my $part_pkg = new FS::part_pkg ( {
3549 'comment' => $comment,
3553 'classnum' => ( $classnum ? $classnum : '' ),
3554 'setuptax' => $setuptax,
3555 'taxclass' => $taxclass,
3556 'taxproductnum' => $taxproduct,
3557 'setup_cost' => $setup_cost,
3560 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3561 ( 0 .. @$additional - 1 )
3563 'additional_count' => scalar(@$additional),
3564 'setup_fee' => $amount,
3567 my $error = $part_pkg->insert( options => \%options,
3568 tax_overrides => $override,
3571 $dbh->rollback if $oldAutoCommit;
3575 my $pkgpart = $part_pkg->pkgpart;
3576 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3577 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3578 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3579 $error = $type_pkgs->insert;
3581 $dbh->rollback if $oldAutoCommit;
3586 my $cust_pkg = new FS::cust_pkg ( {
3587 'custnum' => $self->custnum,
3588 'pkgpart' => $pkgpart,
3589 'quantity' => $quantity,
3590 'start_date' => $start_date,
3591 'no_auto' => $no_auto,
3592 'separate_bill' => $separate_bill,
3593 'locationnum' => $locationnum,
3594 'setup_discountnum' => $discountnum,
3595 'setup_discountnum_amount' => $discountnum_amount,
3596 'setup_discountnum_percent' => $discountnum_percent,
3599 $error = $cust_pkg->insert;
3601 $dbh->rollback if $oldAutoCommit;
3603 } elsif ( $cust_pkg_ref ) {
3604 ${$cust_pkg_ref} = $cust_pkg;
3608 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3609 'pkg_list' => [ $cust_pkg ],
3612 $dbh->rollback if $oldAutoCommit;
3617 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3622 #=item charge_postal_fee
3624 #Applies a one time charge this customer. If there is an error,
3625 #returns the error, returns the cust_pkg charge object or false
3626 #if there was no charge.
3630 # This should be a customer event. For that to work requires that bill
3631 # also be a customer event.
3633 sub charge_postal_fee {
3636 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3637 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3639 my $cust_pkg = new FS::cust_pkg ( {
3640 'custnum' => $self->custnum,
3641 'pkgpart' => $pkgpart,
3645 my $error = $cust_pkg->insert;
3646 $error ? $error : $cust_pkg;
3649 =item num_cust_attachment_deleted
3651 Returns the number of deleted attachments for this customer (see
3652 L<FS::num_cust_attachment>).
3656 sub num_cust_attachments_deleted {
3659 " SELECT COUNT(*) FROM cust_attachment ".
3660 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3667 Returns the most recent invnum (invoice number) for this customer.
3674 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3679 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3681 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3683 Optionally, a list or hashref of additional arguments to the qsearch call can
3690 my $opt = ref($_[0]) ? shift : { @_ };
3692 #return $self->num_cust_bill unless wantarray || keys %$opt;
3694 $opt->{'table'} = 'cust_bill';
3695 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3696 $opt->{'hashref'}{'custnum'} = $self->custnum;
3697 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3699 map { $_ } #behavior of sort undefined in scalar context
3700 sort { $a->_date <=> $b->_date }
3704 =item open_cust_bill
3706 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3711 sub open_cust_bill {
3715 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3721 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3723 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3727 sub legacy_cust_bill {
3730 #return $self->num_legacy_cust_bill unless wantarray;
3732 map { $_ } #behavior of sort undefined in scalar context
3733 sort { $a->_date <=> $b->_date }
3734 qsearch({ 'table' => 'legacy_cust_bill',
3735 'hashref' => { 'custnum' => $self->custnum, },
3736 'order_by' => 'ORDER BY _date ASC',
3740 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3742 Returns all the statements (see L<FS::cust_statement>) for this customer.
3744 Optionally, a list or hashref of additional arguments to the qsearch call can
3749 =item cust_bill_void
3751 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3755 sub cust_bill_void {
3758 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3759 sort { $a->_date <=> $b->_date }
3760 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3763 sub cust_statement {
3765 my $opt = ref($_[0]) ? shift : { @_ };
3767 #return $self->num_cust_statement unless wantarray || keys %$opt;
3769 $opt->{'table'} = 'cust_statement';
3770 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3771 $opt->{'hashref'}{'custnum'} = $self->custnum;
3772 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3774 map { $_ } #behavior of sort undefined in scalar context
3775 sort { $a->_date <=> $b->_date }
3779 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3781 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3783 Optionally, a list or hashref of additional arguments to the qsearch call can
3784 be passed following the SVCDB.
3791 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3792 warn "$me svc_x requires a svcdb";
3795 my $opt = ref($_[0]) ? shift : { @_ };
3797 $opt->{'table'} = $svcdb;
3798 $opt->{'addl_from'} =
3799 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3800 ($opt->{'addl_from'} || '');
3802 my $custnum = $self->custnum;
3803 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3804 my $where = "cust_pkg.custnum = $custnum";
3806 my $extra_sql = $opt->{'extra_sql'} || '';
3807 if ( keys %{ $opt->{'hashref'} } ) {
3808 $extra_sql = " AND $where $extra_sql";
3811 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3812 $extra_sql = "WHERE $where AND $1";
3815 $extra_sql = "WHERE $where $extra_sql";
3818 $opt->{'extra_sql'} = $extra_sql;
3823 # required for use as an eventtable;
3826 $self->svc_x('svc_acct', @_);
3831 Returns all the credits (see L<FS::cust_credit>) for this customer.
3838 #return $self->num_cust_credit unless wantarray;
3840 map { $_ } #behavior of sort undefined in scalar context
3841 sort { $a->_date <=> $b->_date }
3842 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3845 =item cust_credit_pkgnum
3847 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3848 package when using experimental package balances.
3852 sub cust_credit_pkgnum {
3853 my( $self, $pkgnum ) = @_;
3854 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3855 sort { $a->_date <=> $b->_date }
3856 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3857 'pkgnum' => $pkgnum,
3862 =item cust_credit_void
3864 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3868 sub cust_credit_void {
3871 sort { $a->_date <=> $b->_date }
3872 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3877 Returns all the payments (see L<FS::cust_pay>) for this customer.
3883 my $opt = ref($_[0]) ? shift : { @_ };
3885 return $self->num_cust_pay unless wantarray || keys %$opt;
3887 $opt->{'table'} = 'cust_pay';
3888 $opt->{'hashref'}{'custnum'} = $self->custnum;
3890 map { $_ } #behavior of sort undefined in scalar context
3891 sort { $a->_date <=> $b->_date }
3898 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3899 called automatically when the cust_pay method is used in a scalar context.
3905 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3906 my $sth = dbh->prepare($sql) or die dbh->errstr;
3907 $sth->execute($self->custnum) or die $sth->errstr;
3908 $sth->fetchrow_arrayref->[0];
3911 =item unapplied_cust_pay
3913 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3917 sub unapplied_cust_pay {
3921 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3927 =item cust_pay_pkgnum
3929 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3930 package when using experimental package balances.
3934 sub cust_pay_pkgnum {
3935 my( $self, $pkgnum ) = @_;
3936 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3937 sort { $a->_date <=> $b->_date }
3938 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3939 'pkgnum' => $pkgnum,
3946 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3952 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3953 sort { $a->_date <=> $b->_date }
3954 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3957 =item cust_pay_pending
3959 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3960 (without status "done").
3964 sub cust_pay_pending {
3966 return $self->num_cust_pay_pending unless wantarray;
3967 sort { $a->_date <=> $b->_date }
3968 qsearch( 'cust_pay_pending', {
3969 'custnum' => $self->custnum,
3970 'status' => { op=>'!=', value=>'done' },
3975 =item cust_pay_pending_attempt
3977 Returns all payment attempts / declined payments for this customer, as pending
3978 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3979 a corresponding payment (see L<FS::cust_pay>).
3983 sub cust_pay_pending_attempt {
3985 return $self->num_cust_pay_pending_attempt unless wantarray;
3986 sort { $a->_date <=> $b->_date }
3987 qsearch( 'cust_pay_pending', {
3988 'custnum' => $self->custnum,
3995 =item num_cust_pay_pending
3997 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3998 customer (without status "done"). Also called automatically when the
3999 cust_pay_pending method is used in a scalar context.
4003 sub num_cust_pay_pending {
4006 " SELECT COUNT(*) FROM cust_pay_pending ".
4007 " WHERE custnum = ? AND status != 'done' ",
4012 =item num_cust_pay_pending_attempt
4014 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4015 customer, with status "done" but without a corresp. Also called automatically when the
4016 cust_pay_pending method is used in a scalar context.
4020 sub num_cust_pay_pending_attempt {
4023 " SELECT COUNT(*) FROM cust_pay_pending ".
4024 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4031 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4037 map { $_ } #return $self->num_cust_refund unless wantarray;
4038 sort { $a->_date <=> $b->_date }
4039 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4042 =item display_custnum
4044 Returns the displayed customer number for this customer: agent_custid if
4045 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4049 sub display_custnum {
4052 return $self->agent_custid
4053 if $default_agent_custid && $self->agent_custid;
4055 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4059 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4060 } elsif ( $custnum_display_length ) {
4061 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4063 return $self->custnum;
4069 Returns a name string for this customer, either "Company (Last, First)" or
4076 my $name = $self->contact;
4077 $name = $self->company. " ($name)" if $self->company;
4081 =item service_contact
4083 Returns the L<FS::contact> object for this customer that has the 'Service'
4084 contact class, or undef if there is no such contact. Deprecated; don't use
4089 sub service_contact {
4091 if ( !exists($self->{service_contact}) ) {
4092 my $classnum = $self->scalar_sql(
4093 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4094 ) || 0; #if it's zero, qsearchs will return nothing
4095 my $cust_contact = qsearchs('cust_contact', {
4096 'classnum' => $classnum,
4097 'custnum' => $self->custnum,
4099 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4101 $self->{service_contact};
4106 Returns a name string for this (service/shipping) contact, either
4107 "Company (Last, First)" or "Last, First".
4114 my $name = $self->ship_contact;
4115 $name = $self->company. " ($name)" if $self->company;
4121 Returns a name string for this customer, either "Company" or "First Last".
4127 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4130 =item ship_name_short
4132 Returns a name string for this (service/shipping) contact, either "Company"
4137 sub ship_name_short {
4139 $self->service_contact
4140 ? $self->ship_contact_firstlast
4146 Returns this customer's full (billing) contact name only, "Last, First"
4152 $self->get('last'). ', '. $self->first;
4157 Returns this customer's full (shipping) contact name only, "Last, First"
4163 my $contact = $self->service_contact || $self;
4164 $contact->get('last') . ', ' . $contact->get('first');
4167 =item contact_firstlast
4169 Returns this customers full (billing) contact name only, "First Last".
4173 sub contact_firstlast {
4175 $self->first. ' '. $self->get('last');
4178 =item ship_contact_firstlast
4180 Returns this customer's full (shipping) contact name only, "First Last".
4184 sub ship_contact_firstlast {
4186 my $contact = $self->service_contact || $self;
4187 $contact->get('first') . ' '. $contact->get('last');
4190 sub bill_country_full {
4192 $self->bill_location->country_full;
4195 sub ship_country_full {
4197 $self->ship_location->country_full;
4200 =item county_state_county [ PREFIX ]
4202 Returns a string consisting of just the county, state and country.
4206 sub county_state_country {
4209 if ( @_ && $_[0] && $self->has_ship_address ) {
4210 $locationnum = $self->ship_locationnum;
4212 $locationnum = $self->bill_locationnum;
4214 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4215 $cust_location->county_state_country;
4218 =item geocode DATA_VENDOR
4220 Returns a value for the customer location as encoded by DATA_VENDOR.
4221 Currently this only makes sense for "CCH" as DATA_VENDOR.
4229 Returns a status string for this customer, currently:
4235 No packages have ever been ordered. Displayed as "No packages".
4239 Recurring packages all are new (not yet billed).
4243 One or more recurring packages is active.
4247 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4251 All non-cancelled recurring packages are suspended.
4255 All recurring packages are cancelled.
4259 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4260 cust_main-status_module configuration option.
4264 sub status { shift->cust_status(@_); }
4268 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4269 for my $status ( FS::cust_main->statuses() ) {
4270 my $method = $status.'_sql';
4271 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4272 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4273 $sth->execute( ($self->custnum) x $numnum )
4274 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4275 if ( $sth->fetchrow_arrayref->[0] ) {
4276 $self->hashref->{cust_status} = $status;
4282 =item is_status_delay_cancel
4284 Returns true if customer status is 'suspended'
4285 and all suspended cust_pkg return true for
4286 cust_pkg->is_status_delay_cancel.
4288 This is not a real status, this only meant for hacking display
4289 values, because otherwise treating the customer as suspended is
4290 really the whole point of the delay_cancel option.
4294 sub is_status_delay_cancel {
4296 return 0 unless $self->status eq 'suspended';
4297 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4298 return 0 unless $cust_pkg->is_status_delay_cancel;
4303 =item ucfirst_cust_status
4305 =item ucfirst_status
4307 Deprecated, use the cust_status_label method instead.
4309 Returns the status with the first character capitalized.
4313 sub ucfirst_status {
4314 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4315 local($ucfirst_nowarn) = 1;
4316 shift->ucfirst_cust_status(@_);
4319 sub ucfirst_cust_status {
4320 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4322 ucfirst($self->cust_status);
4325 =item cust_status_label
4329 Returns the display label for this status.
4333 sub status_label { shift->cust_status_label(@_); }
4335 sub cust_status_label {
4337 __PACKAGE__->statuslabels->{$self->cust_status};
4342 Returns a hex triplet color string for this customer's status.
4346 sub statuscolor { shift->cust_statuscolor(@_); }
4348 sub cust_statuscolor {
4350 __PACKAGE__->statuscolors->{$self->cust_status};
4353 =item tickets [ STATUS ]
4355 Returns an array of hashes representing the customer's RT tickets.
4357 An optional status (or arrayref or hashref of statuses) may be specified.
4363 my $status = ( @_ && $_[0] ) ? shift : '';
4365 my $num = $conf->config('cust_main-max_tickets') || 10;
4368 if ( $conf->config('ticket_system') ) {
4369 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4371 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4380 foreach my $priority (
4381 $conf->config('ticket_system-custom_priority_field-values'), ''
4383 last if scalar(@tickets) >= $num;
4385 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4386 $num - scalar(@tickets),
4397 =item appointments [ STATUS ]
4399 Returns an array of hashes representing the customer's RT tickets which
4406 my $status = ( @_ && $_[0] ) ? shift : '';
4408 return () unless $conf->config('ticket_system');
4410 my $queueid = $conf->config('ticket_system-appointment-queueid');
4412 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4421 # Return services representing svc_accts in customer support packages
4422 sub support_services {
4424 my %packages = map { $_ => 1 } $conf->config('support_packages');
4426 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4427 grep { $_->part_svc->svcdb eq 'svc_acct' }
4428 map { $_->cust_svc }
4429 grep { exists $packages{ $_->pkgpart } }
4430 $self->ncancelled_pkgs;
4434 # Return a list of latitude/longitude for one of the services (if any)
4435 sub service_coordinates {
4439 grep { $_->latitude && $_->longitude }
4441 map { $_->cust_svc }
4442 $self->ncancelled_pkgs;
4444 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4449 Returns a masked version of the named field
4454 my ($self,$field) = @_;
4458 'x'x(length($self->getfield($field))-4).
4459 substr($self->getfield($field), (length($self->getfield($field))-4));
4463 =item payment_history
4465 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4466 cust_credit and cust_refund objects. Each hashref has the following fields:
4468 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4470 I<date> - value of _date field, unix timestamp
4472 I<date_pretty> - user-friendly date
4474 I<description> - user-friendly description of item
4476 I<amount> - impact of item on user's balance
4477 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4478 Not to be confused with the native 'amount' field in cust_credit, see below.
4480 I<amount_pretty> - includes money char
4482 I<balance> - customer balance, chronologically as of this item
4484 I<balance_pretty> - includes money char
4486 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4488 I<paid> - amount paid for cust_pay records, undef for other types
4490 I<credit> - amount credited for cust_credit records, undef for other types.
4491 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4493 I<refund> - amount refunded for cust_refund records, undef for other types
4495 The four table-specific keys always have positive values, whether they reflect charges or payments.
4497 The following options may be passed to this method:
4499 I<line_items> - if true, returns charges ('Line item') rather than invoices
4501 I<start_date> - unix timestamp, only include records on or after.
4502 If specified, an item of type 'Previous' will also be included.
4503 It does not have table-specific fields.
4505 I<end_date> - unix timestamp, only include records before
4507 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4509 I<conf> - optional already-loaded FS::Conf object.
4513 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4514 # and also for sending customer statements, which should both be kept customer-friendly.
4515 # If you add anything that shouldn't be passed on through the API or exposed
4516 # to customers, add a new option to include it, don't include it by default
4517 sub payment_history {
4519 my $opt = ref($_[0]) ? $_[0] : { @_ };
4521 my $conf = $$opt{'conf'} || new FS::Conf;
4522 my $money_char = $conf->config("money_char") || '$',
4524 #first load entire history,
4525 #need previous to calculate previous balance
4526 #loading after end_date shouldn't hurt too much?
4528 if ( $$opt{'line_items'} ) {
4530 foreach my $cust_bill ( $self->cust_bill ) {
4533 'type' => 'Line item',
4534 'description' => $_->desc( $self->locale ).
4535 ( $_->sdate && $_->edate
4536 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4537 ' To '. time2str('%d-%b-%Y', $_->edate)
4540 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4541 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4542 'date' => $cust_bill->_date,
4543 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4545 foreach $cust_bill->cust_bill_pkg;
4552 'type' => 'Invoice',
4553 'description' => 'Invoice #'. $_->display_invnum,
4554 'amount' => sprintf('%.2f', $_->charged ),
4555 'charged' => sprintf('%.2f', $_->charged ),
4556 'date' => $_->_date,
4557 'date_pretty' => $self->time2str_local('short', $_->_date ),
4559 foreach $self->cust_bill;
4564 'type' => 'Payment',
4565 'description' => 'Payment', #XXX type
4566 'amount' => sprintf('%.2f', 0 - $_->paid ),
4567 'paid' => sprintf('%.2f', $_->paid ),
4568 'date' => $_->_date,
4569 'date_pretty' => $self->time2str_local('short', $_->_date ),
4571 foreach $self->cust_pay;
4575 'description' => 'Credit', #more info?
4576 'amount' => sprintf('%.2f', 0 -$_->amount ),
4577 'credit' => sprintf('%.2f', $_->amount ),
4578 'date' => $_->_date,
4579 'date_pretty' => $self->time2str_local('short', $_->_date ),
4581 foreach $self->cust_credit;
4585 'description' => 'Refund', #more info? type, like payment?
4586 'amount' => $_->refund,
4587 'refund' => $_->refund,
4588 'date' => $_->_date,
4589 'date_pretty' => $self->time2str_local('short', $_->_date ),
4591 foreach $self->cust_refund;
4593 #put it all in chronological order
4594 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4596 #calculate balance, filter items outside date range
4600 foreach my $item (@history) {
4601 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4602 $balance += $$item{'amount'};
4603 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4604 $previous += $$item{'amount'};
4607 $$item{'balance'} = sprintf("%.2f",$balance);
4608 foreach my $key ( qw(amount balance) ) {
4609 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4614 # start with previous balance, if there was one
4617 'type' => 'Previous',
4618 'description' => 'Previous balance',
4619 'amount' => sprintf("%.2f",$previous),
4620 'balance' => sprintf("%.2f",$previous),
4621 'date' => $$opt{'start_date'},
4622 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4624 #false laziness with above
4625 foreach my $key ( qw(amount balance) ) {
4626 $$item{$key.'_pretty'} = $$item{$key};
4627 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4629 unshift(@out,$item);
4632 @out = reverse @history if $$opt{'reverse_sort'};
4637 =item save_cust_payby
4639 Saves a new cust_payby for this customer, replacing an existing entry only
4640 in select circumstances. Does not validate input.
4642 If auto is specified, marks this as the customer's primary method, or the
4643 specified weight. Existing payment methods have their weight incremented as
4646 If bill_location is specified with auto, also sets location in cust_main.
4648 Will not insert complete duplicates of existing records, or records in which the
4649 only difference from an existing record is to turn off automatic payment (will
4650 return without error.) Will replace existing records in which the only difference
4651 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4652 Fields marked as preserved are optional, and existing values will not be overwritten with
4653 blanks when replacing.
4655 Accepts the following named parameters:
4665 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4669 optional, set higher than 1 for secondary, etc.
4677 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4685 optional, will be preserved when replacing
4693 CARD only, required, FS::cust_location object
4695 =item paystart_month
4697 CARD only, optional, will be preserved when replacing
4701 CARD only, optional, will be preserved when replacing
4705 CARD only, optional, will be preserved when replacing
4709 CARD only, only used if conf cvv-save is set appropriately
4719 =item saved_cust_payby
4721 scalar reference, for returning saved object
4727 #The code for this option is in place, but it's not currently used
4731 # existing cust_payby object to be replaced (must match custnum)
4733 # stateid/stateid_state/ss are not currently supported in cust_payby,
4734 # might not even work properly in 4.x, but will need to work here if ever added
4736 sub save_cust_payby {
4740 my $old = $opt{'replace'};
4741 my $new = new FS::cust_payby { $old ? $old->hash : () };
4742 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4743 $new->set( 'custnum' => $self->custnum );
4745 my $payby = $opt{'payment_payby'};
4746 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4748 # don't allow turning off auto when replacing
4749 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4751 my @check_existing; # payby relevant to this payment_payby
4753 # set payby based on auto
4754 if ( $payby eq 'CARD' ) {
4755 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4756 @check_existing = qw( CARD DCRD );
4757 } elsif ( $payby eq 'CHEK' ) {
4758 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4759 @check_existing = qw( CHEK DCHK );
4762 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4765 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4766 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4767 $new->set( 'payname' => $opt{'payname'} );
4768 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4770 my $conf = new FS::Conf;
4772 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4773 if ( $payby eq 'CARD' &&
4774 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4775 || $conf->exists('business-onlinepayment-verification')
4778 $new->set( 'paycvv' => $opt{'paycvv'} );
4780 $new->set( 'paycvv' => '');
4783 local $SIG{HUP} = 'IGNORE';
4784 local $SIG{INT} = 'IGNORE';
4785 local $SIG{QUIT} = 'IGNORE';
4786 local $SIG{TERM} = 'IGNORE';
4787 local $SIG{TSTP} = 'IGNORE';
4788 local $SIG{PIPE} = 'IGNORE';
4790 my $oldAutoCommit = $FS::UID::AutoCommit;
4791 local $FS::UID::AutoCommit = 0;
4794 # set fields specific to payment_payby
4795 if ( $payby eq 'CARD' ) {
4796 if ($opt{'bill_location'}) {
4797 $opt{'bill_location'}->set('custnum' => $self->custnum);
4798 my $error = $opt{'bill_location'}->find_or_insert;
4800 $dbh->rollback if $oldAutoCommit;
4803 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4805 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4806 $new->set( $field => $opt{$field} );
4809 foreach my $field ( qw(paytype paystate) ) {
4810 $new->set( $field => $opt{$field} );
4814 # other cust_payby to compare this to
4815 my @existing = $self->cust_payby(@check_existing);
4817 # fields that can overwrite blanks with values, but not values with blanks
4818 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4820 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4822 # generally, we don't want to overwrite existing cust_payby with this,
4823 # but we can replace if we're only marking it auto or adding a preserved field
4824 # and we can avoid saving a total duplicate or merely turning off auto
4826 foreach my $cust_payby (@existing) {
4827 # check fields that absolutely should not change
4828 foreach my $field ($new->fields) {
4829 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4830 next if grep(/^$field$/, @preserve );
4831 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4833 # now check fields that can replace if one value is blank
4835 foreach my $field (@preserve) {
4837 ( $new->get($field) and !$cust_payby->get($field) ) or
4838 ( $cust_payby->get($field) and !$new->get($field) )
4840 # prevention of overwriting values with blanks happens farther below
4842 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4846 unless ( $replace ) {
4847 # nearly identical, now check weight
4848 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4849 # ignore identical cust_payby, and ignore attempts to turn off auto
4850 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4851 $skip_cust_payby = 1;
4854 # otherwise, only change is to mark this as primary
4856 # if we got this far, we're definitely replacing
4863 $new->set( 'custpaybynum' => $old->custpaybynum );
4864 # don't turn off automatic payment (but allow it to be turned on)
4865 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4867 $new->set( 'payby' => $old->payby );
4868 $new->set( 'weight' => 1 );
4870 # make sure we're not overwriting values with blanks
4871 foreach my $field (@preserve) {
4872 if ( $old->get($field) and !$new->get($field) ) {
4873 $new->set( $field => $old->get($field) );
4878 # only overwrite cust_main bill_location if auto
4879 if ($opt{'auto'} && $opt{'bill_location'}) {
4880 $self->set('bill_location' => $opt{'bill_location'});
4881 my $error = $self->replace;
4883 $dbh->rollback if $oldAutoCommit;
4888 # done with everything except reweighting and saving cust_payby
4889 # still need to commit changes to cust_main and cust_location
4890 if ($skip_cust_payby) {
4891 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4895 # re-weight existing primary cust_pay for this payby
4897 foreach my $cust_payby (@existing) {
4898 # relies on cust_payby return order
4899 last unless $cust_payby->payby !~ /^D/;
4900 last if $cust_payby->weight > 1;
4901 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4902 next if $cust_payby->weight < ($opt{'weight'} || 1);
4903 $cust_payby->weight( $cust_payby->weight + 1 );
4904 my $error = $cust_payby->replace;
4906 $dbh->rollback if $oldAutoCommit;
4907 return "Error reweighting cust_payby: $error";
4912 # finally, save cust_payby
4913 my $error = $old ? $new->replace($old) : $new->insert;
4915 $dbh->rollback if $oldAutoCommit;
4919 ${$opt{'saved_cust_payby'}} = $new
4920 if $opt{'saved_cust_payby'};
4922 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4927 =item remove_cvv_from_cust_payby PAYINFO
4929 Removes paycvv from associated cust_payby with matching PAYINFO.
4933 sub remove_cvv_from_cust_payby {
4934 my ($self,$payinfo) = @_;
4936 my $oldAutoCommit = $FS::UID::AutoCommit;
4937 local $FS::UID::AutoCommit = 0;
4940 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4941 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4942 $cust_payby->paycvv('');
4943 my $error = $cust_payby->replace;
4945 $dbh->rollback if $oldAutoCommit;
4950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4956 =head1 CLASS METHODS
4962 Class method that returns the list of possible status strings for customers
4963 (see L<the status method|/status>). For example:
4965 @statuses = FS::cust_main->statuses();
4971 keys %{ $self->statuscolors };
4974 =item cust_status_sql
4976 Returns an SQL fragment to determine the status of a cust_main record, as a
4981 sub cust_status_sql {
4983 for my $status ( FS::cust_main->statuses() ) {
4984 my $method = $status.'_sql';
4985 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4994 Returns an SQL expression identifying prospective cust_main records (customers
4995 with no packages ever ordered)
4999 use vars qw($select_count_pkgs);
5000 $select_count_pkgs =
5001 "SELECT COUNT(*) FROM cust_pkg
5002 WHERE cust_pkg.custnum = cust_main.custnum";
5004 sub select_count_pkgs_sql {
5009 " 0 = ( $select_count_pkgs ) ";
5014 Returns an SQL expression identifying ordered cust_main records (customers with
5015 no active packages, but recurring packages not yet setup or one time charges
5021 FS::cust_main->none_active_sql.
5022 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5027 Returns an SQL expression identifying active cust_main records (customers with
5028 active recurring packages).
5033 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5036 =item none_active_sql
5038 Returns an SQL expression identifying cust_main records with no active
5039 recurring packages. This includes customers of status prospect, ordered,
5040 inactive, and suspended.
5044 sub none_active_sql {
5045 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5050 Returns an SQL expression identifying inactive cust_main records (customers with
5051 no active recurring packages, but otherwise unsuspended/uncancelled).
5056 FS::cust_main->none_active_sql.
5057 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5063 Returns an SQL expression identifying suspended cust_main records.
5068 sub suspended_sql { susp_sql(@_); }
5070 FS::cust_main->none_active_sql.
5071 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5077 Returns an SQL expression identifying cancelled cust_main records.
5081 sub cancel_sql { shift->cancelled_sql(@_); }
5084 =item uncancelled_sql
5086 Returns an SQL expression identifying un-cancelled cust_main records.
5090 sub uncancelled_sql { uncancel_sql(@_); }
5093 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5098 Returns an SQL fragment to retreive the balance.
5103 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5104 WHERE cust_bill.custnum = cust_main.custnum )
5105 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5106 WHERE cust_pay.custnum = cust_main.custnum )
5107 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5108 WHERE cust_credit.custnum = cust_main.custnum )
5109 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5110 WHERE cust_refund.custnum = cust_main.custnum )
5113 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5115 Returns an SQL fragment to retreive the balance for this customer, optionally
5116 considering invoices with date earlier than START_TIME, and not
5117 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5118 total_unapplied_payments).
5120 Times are specified as SQL fragments or numeric
5121 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5122 L<Date::Parse> for conversion functions. The empty string can be passed
5123 to disable that time constraint completely.
5125 Available options are:
5129 =item unapplied_date
5131 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)
5136 set to true to remove all customer comparison clauses, for totals
5141 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5146 JOIN clause (typically used with the total option)
5150 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5151 time will be ignored. Note that START_TIME and END_TIME only limit the date
5152 range for invoices and I<unapplied> payments, credits, and refunds.
5158 sub balance_date_sql {
5159 my( $class, $start, $end, %opt ) = @_;
5161 my $cutoff = $opt{'cutoff'};
5163 my $owed = FS::cust_bill->owed_sql($cutoff);
5164 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5165 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5166 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5168 my $j = $opt{'join'} || '';
5170 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5171 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5172 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5173 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5175 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5176 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5177 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5178 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5183 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5185 Returns an SQL fragment to retreive the total unapplied payments for this
5186 customer, only considering payments with date earlier than START_TIME, and
5187 optionally not later than END_TIME.
5189 Times are specified as SQL fragments or numeric
5190 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5191 L<Date::Parse> for conversion functions. The empty string can be passed
5192 to disable that time constraint completely.
5194 Available options are:
5198 sub unapplied_payments_date_sql {
5199 my( $class, $start, $end, %opt ) = @_;
5201 my $cutoff = $opt{'cutoff'};
5203 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5205 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5206 'unapplied_date'=>1 );
5208 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5211 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5213 Helper method for balance_date_sql; name (and usage) subject to change
5214 (suggestions welcome).
5216 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5217 cust_refund, cust_credit or cust_pay).
5219 If TABLE is "cust_bill" or the unapplied_date option is true, only
5220 considers records with date earlier than START_TIME, and optionally not
5221 later than END_TIME .
5225 sub _money_table_where {
5226 my( $class, $table, $start, $end, %opt ) = @_;
5229 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5230 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5231 push @where, "$table._date <= $start" if defined($start) && length($start);
5232 push @where, "$table._date > $end" if defined($end) && length($end);
5234 push @where, @{$opt{'where'}} if $opt{'where'};
5235 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5241 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5242 use FS::cust_main::Search;
5245 FS::cust_main::Search->search(@_);
5254 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5256 #Deprecated. Use event notification and message templates
5257 #(L<FS::msg_template>) instead.
5259 #Sends a templated email notification to the customer (see L<Text::Template>).
5261 #OPTIONS is a hash and may include
5263 #I<from> - the email sender (default is invoice_from)
5265 #I<to> - comma-separated scalar or arrayref of recipients
5266 # (default is invoicing_list)
5268 #I<subject> - The subject line of the sent email notification
5269 # (default is "Notice from company_name")
5271 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5274 #The following variables are vavailable in the template.
5276 #I<$first> - the customer first name
5277 #I<$last> - the customer last name
5278 #I<$company> - the customer company
5279 #I<$payby> - a description of the method of payment for the customer
5280 # # would be nice to use FS::payby::shortname
5281 #I<$payinfo> - the account information used to collect for this customer
5282 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5287 # my ($self, $template, %options) = @_;
5289 # return unless $conf->exists($template);
5291 # my $from = $conf->invoice_from_full($self->agentnum)
5292 # if $conf->exists('invoice_from', $self->agentnum);
5293 # $from = $options{from} if exists($options{from});
5295 # my $to = join(',', $self->invoicing_list_emailonly);
5296 # $to = $options{to} if exists($options{to});
5298 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5299 # if $conf->exists('company_name', $self->agentnum);
5300 # $subject = $options{subject} if exists($options{subject});
5302 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5303 # SOURCE => [ map "$_\n",
5304 # $conf->config($template)]
5306 # or die "can't create new Text::Template object: Text::Template::ERROR";
5307 # $notify_template->compile()
5308 # or die "can't compile template: Text::Template::ERROR";
5310 # $FS::notify_template::_template::company_name =
5311 # $conf->config('company_name', $self->agentnum);
5312 # $FS::notify_template::_template::company_address =
5313 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5315 # my $paydate = $self->paydate || '2037-12-31';
5316 # $FS::notify_template::_template::first = $self->first;
5317 # $FS::notify_template::_template::last = $self->last;
5318 # $FS::notify_template::_template::company = $self->company;
5319 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5320 # my $payby = $self->payby;
5321 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5322 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5324 # #credit cards expire at the end of the month/year of their exp date
5325 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5326 # $FS::notify_template::_template::payby = 'credit card';
5327 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5328 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5330 # }elsif ($payby eq 'COMP') {
5331 # $FS::notify_template::_template::payby = 'complimentary account';
5333 # $FS::notify_template::_template::payby = 'current method';
5335 # $FS::notify_template::_template::expdate = $expire_time;
5337 # for (keys %{$options{extra_fields}}){
5339 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5342 # send_email(from => $from,
5344 # subject => $subject,
5345 # body => $notify_template->fill_in( PACKAGE =>
5346 # 'FS::notify_template::_template' ),
5351 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5353 Generates a templated notification to the customer (see L<Text::Template>).
5355 OPTIONS is a hash and may include
5357 I<extra_fields> - a hashref of name/value pairs which will be substituted
5358 into the template. These values may override values mentioned below
5359 and those from the customer record.
5361 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5363 The following variables are available in the template instead of or in addition
5364 to the fields of the customer record.
5366 I<$payby> - a description of the method of payment for the customer
5367 # would be nice to use FS::payby::shortname
5368 I<$payinfo> - the masked account information used to collect for this customer
5369 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5370 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5374 # a lot like cust_bill::print_latex
5375 sub generate_letter {
5376 my ($self, $template, %options) = @_;
5378 warn "Template $template does not exist" && return
5379 unless $conf->exists($template) || $options{'template_text'};
5381 my $template_source = $options{'template_text'}
5382 ? [ $options{'template_text'} ]
5383 : [ map "$_\n", $conf->config($template) ];
5385 my $letter_template = new Text::Template
5387 SOURCE => $template_source,
5388 DELIMITERS => [ '[@--', '--@]' ],
5390 or die "can't create new Text::Template object: Text::Template::ERROR";
5392 $letter_template->compile()
5393 or die "can't compile template: Text::Template::ERROR";
5395 my %letter_data = map { $_ => $self->$_ } $self->fields;
5396 $letter_data{payinfo} = $self->mask_payinfo;
5398 #my $paydate = $self->paydate || '2037-12-31';
5399 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5401 my $payby = $self->payby;
5402 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5403 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5405 #credit cards expire at the end of the month/year of their exp date
5406 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5407 $letter_data{payby} = 'credit card';
5408 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5409 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5411 }elsif ($payby eq 'COMP') {
5412 $letter_data{payby} = 'complimentary account';
5414 $letter_data{payby} = 'current method';
5416 $letter_data{expdate} = $expire_time;
5418 for (keys %{$options{extra_fields}}){
5419 $letter_data{$_} = $options{extra_fields}->{$_};
5422 unless(exists($letter_data{returnaddress})){
5423 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5424 $self->agent_template)
5426 if ( length($retadd) ) {
5427 $letter_data{returnaddress} = $retadd;
5428 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5429 $letter_data{returnaddress} =
5430 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5434 ( $conf->config('company_name', $self->agentnum),
5435 $conf->config('company_address', $self->agentnum),
5439 $letter_data{returnaddress} = '~';
5443 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5445 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5447 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5449 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5453 ) or die "can't open temp file: $!\n";
5454 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5455 or die "can't write temp file: $!\n";
5457 $letter_data{'logo_file'} = $lh->filename;
5459 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5463 ) or die "can't open temp file: $!\n";
5465 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5467 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5468 return ($1, $letter_data{'logo_file'});
5472 =item print_ps TEMPLATE
5474 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5480 my($file, $lfile) = $self->generate_letter(@_);
5481 my $ps = FS::Misc::generate_ps($file);
5482 unlink($file.'.tex');
5488 =item print TEMPLATE
5490 Prints the filled in template.
5492 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5496 sub queueable_print {
5499 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5500 or die "invalid customer number: " . $opt{custnum};
5502 #do not backport this change to 3.x
5503 # my $error = $self->print( { 'template' => $opt{template} } );
5504 my $error = $self->print( $opt{'template'} );
5505 die $error if $error;
5509 my ($self, $template) = (shift, shift);
5511 [ $self->print_ps($template) ],
5512 'agentnum' => $self->agentnum,
5516 #these three subs should just go away once agent stuff is all config overrides
5518 sub agent_template {
5520 $self->_agent_plandata('agent_templatename');
5523 sub agent_invoice_from {
5525 $self->_agent_plandata('agent_invoice_from');
5528 sub _agent_plandata {
5529 my( $self, $option ) = @_;
5531 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5532 #agent-specific Conf
5534 use FS::part_event::Condition;
5536 my $agentnum = $self->agentnum;
5538 my $regexp = regexp_sql();
5540 my $part_event_option =
5542 'select' => 'part_event_option.*',
5543 'table' => 'part_event_option',
5545 LEFT JOIN part_event USING ( eventpart )
5546 LEFT JOIN part_event_option AS peo_agentnum
5547 ON ( part_event.eventpart = peo_agentnum.eventpart
5548 AND peo_agentnum.optionname = 'agentnum'
5549 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5551 LEFT JOIN part_event_condition
5552 ON ( part_event.eventpart = part_event_condition.eventpart
5553 AND part_event_condition.conditionname = 'cust_bill_age'
5555 LEFT JOIN part_event_condition_option
5556 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5557 AND part_event_condition_option.optionname = 'age'
5560 #'hashref' => { 'optionname' => $option },
5561 #'hashref' => { 'part_event_option.optionname' => $option },
5563 " WHERE part_event_option.optionname = ". dbh->quote($option).
5564 " AND action = 'cust_bill_send_agent' ".
5565 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5566 " AND peo_agentnum.optionname = 'agentnum' ".
5567 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5569 CASE WHEN part_event_condition_option.optionname IS NULL
5571 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5573 , part_event.weight".
5577 unless ( $part_event_option ) {
5578 return $self->agent->invoice_template || ''
5579 if $option eq 'agent_templatename';
5583 $part_event_option->optionvalue;
5587 sub process_o2m_qsearch {
5590 return qsearch($table, @_) unless $table eq 'contact';
5592 my $hashref = shift;
5593 my %hash = %$hashref;
5594 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5595 or die 'guru meditation #4343';
5597 qsearch({ 'table' => 'contact',
5598 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5599 'hashref' => \%hash,
5600 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5601 " cust_contact.custnum = $custnum "
5605 sub process_o2m_qsearchs {
5608 return qsearchs($table, @_) unless $table eq 'contact';
5610 my $hashref = shift;
5611 my %hash = %$hashref;
5612 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5613 or die 'guru meditation #2121';
5615 qsearchs({ 'table' => 'contact',
5616 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5617 'hashref' => \%hash,
5618 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5619 " cust_contact.custnum = $custnum "
5623 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5625 Subroutine (not a method), designed to be called from the queue.
5627 Takes a list of options and values.
5629 Pulls up the customer record via the custnum option and calls bill_and_collect.
5634 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5636 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5637 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5639 #without this errors don't get rolled back
5640 $args{'fatal'} = 1; # runs from job queue, will be caught
5642 $cust_main->bill_and_collect( %args );
5645 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5647 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5648 C<collect> part. This is used in batch tax calculation, where invoice
5649 generation and collection events have to be completely separated.
5653 sub queued_collect {
5655 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5657 $cust_main->collect(%args);
5660 sub process_bill_and_collect {
5663 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5664 or die "custnum '$param->{custnum}' not found!\n";
5665 $param->{'job'} = $job;
5666 $param->{'fatal'} = 1; # runs from job queue, will be caught
5667 $param->{'retry'} = 1;
5669 $cust_main->bill_and_collect( %$param );
5672 #starting to take quite a while for big dbs
5673 # (JRNL: journaled so it only happens once per database)
5674 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5675 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5676 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5677 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5678 # JRNL leading/trailing spaces in first, last, company
5679 # JRNL migrate to cust_payby
5680 # - otaker upgrade? journal and call it good? (double check to make sure
5681 # we're not still setting otaker here)
5683 #only going to get worse with new location stuff...
5685 sub _upgrade_data { #class method
5686 my ($class, %opts) = @_;
5689 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5692 #this seems to be the only expensive one.. why does it take so long?
5693 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5695 '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';
5696 FS::upgrade_journal->set_done('cust_main__signupdate');
5699 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5701 # fix yyyy-m-dd formatted paydates
5702 if ( driver_name =~ /^mysql/i ) {
5704 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5705 } else { # the SQL standard
5707 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5709 FS::upgrade_journal->set_done('cust_main__paydate');
5712 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5714 push @statements, #fix the weird BILL with a cc# in payinfo problem
5716 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5718 FS::upgrade_journal->set_done('cust_main__payinfo');
5723 foreach my $sql ( @statements ) {
5724 my $sth = dbh->prepare($sql) or die dbh->errstr;
5725 $sth->execute or die $sth->errstr;
5726 #warn ( (time - $t). " seconds\n" );
5730 local($ignore_expired_card) = 1;
5731 local($ignore_banned_card) = 1;
5732 local($skip_fuzzyfiles) = 1;
5733 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5735 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5737 #we don't want to decrypt them, just stuff them as-is into cust_payby
5738 local(@encrypted_fields) = ();
5740 local($FS::cust_payby::ignore_expired_card) = 1;
5741 local($FS::cust_payby::ignore_banned_card) = 1;
5742 local($FS::cust_payby::ignore_cardtype) = 1;
5744 my @payfields = qw( payby payinfo paycvv paymask
5745 paydate paystart_month paystart_year payissue
5746 payname paystate paytype payip
5749 my $search = new FS::Cursor {
5750 'table' => 'cust_main',
5751 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5754 while (my $cust_main = $search->fetch) {
5756 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5758 my $cust_payby = new FS::cust_payby {
5759 'custnum' => $cust_main->custnum,
5761 map { $_ => $cust_main->$_(); } @payfields
5764 my $error = $cust_payby->insert;
5765 die $error if $error;
5769 # at the time we do this, also migrate paytype into cust_pay_batch
5770 # so that batches that are open before the migration can still be
5772 my @cust_pay_batch = qsearch('cust_pay_batch', {
5773 'custnum' => $cust_main->custnum,
5777 foreach my $cust_pay_batch (@cust_pay_batch) {
5778 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5779 my $error = $cust_pay_batch->replace;
5780 die "$error (setting cust_pay_batch.paytype)" if $error;
5783 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5785 $cust_main->invoice_attn( $cust_main->payname )
5786 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5787 $cust_main->po_number( $cust_main->payinfo )
5788 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5790 $cust_main->setfield($_, '') foreach @payfields;
5791 my $error = $cust_main->replace;
5792 die "Error upgradging payment information for custnum ".
5793 $cust_main->custnum. ": $error"
5798 FS::upgrade_journal->set_done('cust_main__cust_payby');
5801 FS::cust_main::Location->_upgrade_data(%opts);
5803 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5805 foreach my $cust_main ( qsearch({
5806 'table' => 'cust_main',
5808 'extra_sql' => 'WHERE '.
5810 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5811 qw( first last company )
5814 my $error = $cust_main->replace;
5815 die $error if $error;
5818 FS::upgrade_journal->set_done('cust_main__trimspaces');
5822 $class->_upgrade_otaker(%opts);
5824 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5825 # existing records will be encrypted in queueable_upgrade (below)
5826 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5827 eval "use FS::Setup";
5829 FS::Setup::enable_encryption();
5834 sub queueable_upgrade {
5837 ### encryption gets turned on in _upgrade_data, above
5839 eval "use FS::upgrade_journal";
5842 # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
5843 # clear that out before encrypting/tokenizing anything else
5844 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5845 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5846 my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5847 my $sth = dbh->prepare($sql) or die dbh->errstr;
5848 $sth->execute or die $sth->errstr;
5850 FS::upgrade_journal->set_done('clear_payinfo_history');
5853 # fix Tokenized paycardtype and encrypt old records
5854 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5855 || ! FS::upgrade_journal->is_done('encryption_check')
5859 # allow replacement of closed cust_pay/cust_refund records
5860 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5862 # because it looks like nothing's changing
5863 local $FS::Record::no_update_diff = 1;
5865 # commit everything immediately
5866 local $FS::UID::AutoCommit = 1;
5868 # encrypt what's there
5869 foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5870 my $tclass = 'FS::'.$table;
5873 while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
5874 my $record = $tclass->by_key($recnum);
5875 next unless $record; # small chance it's been deleted, that's ok
5876 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5877 # window for possible conflict is practically nonexistant,
5878 # but just in case...
5879 $record = $record->select_for_update;
5880 if (!$record->custnum && $table eq 'cust_pay_pending') {
5881 $record->set('custnum_pending',1);
5883 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5885 local($ignore_expired_card) = 1;
5886 local($ignore_banned_card) = 1;
5887 local($skip_fuzzyfiles) = 1;
5888 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5890 my $error = $record->replace;
5891 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5895 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5896 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5899 # now that everything's encrypted, tokenize...
5900 FS::cust_main::Billing_Realtime::token_check(@_);
5903 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5904 # cust_payby might get deleted while this runs
5906 sub _upgrade_next_recnum {
5907 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5908 my $recnum = shift @$recnums;
5909 return $recnum if $recnum;
5910 my $tclass = 'FS::'.$table;
5911 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5912 my $sql = 'SELECT '.$tclass->primary_key.
5914 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5915 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5916 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5917 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5918 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5919 $sth->execute() or die $sth->errstr;
5921 while (my $rec = $sth->fetchrow_hashref) {
5922 push @$recnums, $rec->{$tclass->primary_key};
5925 $$lastrecnum = $$recnums[-1];
5926 return shift @$recnums;
5935 The delete method should possibly take an FS::cust_main object reference
5936 instead of a scalar customer number.
5938 Bill and collect options should probably be passed as references instead of a
5941 There should probably be a configuration file with a list of allowed credit
5944 No multiple currency support (probably a larger project than just this module).
5946 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5948 Birthdates rely on negative epoch values.
5950 The payby for card/check batches is broken. With mixed batching, bad
5953 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5957 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5958 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5959 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.