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
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
29 use File::Temp; #qw( tempfile );
30 use Business::CreditCard 0.28;
31 use List::Util qw(min);
33 use FS::UID qw( dbh driver_name );
34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
36 use FS::Misc qw( generate_ps do_print money_pretty card_types );
37 use FS::Msgcat qw(gettext);
44 use FS::cust_bill_void;
45 use FS::legacy_cust_bill;
47 use FS::cust_pay_pending;
48 use FS::cust_pay_void;
49 use FS::cust_pay_batch;
52 use FS::part_referral;
53 use FS::cust_main_county;
54 use FS::cust_location;
57 use FS::cust_main_exemption;
58 use FS::cust_tax_adjustment;
59 use FS::cust_tax_location;
60 use FS::agent_currency;
61 use FS::cust_main_invoice;
63 use FS::prepay_credit;
69 use FS::payment_gateway;
70 use FS::agent_payment_gateway;
72 use FS::cust_main_note;
73 use FS::cust_attachment;
76 use FS::upgrade_journal;
82 # 1 is mostly method/subroutine entry and options
83 # 2 traces progress of some operations
84 # 3 is even more information including possibly sensitive data
86 our $me = '[FS::cust_main]';
89 our $ignore_expired_card = 0;
90 our $ignore_banned_card = 0;
91 our $ignore_invalid_card = 0;
93 our $skip_fuzzyfiles = 0;
95 our $ucfirst_nowarn = 0;
97 #this info is in cust_payby as of 4.x
98 #this and the fields themselves can be removed in 5.x
99 our @encrypted_fields = ('payinfo', 'paycvv');
100 sub nohistory_fields { ('payinfo', 'paycvv'); }
103 our $default_agent_custid;
104 our $custnum_display_length;
105 #ask FS::UID to run this stuff for us later
106 #$FS::UID::callback{'FS::cust_main'} = sub {
107 install_callback FS::UID sub {
108 $conf = new FS::Conf;
109 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
110 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
111 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
116 my ( $hashref, $cache ) = @_;
117 if ( exists $hashref->{'pkgnum'} ) {
118 #@{ $self->{'_pkgnum'} } = ();
119 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
120 $self->{'_pkgnum'} = $subcache;
121 #push @{ $self->{'_pkgnum'} },
122 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
128 FS::cust_main - Object methods for cust_main records
134 $record = new FS::cust_main \%hash;
135 $record = new FS::cust_main { 'column' => 'value' };
137 $error = $record->insert;
139 $error = $new_record->replace($old_record);
141 $error = $record->delete;
143 $error = $record->check;
145 @cust_pkg = $record->all_pkgs;
147 @cust_pkg = $record->ncancelled_pkgs;
149 @cust_pkg = $record->suspended_pkgs;
151 $error = $record->bill;
152 $error = $record->bill %options;
153 $error = $record->bill 'time' => $time;
155 $error = $record->collect;
156 $error = $record->collect %options;
157 $error = $record->collect 'invoice_time' => $time,
162 An FS::cust_main object represents a customer. FS::cust_main inherits from
163 FS::Record. The following fields are currently supported:
169 Primary key (assigned automatically for new customers)
173 Agent (see L<FS::agent>)
177 Advertising source (see L<FS::part_referral>)
189 Cocial security number (optional)
213 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
217 Payment Information (See L<FS::payinfo_Mixin> for data format)
221 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
225 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
229 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
233 Start date month (maestro/solo cards only)
237 Start date year (maestro/solo cards only)
241 Issue number (maestro/solo cards only)
245 Name on card or billing name
249 IP address from which payment information was received
253 Tax exempt, empty or `Y'
257 Order taker (see L<FS::access_user>)
263 =item referral_custnum
265 Referring customer number
269 Enable individual CDR spooling, empty or `Y'
273 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
277 Discourage individual CDR printing, empty or `Y'
281 Allow self-service editing of ticket subjects, empty or 'Y'
283 =item calling_list_exempt
285 Do not call, empty or 'Y'
287 =item invoice_ship_address
289 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
299 Creates a new customer. To add the customer to the database, see L<"insert">.
301 Note that this stores the hash reference, not a distinct copy of the hash it
302 points to. You can ask the object for a copy with the I<hash> method.
306 sub table { 'cust_main'; }
308 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
310 Adds this customer to the database. If there is an error, returns the error,
311 otherwise returns false.
313 Usually the customer's location will not yet exist in the database, and
314 the C<bill_location> and C<ship_location> pseudo-fields must be set to
315 uninserted L<FS::cust_location> objects. These will be inserted and linked
316 (in both directions) to the new customer record. If they're references
317 to the same object, they will become the same location.
319 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
320 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
321 are inserted atomicly, or the transaction is rolled back. Passing an empty
322 hash reference is equivalent to not supplying this parameter. There should be
323 a better explanation of this, but until then, here's an example:
326 tie %hash, 'Tie::RefHash'; #this part is important
328 $cust_pkg => [ $svc_acct ],
331 $cust_main->insert( \%hash );
333 INVOICING_LIST_ARYREF: No longer supported.
335 Currently available options are: I<depend_jobnum>, I<noexport>,
336 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
338 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
339 on the supplied jobnum (they will not run until the specific job completes).
340 This can be used to defer provisioning until some action completes (such
341 as running the customer's credit card successfully).
343 The I<noexport> option is deprecated. If I<noexport> is set true, no
344 provisioning jobs (exports) are scheduled. (You can schedule them later with
345 the B<reexport> method.)
347 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
348 of tax names and exemption numbers. FS::cust_main_exemption records will be
349 created and inserted.
351 If I<prospectnum> is set, moves contacts and locations from that prospect.
353 If I<contact> is set to an arrayref of FS::contact objects, those will be
356 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
357 unset), inserts those new contacts with this new customer. Handles CGI
358 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
360 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
361 new stored payment records with this new customer. Handles CGI parameters
362 for an "m2" multiple entry field as passed by edit/cust_main.cgi
368 my $cust_pkgs = @_ ? shift : {};
370 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
371 warn "cust_main::insert using deprecated invoicing list argument";
372 $invoicing_list = shift;
375 warn "$me insert called with options ".
376 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
379 local $SIG{HUP} = 'IGNORE';
380 local $SIG{INT} = 'IGNORE';
381 local $SIG{QUIT} = 'IGNORE';
382 local $SIG{TERM} = 'IGNORE';
383 local $SIG{TSTP} = 'IGNORE';
384 local $SIG{PIPE} = 'IGNORE';
386 my $oldAutoCommit = $FS::UID::AutoCommit;
387 local $FS::UID::AutoCommit = 0;
390 my $prepay_identifier = '';
391 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
393 if ( $self->payby eq 'PREPAY' ) {
395 $self->payby(''); #'BILL');
396 $prepay_identifier = $self->payinfo;
399 warn " looking up prepaid card $prepay_identifier\n"
402 my $error = $self->get_prepay( $prepay_identifier,
403 'amount_ref' => \$amount,
404 'seconds_ref' => \$seconds,
405 'upbytes_ref' => \$upbytes,
406 'downbytes_ref' => \$downbytes,
407 'totalbytes_ref' => \$totalbytes,
410 $dbh->rollback if $oldAutoCommit;
411 #return "error applying prepaid card (transaction rolled back): $error";
415 $payby = 'PREP' if $amount;
417 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
420 $self->payby(''); #'BILL');
421 $amount = $self->paid;
426 foreach my $l (qw(bill_location ship_location)) {
428 my $loc = delete $self->hashref->{$l} or next;
430 if ( !$loc->locationnum ) {
431 # warn the location that we're going to insert it with no custnum
432 $loc->set(custnum_pending => 1);
433 warn " inserting $l\n"
435 my $error = $loc->insert;
437 $dbh->rollback if $oldAutoCommit;
438 my $label = $l eq 'ship_location' ? 'service' : 'billing';
439 return "$error (in $label location)";
442 } elsif ( $loc->prospectnum ) {
444 $loc->prospectnum('');
445 $loc->set(custnum_pending => 1);
446 my $error = $loc->replace;
448 $dbh->rollback if $oldAutoCommit;
449 my $label = $l eq 'ship_location' ? 'service' : 'billing';
450 return "$error (moving $label location)";
453 } elsif ( ($loc->custnum || 0) > 0 ) {
454 # then it somehow belongs to another customer--shouldn't happen
455 $dbh->rollback if $oldAutoCommit;
456 return "$l belongs to customer ".$loc->custnum;
458 # else it already belongs to this customer
459 # (happens when ship_location is identical to bill_location)
461 $self->set($l.'num', $loc->locationnum);
463 if ( $self->get($l.'num') eq '' ) {
464 $dbh->rollback if $oldAutoCommit;
469 warn " inserting $self\n"
472 $self->signupdate(time) unless $self->signupdate;
474 $self->auto_agent_custid()
475 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
477 my $error = $self->check_payinfo_cardtype
478 || $self->SUPER::insert;
480 $dbh->rollback if $oldAutoCommit;
481 #return "inserting cust_main record (transaction rolled back): $error";
485 # now set cust_location.custnum
486 foreach my $l (qw(bill_location ship_location)) {
487 warn " setting $l.custnum\n"
489 my $loc = $self->$l or next;
490 unless ( $loc->custnum ) {
491 $loc->set(custnum => $self->custnum);
492 $error ||= $loc->replace;
496 $dbh->rollback if $oldAutoCommit;
497 return "error setting $l custnum: $error";
501 warn " setting customer tags\n"
504 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
505 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
506 'custnum' => $self->custnum };
507 my $error = $cust_tag->insert;
509 $dbh->rollback if $oldAutoCommit;
514 my $prospectnum = delete $options{'prospectnum'};
515 if ( $prospectnum ) {
517 warn " moving contacts and locations from prospect $prospectnum\n"
521 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
522 unless ( $prospect_main ) {
523 $dbh->rollback if $oldAutoCommit;
524 return "Unknown prospectnum $prospectnum";
526 $prospect_main->custnum($self->custnum);
527 $prospect_main->disabled('Y');
528 my $error = $prospect_main->replace;
530 $dbh->rollback if $oldAutoCommit;
534 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
535 my $cust_contact = new FS::cust_contact {
536 'custnum' => $self->custnum,
537 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
538 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
540 my $error = $cust_contact->insert
541 || $prospect_contact->delete;
543 $dbh->rollback if $oldAutoCommit;
548 my @cust_location = $prospect_main->cust_location;
549 my @qual = $prospect_main->qual;
551 foreach my $r ( @cust_location, @qual ) {
553 $r->custnum($self->custnum);
554 my $error = $r->replace;
556 $dbh->rollback if $oldAutoCommit;
560 # since we set invoice_dest on all migrated prospect contacts (for now),
561 # don't process invoicing_list.
562 delete $options{'invoicing_list'};
563 $invoicing_list = undef;
566 warn " setting contacts\n"
569 $invoicing_list ||= $options{'invoicing_list'};
570 if ( $invoicing_list ) {
572 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
575 foreach my $dest (@$invoicing_list ) {
576 if ($dest eq 'POST') {
577 $self->set('postal_invoice', 'Y');
580 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
581 if ( $contact_email ) {
582 my $cust_contact = FS::cust_contact->new({
583 contactnum => $contact_email->contactnum,
584 custnum => $self->custnum,
586 $cust_contact->set('invoice_dest', 'Y');
587 my $error = $cust_contact->insert;
589 $dbh->rollback if $oldAutoCommit;
590 return "$error (linking to email address $dest)";
594 # this email address is not yet linked to any contact
595 $email .= ',' if length($email);
603 my $contact = FS::contact->new({
604 'custnum' => $self->get('custnum'),
605 'last' => $self->get('last'),
606 'first' => $self->get('first'),
607 'emailaddress' => $email,
608 'invoice_dest' => 'Y', # yes, you can set this via the contact
610 my $error = $contact->insert;
612 $dbh->rollback if $oldAutoCommit;
620 if ( my $contact = delete $options{'contact'} ) {
622 foreach my $c ( @$contact ) {
623 $c->custnum($self->custnum);
624 my $error = $c->insert;
626 $dbh->rollback if $oldAutoCommit;
632 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
634 my $error = $self->process_o2m( 'table' => 'contact',
635 'fields' => FS::contact->cgi_contact_fields,
636 'params' => $contact_params,
639 $dbh->rollback if $oldAutoCommit;
644 warn " setting cust_payby\n"
647 if ( $options{cust_payby} ) {
649 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
650 $cust_payby->custnum($self->custnum);
651 my $error = $cust_payby->insert;
653 $dbh->rollback if $oldAutoCommit;
658 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
660 my $error = $self->process_o2m(
661 'table' => 'cust_payby',
662 'fields' => FS::cust_payby->cgi_cust_payby_fields,
663 'params' => $cust_payby_params,
664 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
667 $dbh->rollback if $oldAutoCommit;
673 warn " setting cust_main_exemption\n"
676 my $tax_exemption = delete $options{'tax_exemption'};
677 if ( $tax_exemption ) {
679 $tax_exemption = { map { $_ => '' } @$tax_exemption }
680 if ref($tax_exemption) eq 'ARRAY';
682 foreach my $taxname ( keys %$tax_exemption ) {
683 my $cust_main_exemption = new FS::cust_main_exemption {
684 'custnum' => $self->custnum,
685 'taxname' => $taxname,
686 'exempt_number' => $tax_exemption->{$taxname},
688 my $error = $cust_main_exemption->insert;
690 $dbh->rollback if $oldAutoCommit;
691 return "inserting cust_main_exemption (transaction rolled back): $error";
696 warn " ordering packages\n"
699 $error = $self->order_pkgs( $cust_pkgs,
701 'seconds_ref' => \$seconds,
702 'upbytes_ref' => \$upbytes,
703 'downbytes_ref' => \$downbytes,
704 'totalbytes_ref' => \$totalbytes,
707 $dbh->rollback if $oldAutoCommit;
712 $dbh->rollback if $oldAutoCommit;
713 return "No svc_acct record to apply pre-paid time";
715 if ( $upbytes || $downbytes || $totalbytes ) {
716 $dbh->rollback if $oldAutoCommit;
717 return "No svc_acct record to apply pre-paid data";
721 warn " inserting initial $payby payment of $amount\n"
723 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
725 $dbh->rollback if $oldAutoCommit;
726 return "inserting payment (transaction rolled back): $error";
730 unless ( $import || $skip_fuzzyfiles ) {
731 warn " queueing fuzzyfiles update\n"
733 $error = $self->queue_fuzzyfiles_update;
735 $dbh->rollback if $oldAutoCommit;
736 return "updating fuzzy search cache: $error";
740 # FS::geocode_Mixin::after_insert or something?
741 if ( $conf->config('tax_district_method') and !$import ) {
742 # if anything non-empty, try to look it up
743 my $queue = new FS::queue {
744 'job' => 'FS::geocode_Mixin::process_district_update',
745 'custnum' => $self->custnum,
747 my $error = $queue->insert( ref($self), $self->custnum );
749 $dbh->rollback if $oldAutoCommit;
750 return "queueing tax district update: $error";
755 warn " exporting\n" if $DEBUG > 1;
757 my $export_args = $options{'export_args'} || [];
760 map qsearch( 'part_export', {exportnum=>$_} ),
761 $conf->config('cust_main-exports'); #, $agentnum
763 foreach my $part_export ( @part_export ) {
764 my $error = $part_export->export_insert($self, @$export_args);
766 $dbh->rollback if $oldAutoCommit;
767 return "exporting to ". $part_export->exporttype.
768 " (transaction rolled back): $error";
772 #foreach my $depend_jobnum ( @$depend_jobnums ) {
773 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
775 # foreach my $jobnum ( @jobnums ) {
776 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
777 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
779 # my $error = $queue->depend_insert($depend_jobnum);
781 # $dbh->rollback if $oldAutoCommit;
782 # return "error queuing job dependancy: $error";
789 #if ( exists $options{'jobnums'} ) {
790 # push @{ $options{'jobnums'} }, @jobnums;
793 warn " insert complete; committing transaction\n"
796 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
801 use File::CounterFile;
802 sub auto_agent_custid {
805 my $format = $conf->config('cust_main-auto_agent_custid');
807 if ( $format eq '1YMMXXXXXXXX' ) {
809 my $counter = new File::CounterFile 'cust_main.agent_custid';
812 my $ym = 100000000000 + time2str('%y%m00000000', time);
813 if ( $ym > $counter->value ) {
814 $counter->{'value'} = $agent_custid = $ym;
815 $counter->{'updated'} = 1;
817 $agent_custid = $counter->inc;
823 die "Unknown cust_main-auto_agent_custid format: $format";
826 $self->agent_custid($agent_custid);
830 =item PACKAGE METHODS
832 Documentation on customer package methods has been moved to
833 L<FS::cust_main::Packages>.
835 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
837 Recharges this (existing) customer with the specified prepaid card (see
838 L<FS::prepay_credit>), specified either by I<identifier> or as an
839 FS::prepay_credit object. If there is an error, returns the error, otherwise
842 Optionally, five scalar references can be passed as well. They will have their
843 values filled in with the amount, number of seconds, and number of upload,
844 download, and total bytes applied by this prepaid card.
848 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
849 #the only place that uses these args
850 sub recharge_prepay {
851 my( $self, $prepay_credit, $amountref, $secondsref,
852 $upbytesref, $downbytesref, $totalbytesref ) = @_;
854 local $SIG{HUP} = 'IGNORE';
855 local $SIG{INT} = 'IGNORE';
856 local $SIG{QUIT} = 'IGNORE';
857 local $SIG{TERM} = 'IGNORE';
858 local $SIG{TSTP} = 'IGNORE';
859 local $SIG{PIPE} = 'IGNORE';
861 my $oldAutoCommit = $FS::UID::AutoCommit;
862 local $FS::UID::AutoCommit = 0;
865 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
867 my $error = $self->get_prepay( $prepay_credit,
868 'amount_ref' => \$amount,
869 'seconds_ref' => \$seconds,
870 'upbytes_ref' => \$upbytes,
871 'downbytes_ref' => \$downbytes,
872 'totalbytes_ref' => \$totalbytes,
874 || $self->increment_seconds($seconds)
875 || $self->increment_upbytes($upbytes)
876 || $self->increment_downbytes($downbytes)
877 || $self->increment_totalbytes($totalbytes)
878 || $self->insert_cust_pay_prepay( $amount,
880 ? $prepay_credit->identifier
885 $dbh->rollback if $oldAutoCommit;
889 if ( defined($amountref) ) { $$amountref = $amount; }
890 if ( defined($secondsref) ) { $$secondsref = $seconds; }
891 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
892 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
893 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
895 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
900 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
902 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
903 specified either by I<identifier> or as an FS::prepay_credit object.
905 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
906 incremented by the values of the prepaid card.
908 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
909 check or set this customer's I<agentnum>.
911 If there is an error, returns the error, otherwise returns false.
917 my( $self, $prepay_credit, %opt ) = @_;
919 local $SIG{HUP} = 'IGNORE';
920 local $SIG{INT} = 'IGNORE';
921 local $SIG{QUIT} = 'IGNORE';
922 local $SIG{TERM} = 'IGNORE';
923 local $SIG{TSTP} = 'IGNORE';
924 local $SIG{PIPE} = 'IGNORE';
926 my $oldAutoCommit = $FS::UID::AutoCommit;
927 local $FS::UID::AutoCommit = 0;
930 unless ( ref($prepay_credit) ) {
932 my $identifier = $prepay_credit;
934 $prepay_credit = qsearchs(
936 { 'identifier' => $identifier },
941 unless ( $prepay_credit ) {
942 $dbh->rollback if $oldAutoCommit;
943 return "Invalid prepaid card: ". $identifier;
948 if ( $prepay_credit->agentnum ) {
949 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
950 $dbh->rollback if $oldAutoCommit;
951 return "prepaid card not valid for agent ". $self->agentnum;
953 $self->agentnum($prepay_credit->agentnum);
956 my $error = $prepay_credit->delete;
958 $dbh->rollback if $oldAutoCommit;
959 return "removing prepay_credit (transaction rolled back): $error";
962 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
963 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
965 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
970 =item increment_upbytes SECONDS
972 Updates this customer's single or primary account (see L<FS::svc_acct>) by
973 the specified number of upbytes. If there is an error, returns the error,
974 otherwise returns false.
978 sub increment_upbytes {
979 _increment_column( shift, 'upbytes', @_);
982 =item increment_downbytes SECONDS
984 Updates this customer's single or primary account (see L<FS::svc_acct>) by
985 the specified number of downbytes. If there is an error, returns the error,
986 otherwise returns false.
990 sub increment_downbytes {
991 _increment_column( shift, 'downbytes', @_);
994 =item increment_totalbytes SECONDS
996 Updates this customer's single or primary account (see L<FS::svc_acct>) by
997 the specified number of totalbytes. If there is an error, returns the error,
998 otherwise returns false.
1002 sub increment_totalbytes {
1003 _increment_column( shift, 'totalbytes', @_);
1006 =item increment_seconds SECONDS
1008 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1009 the specified number of seconds. If there is an error, returns the error,
1010 otherwise returns false.
1014 sub increment_seconds {
1015 _increment_column( shift, 'seconds', @_);
1018 =item _increment_column AMOUNT
1020 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1021 the specified number of seconds or bytes. If there is an error, returns
1022 the error, otherwise returns false.
1026 sub _increment_column {
1027 my( $self, $column, $amount ) = @_;
1028 warn "$me increment_column called: $column, $amount\n"
1031 return '' unless $amount;
1033 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1034 $self->ncancelled_pkgs;
1036 if ( ! @cust_pkg ) {
1037 return 'No packages with primary or single services found'.
1038 ' to apply pre-paid time';
1039 } elsif ( scalar(@cust_pkg) > 1 ) {
1040 #maybe have a way to specify the package/account?
1041 return 'Multiple packages found to apply pre-paid time';
1044 my $cust_pkg = $cust_pkg[0];
1045 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1049 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1051 if ( ! @cust_svc ) {
1052 return 'No account found to apply pre-paid time';
1053 } elsif ( scalar(@cust_svc) > 1 ) {
1054 return 'Multiple accounts found to apply pre-paid time';
1057 my $svc_acct = $cust_svc[0]->svc_x;
1058 warn " found service svcnum ". $svc_acct->pkgnum.
1059 ' ('. $svc_acct->email. ")\n"
1062 $column = "increment_$column";
1063 $svc_acct->$column($amount);
1067 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1069 Inserts a prepayment in the specified amount for this customer. An optional
1070 second argument can specify the prepayment identifier for tracking purposes.
1071 If there is an error, returns the error, otherwise returns false.
1075 sub insert_cust_pay_prepay {
1076 shift->insert_cust_pay('PREP', @_);
1079 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1081 Inserts a cash payment in the specified amount for this customer. An optional
1082 second argument can specify the payment identifier for tracking purposes.
1083 If there is an error, returns the error, otherwise returns false.
1087 sub insert_cust_pay_cash {
1088 shift->insert_cust_pay('CASH', @_);
1091 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1093 Inserts a Western Union payment in the specified amount for this customer. An
1094 optional second argument can specify the prepayment identifier for tracking
1095 purposes. If there is an error, returns the error, otherwise returns false.
1099 sub insert_cust_pay_west {
1100 shift->insert_cust_pay('WEST', @_);
1103 sub insert_cust_pay {
1104 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1105 my $payinfo = scalar(@_) ? shift : '';
1107 my $cust_pay = new FS::cust_pay {
1108 'custnum' => $self->custnum,
1109 'paid' => sprintf('%.2f', $amount),
1110 #'_date' => #date the prepaid card was purchased???
1112 'payinfo' => $payinfo,
1118 =item delete [ OPTION => VALUE ... ]
1120 This deletes the customer. If there is an error, returns the error, otherwise
1123 This will completely remove all traces of the customer record. This is not
1124 what you want when a customer cancels service; for that, cancel all of the
1125 customer's packages (see L</cancel>).
1127 If the customer has any uncancelled packages, you need to pass a new (valid)
1128 customer number for those packages to be transferred to, as the "new_customer"
1129 option. Cancelled packages will be deleted. Did I mention that this is NOT
1130 what you want when a customer cancels service and that you really should be
1131 looking at L<FS::cust_pkg/cancel>?
1133 You can't delete a customer with invoices (see L<FS::cust_bill>),
1134 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1135 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1136 set the "delete_financials" option to a true value.
1141 my( $self, %opt ) = @_;
1143 local $SIG{HUP} = 'IGNORE';
1144 local $SIG{INT} = 'IGNORE';
1145 local $SIG{QUIT} = 'IGNORE';
1146 local $SIG{TERM} = 'IGNORE';
1147 local $SIG{TSTP} = 'IGNORE';
1148 local $SIG{PIPE} = 'IGNORE';
1150 my $oldAutoCommit = $FS::UID::AutoCommit;
1151 local $FS::UID::AutoCommit = 0;
1154 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1155 $dbh->rollback if $oldAutoCommit;
1156 return "Can't delete a master agent customer";
1159 #use FS::access_user
1160 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1161 $dbh->rollback if $oldAutoCommit;
1162 return "Can't delete a master employee customer";
1165 tie my %financial_tables, 'Tie::IxHash',
1166 'cust_bill' => 'invoices',
1167 'cust_statement' => 'statements',
1168 'cust_credit' => 'credits',
1169 'cust_pay' => 'payments',
1170 'cust_refund' => 'refunds',
1173 foreach my $table ( keys %financial_tables ) {
1175 my @records = $self->$table();
1177 if ( @records && ! $opt{'delete_financials'} ) {
1178 $dbh->rollback if $oldAutoCommit;
1179 return "Can't delete a customer with ". $financial_tables{$table};
1182 foreach my $record ( @records ) {
1183 my $error = $record->delete;
1185 $dbh->rollback if $oldAutoCommit;
1186 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1192 my @cust_pkg = $self->ncancelled_pkgs;
1194 my $new_custnum = $opt{'new_custnum'};
1195 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1196 $dbh->rollback if $oldAutoCommit;
1197 return "Invalid new customer number: $new_custnum";
1199 foreach my $cust_pkg ( @cust_pkg ) {
1200 my %hash = $cust_pkg->hash;
1201 $hash{'custnum'} = $new_custnum;
1202 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1203 my $error = $new_cust_pkg->replace($cust_pkg,
1204 options => { $cust_pkg->options },
1207 $dbh->rollback if $oldAutoCommit;
1212 my @cancelled_cust_pkg = $self->all_pkgs;
1213 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1214 my $error = $cust_pkg->delete;
1216 $dbh->rollback if $oldAutoCommit;
1221 #cust_tax_adjustment in financials?
1222 #cust_pay_pending? ouch
1223 foreach my $table (qw(
1224 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1225 cust_payby cust_location cust_main_note cust_tax_adjustment
1226 cust_pay_void cust_pay_batch queue cust_tax_exempt
1228 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1229 my $error = $record->delete;
1231 $dbh->rollback if $oldAutoCommit;
1237 my $sth = $dbh->prepare(
1238 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1240 my $errstr = $dbh->errstr;
1241 $dbh->rollback if $oldAutoCommit;
1244 $sth->execute($self->custnum) or do {
1245 my $errstr = $sth->errstr;
1246 $dbh->rollback if $oldAutoCommit;
1252 my $ticket_dbh = '';
1253 if ($conf->config('ticket_system') eq 'RT_Internal') {
1255 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1256 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1257 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1258 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1261 if ( $ticket_dbh ) {
1263 my $ticket_sth = $ticket_dbh->prepare(
1264 'DELETE FROM Links WHERE Target = ?'
1266 my $errstr = $ticket_dbh->errstr;
1267 $dbh->rollback if $oldAutoCommit;
1270 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1272 my $errstr = $ticket_sth->errstr;
1273 $dbh->rollback if $oldAutoCommit;
1277 #check and see if the customer is the only link on the ticket, and
1278 #if so, set the ticket to deleted status in RT?
1279 #maybe someday, for now this will at least fix tickets not displaying
1283 #delete the customer record
1285 my $error = $self->SUPER::delete;
1287 $dbh->rollback if $oldAutoCommit;
1291 # cust_main exports!
1293 #my $export_args = $options{'export_args'} || [];
1296 map qsearch( 'part_export', {exportnum=>$_} ),
1297 $conf->config('cust_main-exports'); #, $agentnum
1299 foreach my $part_export ( @part_export ) {
1300 my $error = $part_export->export_delete( $self ); #, @$export_args);
1302 $dbh->rollback if $oldAutoCommit;
1303 return "exporting to ". $part_export->exporttype.
1304 " (transaction rolled back): $error";
1308 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1313 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1315 Replaces the OLD_RECORD with this one in the database. If there is an error,
1316 returns the error, otherwise returns false.
1318 To change the customer's address, set the pseudo-fields C<bill_location> and
1319 C<ship_location>. The address will still only change if at least one of the
1320 address fields differs from the existing values.
1322 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1323 set as the contact email address for a default contact with the same name as
1326 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1327 I<contact_params>, I<invoicing_list>.
1329 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1330 of tax names and exemption numbers. FS::cust_main_exemption records will be
1331 deleted and inserted as appropriate.
1333 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1334 groups (describing the customer's payment methods and contacts, respectively)
1335 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1336 and L<FS::contact> for the fields these can contain.
1338 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1339 should be used instead if possible.
1346 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1348 : $self->replace_old;
1352 warn "$me replace called\n"
1355 my $curuser = $FS::CurrentUser::CurrentUser;
1356 return "You are not permitted to create complimentary accounts."
1357 if $self->complimentary eq 'Y'
1358 && $self->complimentary ne $old->complimentary
1359 && ! $curuser->access_right('Complimentary customer');
1361 local($ignore_expired_card) = 1
1362 if $old->payby =~ /^(CARD|DCRD)$/
1363 && $self->payby =~ /^(CARD|DCRD)$/
1364 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1366 local($ignore_banned_card) = 1
1367 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1368 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1369 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1371 if ( $self->payby =~ /^(CARD|DCRD)$/
1372 && $old->payinfo ne $self->payinfo
1373 && $old->paymask ne $self->paymask )
1375 my $error = $self->check_payinfo_cardtype;
1376 return $error if $error;
1379 return "Invoicing locale is required"
1382 && $conf->exists('cust_main-require_locale');
1384 local $SIG{HUP} = 'IGNORE';
1385 local $SIG{INT} = 'IGNORE';
1386 local $SIG{QUIT} = 'IGNORE';
1387 local $SIG{TERM} = 'IGNORE';
1388 local $SIG{TSTP} = 'IGNORE';
1389 local $SIG{PIPE} = 'IGNORE';
1391 my $oldAutoCommit = $FS::UID::AutoCommit;
1392 local $FS::UID::AutoCommit = 0;
1395 for my $l (qw(bill_location ship_location)) {
1396 #my $old_loc = $old->$l;
1397 my $new_loc = $self->$l or next;
1399 # find the existing location if there is one
1400 $new_loc->set('custnum' => $self->custnum);
1401 my $error = $new_loc->find_or_insert;
1403 $dbh->rollback if $oldAutoCommit;
1406 $self->set($l.'num', $new_loc->locationnum);
1410 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1411 warn "cust_main::replace: using deprecated invoicing list argument";
1412 $invoicing_list = shift @param;
1415 my %options = @param;
1417 $invoicing_list ||= $options{invoicing_list};
1419 my @contacts = map { $_->contact } $self->cust_contact;
1420 # find a contact that matches the customer's name
1421 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1422 and $_->last eq $old->get('last') }
1424 $implicit_contact ||= FS::contact->new({
1425 'custnum' => $self->custnum,
1426 'locationnum' => $self->get('bill_locationnum'),
1429 # for any of these that are already contact emails, link to the existing
1431 if ( $invoicing_list ) {
1434 # kind of like process_m2m on these, except:
1435 # - the other side is two tables in a join
1436 # - and we might have to create new contact_emails
1437 # - and possibly a new contact
1439 # Find existing invoice emails that aren't on the implicit contact.
1440 # Any of these that are not on the new invoicing list will be removed.
1441 my %old_email_cust_contact;
1442 foreach my $cust_contact ($self->cust_contact) {
1443 next if !$cust_contact->invoice_dest;
1444 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1446 foreach my $contact_email ($cust_contact->contact->contact_email) {
1447 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1451 foreach my $dest (@$invoicing_list) {
1453 if ($dest eq 'POST') {
1455 $self->set('postal_invoice', 'Y');
1457 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1459 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1463 # See if it belongs to some other contact; if so, link it.
1464 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1466 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1467 my $cust_contact = qsearchs('cust_contact', {
1468 contactnum => $contact_email->contactnum,
1469 custnum => $self->custnum,
1470 }) || FS::cust_contact->new({
1471 contactnum => $contact_email->contactnum,
1472 custnum => $self->custnum,
1474 $cust_contact->set('invoice_dest', 'Y');
1475 my $error = $cust_contact->custcontactnum ?
1476 $cust_contact->replace : $cust_contact->insert;
1478 $dbh->rollback if $oldAutoCommit;
1479 return "$error (linking to email address $dest)";
1483 # This email address is not yet linked to any contact, so it will
1484 # be added to the implicit contact.
1485 $email .= ',' if length($email);
1491 foreach my $remove_dest (keys %old_email_cust_contact) {
1492 my $cust_contact = $old_email_cust_contact{$remove_dest};
1493 # These were not in the list of requested destinations, so take them off.
1494 $cust_contact->set('invoice_dest', '');
1495 my $error = $cust_contact->replace;
1497 $dbh->rollback if $oldAutoCommit;
1498 return "$error (unlinking email address $remove_dest)";
1502 # make sure it keeps up with the changed customer name, if any
1503 $implicit_contact->set('last', $self->get('last'));
1504 $implicit_contact->set('first', $self->get('first'));
1505 $implicit_contact->set('emailaddress', $email);
1506 $implicit_contact->set('invoice_dest', 'Y');
1507 $implicit_contact->set('custnum', $self->custnum);
1510 if ( $implicit_contact->contactnum ) {
1511 $error = $implicit_contact->replace;
1512 } elsif ( length($email) ) { # don't create a new contact if not needed
1513 $error = $implicit_contact->insert;
1517 $dbh->rollback if $oldAutoCommit;
1518 return "$error (adding email address $email)";
1523 # replace the customer record
1524 my $error = $self->SUPER::replace($old);
1527 $dbh->rollback if $oldAutoCommit;
1531 # now move packages to the new service location
1532 $self->set('ship_location', ''); #flush cache
1533 if ( $old->ship_locationnum and # should only be null during upgrade...
1534 $old->ship_locationnum != $self->ship_locationnum ) {
1535 $error = $old->ship_location->move_to($self->ship_location);
1537 $dbh->rollback if $oldAutoCommit;
1541 # don't move packages based on the billing location, but
1542 # disable it if it's no longer in use
1543 if ( $old->bill_locationnum and
1544 $old->bill_locationnum != $self->bill_locationnum ) {
1545 $error = $old->bill_location->disable_if_unused;
1547 $dbh->rollback if $oldAutoCommit;
1552 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1554 #this could be more efficient than deleting and re-inserting, if it matters
1555 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1556 my $error = $cust_tag->delete;
1558 $dbh->rollback if $oldAutoCommit;
1562 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1563 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1564 'custnum' => $self->custnum };
1565 my $error = $cust_tag->insert;
1567 $dbh->rollback if $oldAutoCommit;
1574 my $tax_exemption = delete $options{'tax_exemption'};
1575 if ( $tax_exemption ) {
1577 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1578 if ref($tax_exemption) eq 'ARRAY';
1580 my %cust_main_exemption =
1581 map { $_->taxname => $_ }
1582 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1584 foreach my $taxname ( keys %$tax_exemption ) {
1586 if ( $cust_main_exemption{$taxname} &&
1587 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1590 delete $cust_main_exemption{$taxname};
1594 my $cust_main_exemption = new FS::cust_main_exemption {
1595 'custnum' => $self->custnum,
1596 'taxname' => $taxname,
1597 'exempt_number' => $tax_exemption->{$taxname},
1599 my $error = $cust_main_exemption->insert;
1601 $dbh->rollback if $oldAutoCommit;
1602 return "inserting cust_main_exemption (transaction rolled back): $error";
1606 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1607 my $error = $cust_main_exemption->delete;
1609 $dbh->rollback if $oldAutoCommit;
1610 return "deleting cust_main_exemption (transaction rolled back): $error";
1616 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1618 my $error = $self->process_o2m(
1619 'table' => 'cust_payby',
1620 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1621 'params' => $cust_payby_params,
1622 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1625 $dbh->rollback if $oldAutoCommit;
1631 if ( my $contact_params = delete $options{'contact_params'} ) {
1633 # this can potentially replace contacts that were created by the
1634 # invoicing list argument, but the UI shouldn't allow both of them
1637 my $error = $self->process_o2m(
1638 'table' => 'contact',
1639 'fields' => FS::contact->cgi_contact_fields,
1640 'params' => $contact_params,
1643 $dbh->rollback if $oldAutoCommit;
1649 unless ( $import || $skip_fuzzyfiles ) {
1650 $error = $self->queue_fuzzyfiles_update;
1652 $dbh->rollback if $oldAutoCommit;
1653 return "updating fuzzy search cache: $error";
1657 # tax district update in cust_location
1659 # cust_main exports!
1661 my $export_args = $options{'export_args'} || [];
1664 map qsearch( 'part_export', {exportnum=>$_} ),
1665 $conf->config('cust_main-exports'); #, $agentnum
1667 foreach my $part_export ( @part_export ) {
1668 my $error = $part_export->export_replace( $self, $old, @$export_args);
1670 $dbh->rollback if $oldAutoCommit;
1671 return "exporting to ". $part_export->exporttype.
1672 " (transaction rolled back): $error";
1676 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1681 =item queue_fuzzyfiles_update
1683 Used by insert & replace to update the fuzzy search cache
1687 use FS::cust_main::Search;
1688 sub queue_fuzzyfiles_update {
1691 local $SIG{HUP} = 'IGNORE';
1692 local $SIG{INT} = 'IGNORE';
1693 local $SIG{QUIT} = 'IGNORE';
1694 local $SIG{TERM} = 'IGNORE';
1695 local $SIG{TSTP} = 'IGNORE';
1696 local $SIG{PIPE} = 'IGNORE';
1698 my $oldAutoCommit = $FS::UID::AutoCommit;
1699 local $FS::UID::AutoCommit = 0;
1702 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1703 my $queue = new FS::queue {
1704 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1706 my @args = "cust_main.$field", $self->get($field);
1707 my $error = $queue->insert( @args );
1709 $dbh->rollback if $oldAutoCommit;
1710 return "queueing job (transaction rolled back): $error";
1715 push @locations, $self->bill_location if $self->bill_locationnum;
1716 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1717 foreach my $location (@locations) {
1718 my $queue = new FS::queue {
1719 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1721 my @args = 'cust_location.address1', $location->address1;
1722 my $error = $queue->insert( @args );
1724 $dbh->rollback if $oldAutoCommit;
1725 return "queueing job (transaction rolled back): $error";
1729 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1736 Checks all fields to make sure this is a valid customer record. If there is
1737 an error, returns the error, otherwise returns false. Called by the insert
1738 and replace methods.
1745 warn "$me check BEFORE: \n". $self->_dump
1749 $self->ut_numbern('custnum')
1750 || $self->ut_number('agentnum')
1751 || $self->ut_textn('agent_custid')
1752 || $self->ut_number('refnum')
1753 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1754 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1755 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1756 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1757 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1758 || $self->ut_textn('custbatch')
1759 || $self->ut_name('last')
1760 || $self->ut_name('first')
1761 || $self->ut_snumbern('signupdate')
1762 || $self->ut_snumbern('birthdate')
1763 || $self->ut_namen('spouse_last')
1764 || $self->ut_namen('spouse_first')
1765 || $self->ut_snumbern('spouse_birthdate')
1766 || $self->ut_snumbern('anniversary_date')
1767 || $self->ut_textn('company')
1768 || $self->ut_textn('ship_company')
1769 || $self->ut_anything('comments')
1770 || $self->ut_numbern('referral_custnum')
1771 || $self->ut_textn('stateid')
1772 || $self->ut_textn('stateid_state')
1773 || $self->ut_textn('invoice_terms')
1774 || $self->ut_floatn('cdr_termination_percentage')
1775 || $self->ut_floatn('credit_limit')
1776 || $self->ut_numbern('billday')
1777 || $self->ut_numbern('prorate_day')
1778 || $self->ut_flag('force_prorate_day')
1779 || $self->ut_flag('edit_subject')
1780 || $self->ut_flag('calling_list_exempt')
1781 || $self->ut_flag('invoice_noemail')
1782 || $self->ut_flag('message_noemail')
1783 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1784 || $self->ut_currencyn('currency')
1785 || $self->ut_textn('po_number')
1786 || $self->ut_enum('complimentary', [ '', 'Y' ])
1787 || $self->ut_flag('invoice_ship_address')
1788 || $self->ut_flag('invoice_dest')
1791 foreach (qw(company ship_company)) {
1792 my $company = $self->get($_);
1793 $company =~ s/^\s+//;
1794 $company =~ s/\s+$//;
1795 $company =~ s/\s+/ /g;
1796 $self->set($_, $company);
1799 #barf. need message catalogs. i18n. etc.
1800 $error .= "Please select an advertising source."
1801 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1802 return $error if $error;
1804 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1805 or return "Unknown agent";
1807 if ( $self->currency ) {
1808 my $agent_currency = qsearchs( 'agent_currency', {
1809 'agentnum' => $agent->agentnum,
1810 'currency' => $self->currency,
1812 or return "Agent ". $agent->agent.
1813 " not permitted to offer ". $self->currency. " invoicing";
1816 return "Unknown refnum"
1817 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1819 return "Unknown referring custnum: ". $self->referral_custnum
1820 unless ! $self->referral_custnum
1821 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1823 if ( $self->ss eq '' ) {
1828 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1829 or return "Illegal social security number: ". $self->ss;
1830 $self->ss("$1-$2-$3");
1833 #turn off invoice_ship_address if ship & bill are the same
1834 if ($self->bill_locationnum eq $self->ship_locationnum) {
1835 $self->invoice_ship_address('');
1838 # cust_main_county verification now handled by cust_location check
1841 $self->ut_phonen('daytime', $self->country)
1842 || $self->ut_phonen('night', $self->country)
1843 || $self->ut_phonen('fax', $self->country)
1844 || $self->ut_phonen('mobile', $self->country)
1846 return $error if $error;
1848 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1850 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1853 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1855 : FS::Msgcat::_gettext('daytime');
1856 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1858 : FS::Msgcat::_gettext('night');
1860 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1862 : FS::Msgcat::_gettext('mobile');
1864 return "$daytime_label, $night_label or $mobile_label is required"
1868 ### start of stuff moved to cust_payby
1869 # then mostly kept here to support upgrades (can remove in 5.x)
1870 # but modified to allow everything to be empty
1872 if ( $self->payby ) {
1873 FS::payby->can_payby($self->table, $self->payby)
1874 or return "Illegal payby: ". $self->payby;
1879 $error = $self->ut_numbern('paystart_month')
1880 || $self->ut_numbern('paystart_year')
1881 || $self->ut_numbern('payissue')
1882 || $self->ut_textn('paytype')
1884 return $error if $error;
1886 if ( $self->payip eq '' ) {
1889 $error = $self->ut_ip('payip');
1890 return $error if $error;
1893 # If it is encrypted and the private key is not availaible then we can't
1894 # check the credit card.
1895 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1897 # Need some kind of global flag to accept invalid cards, for testing
1899 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1900 $self->payby =~ /^(CARD|DCRD)$/ ) {
1902 my $payinfo = $self->payinfo;
1903 $payinfo =~ s/\D//g;
1904 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1905 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1907 $self->payinfo($payinfo);
1909 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1911 return gettext('unknown_card_type')
1912 if $self->payinfo !~ /^99\d{14}$/ #token
1913 && cardtype($self->payinfo) eq "Unknown";
1915 unless ( $ignore_banned_card ) {
1916 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1918 if ( $ban->bantype eq 'warn' ) {
1919 #or others depending on value of $ban->reason ?
1920 return '_duplicate_card'.
1921 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1922 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1923 ' (ban# '. $ban->bannum. ')'
1924 unless $self->override_ban_warn;
1926 return 'Banned credit card: banned on '.
1927 time2str('%a %h %o at %r', $ban->_date).
1928 ' by '. $ban->otaker.
1929 ' (ban# '. $ban->bannum. ')';
1934 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1935 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1936 $self->paycvv =~ /^(\d{4})$/
1937 or return "CVV2 (CID) for American Express cards is four digits.";
1940 $self->paycvv =~ /^(\d{3})$/
1941 or return "CVV2 (CVC2/CID) is three digits.";
1948 my $cardtype = cardtype($payinfo);
1949 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1951 return "Start date or issue number is required for $cardtype cards"
1952 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1954 return "Start month must be between 1 and 12"
1955 if $self->paystart_month
1956 and $self->paystart_month < 1 || $self->paystart_month > 12;
1958 return "Start year must be 1990 or later"
1959 if $self->paystart_year
1960 and $self->paystart_year < 1990;
1962 return "Issue number must be beween 1 and 99"
1964 and $self->payissue < 1 || $self->payissue > 99;
1967 $self->paystart_month('');
1968 $self->paystart_year('');
1969 $self->payissue('');
1972 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1973 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1975 my $payinfo = $self->payinfo;
1976 $payinfo =~ s/[^\d\@\.]//g;
1977 if ( $conf->config('echeck-country') eq 'CA' ) {
1978 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1979 or return 'invalid echeck account@branch.bank';
1980 $payinfo = "$1\@$2.$3";
1981 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1982 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1983 $payinfo = "$1\@$2";
1985 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1986 $payinfo = "$1\@$2";
1988 $self->payinfo($payinfo);
1991 unless ( $ignore_banned_card ) {
1992 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1994 if ( $ban->bantype eq 'warn' ) {
1995 #or others depending on value of $ban->reason ?
1996 return '_duplicate_ach' unless $self->override_ban_warn;
1998 return 'Banned ACH account: banned on '.
1999 time2str('%a %h %o at %r', $ban->_date).
2000 ' by '. $ban->otaker.
2001 ' (ban# '. $ban->bannum. ')';
2006 } elsif ( $self->payby eq 'LECB' ) {
2008 my $payinfo = $self->payinfo;
2009 $payinfo =~ s/\D//g;
2010 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2012 $self->payinfo($payinfo);
2015 } elsif ( $self->payby eq 'BILL' ) {
2017 $error = $self->ut_textn('payinfo');
2018 return "Illegal P.O. number: ". $self->payinfo if $error;
2021 } elsif ( $self->payby eq 'COMP' ) {
2023 my $curuser = $FS::CurrentUser::CurrentUser;
2024 if ( ! $self->custnum
2025 && ! $curuser->access_right('Complimentary customer')
2028 return "You are not permitted to create complimentary accounts."
2031 $error = $self->ut_textn('payinfo');
2032 return "Illegal comp account issuer: ". $self->payinfo if $error;
2035 } elsif ( $self->payby eq 'PREPAY' ) {
2037 my $payinfo = $self->payinfo;
2038 $payinfo =~ s/\W//g; #anything else would just confuse things
2039 $self->payinfo($payinfo);
2040 $error = $self->ut_alpha('payinfo');
2041 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2042 return "Unknown prepayment identifier"
2043 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2048 return "You are not permitted to create complimentary accounts."
2050 && $self->complimentary eq 'Y'
2051 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2053 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2054 return "Expiration date required"
2055 # shouldn't payinfo_check do this?
2056 unless ! $self->payby
2057 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2061 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2062 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2063 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2064 ( $m, $y ) = ( $2, "19$1" );
2065 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2066 ( $m, $y ) = ( $3, "20$2" );
2068 return "Illegal expiration date: ". $self->paydate;
2070 $m = sprintf('%02d',$m);
2071 $self->paydate("$y-$m-01");
2072 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2073 return gettext('expired_card')
2075 && !$ignore_expired_card
2076 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2079 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2080 ( ! $conf->exists('require_cardname')
2081 || $self->payby !~ /^(CARD|DCRD)$/ )
2083 $self->payname( $self->first. " ". $self->getfield('last') );
2086 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2087 $self->payname =~ /^([\w \,\.\-\']*)$/
2088 or return gettext('illegal_name'). " payname: ". $self->payname;
2091 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2092 or return gettext('illegal_name'). " payname: ". $self->payname;
2098 ### end of stuff moved to cust_payby
2100 return "Please select an invoicing locale"
2103 && $conf->exists('cust_main-require_locale');
2105 return "Please select a customer class"
2106 if ! $self->classnum
2107 && $conf->exists('cust_main-require_classnum');
2109 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2110 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2114 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2116 warn "$me check AFTER: \n". $self->_dump
2119 $self->SUPER::check;
2122 sub check_payinfo_cardtype {
2125 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2127 my $payinfo = $self->payinfo;
2128 $payinfo =~ s/\D//g;
2130 return '' if $payinfo =~ /^99\d{14}$/; #token
2132 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2133 my $cardtype = cardtype($payinfo);
2135 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2143 Additional checks for replace only.
2148 my ($new,$old) = @_;
2149 #preserve old value if global config is set
2150 if ($old && $conf->exists('invoice-ship_address')) {
2151 $new->invoice_ship_address($old->invoice_ship_address);
2158 Returns a list of fields which have ship_ duplicates.
2163 qw( last first company
2165 address1 address2 city county state zip country
2167 daytime night fax mobile
2171 =item has_ship_address
2173 Returns true if this customer record has a separate shipping address.
2177 sub has_ship_address {
2179 $self->bill_locationnum != $self->ship_locationnum;
2184 Returns a list of key/value pairs, with the following keys: address1,
2185 adddress2, city, county, state, zip, country, district, and geocode. The
2186 shipping address is used if present.
2192 $self->ship_location->location_hash;
2197 Returns all locations (see L<FS::cust_location>) for this customer.
2204 'table' => 'cust_location',
2205 'hashref' => { 'custnum' => $self->custnum,
2206 'prospectnum' => '',
2208 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2214 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2220 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2223 =item cust_payby PAYBY
2225 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2227 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2228 Does not validate PAYBY.
2236 'table' => 'cust_payby',
2237 'hashref' => { 'custnum' => $self->custnum },
2238 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2240 $search->{'extra_sql'} = ' AND payby IN ( '.
2241 join(',', map dbh->quote($_), @payby).
2248 =item has_cust_payby_auto
2250 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2254 sub has_cust_payby_auto {
2257 'table' => 'cust_payby',
2258 'hashref' => { 'custnum' => $self->custnum, },
2259 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2260 'order_by' => 'LIMIT 1',
2267 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2268 and L<FS::cust_pkg>) for this customer, except those on hold.
2270 Returns a list: an empty list on success or a list of errors.
2276 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2281 Unsuspends all suspended packages in the on-hold state (those without setup
2282 dates) for this customer.
2288 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2293 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2295 Returns a list: an empty list on success or a list of errors.
2301 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2304 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2306 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2307 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2308 of a list of pkgparts; the hashref has the following keys:
2312 =item pkgparts - listref of pkgparts
2314 =item (other options are passed to the suspend method)
2319 Returns a list: an empty list on success or a list of errors.
2323 sub suspend_if_pkgpart {
2325 my (@pkgparts, %opt);
2326 if (ref($_[0]) eq 'HASH'){
2327 @pkgparts = @{$_[0]{pkgparts}};
2332 grep { $_->suspend(%opt) }
2333 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2334 $self->unsuspended_pkgs;
2337 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2339 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2340 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2341 instead of a list of pkgparts; the hashref has the following keys:
2345 =item pkgparts - listref of pkgparts
2347 =item (other options are passed to the suspend method)
2351 Returns a list: an empty list on success or a list of errors.
2355 sub suspend_unless_pkgpart {
2357 my (@pkgparts, %opt);
2358 if (ref($_[0]) eq 'HASH'){
2359 @pkgparts = @{$_[0]{pkgparts}};
2364 grep { $_->suspend(%opt) }
2365 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2366 $self->unsuspended_pkgs;
2369 =item cancel [ OPTION => VALUE ... ]
2371 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2372 The cancellation time will be now.
2376 Always returns a list: an empty list on success or a list of errors.
2383 warn "$me cancel called on customer ". $self->custnum. " with options ".
2384 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2386 my @pkgs = $self->ncancelled_pkgs;
2388 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2391 =item cancel_pkgs OPTIONS
2393 Cancels a specified list of packages. OPTIONS can include:
2397 =item cust_pkg - an arrayref of the packages. Required.
2399 =item time - the cancellation time, used to calculate final bills and
2400 unused-time credits if any. Will be passed through to the bill() and
2401 FS::cust_pkg::cancel() methods.
2403 =item quiet - can be set true to supress email cancellation notices.
2405 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2406 reasonnum of an existing reason, or passing a hashref will create a new reason.
2407 The hashref should have the following keys:
2408 typenum - Reason type (see L<FS::reason_type>)
2409 reason - Text of the new reason.
2411 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2412 for the individual packages, parallel to the C<cust_pkg> argument. The
2413 reason and reason_otaker arguments will be taken from those objects.
2415 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2417 =item nobill - can be set true to skip billing if it might otherwise be done.
2422 my( $self, %opt ) = @_;
2424 # we're going to cancel services, which is not reversible
2425 die "cancel_pkgs cannot be run inside a transaction"
2426 if $FS::UID::AutoCommit == 0;
2428 local $FS::UID::AutoCommit = 0;
2430 return ( 'access denied' )
2431 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2433 if ( $opt{'ban'} ) {
2435 foreach my $cust_payby ( $self->cust_payby ) {
2437 #well, if they didn't get decrypted on search, then we don't have to
2438 # try again... queue a job for the server that does have decryption
2439 # capability if we're in a paranoid multi-server implementation?
2440 return ( "Can't (yet) ban encrypted credit cards" )
2441 if $cust_payby->is_encrypted($cust_payby->payinfo);
2443 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2444 my $error = $ban->insert;
2454 my @pkgs = @{ delete $opt{'cust_pkg'} };
2455 my $cancel_time = $opt{'time'} || time;
2457 # bill all packages first, so we don't lose usage, service counts for
2458 # bulk billing, etc.
2459 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2461 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2463 'time' => $cancel_time );
2465 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2467 return ( "Error billing during cancellation: $error" );
2472 $FS::UID::AutoCommit = 1;
2474 # now cancel all services, the same way we would for individual packages.
2475 # if any of them fail, cancel the rest anyway.
2476 my @cust_svc = map { $_->cust_svc } @pkgs;
2477 my @sorted_cust_svc =
2479 sort { $a->[1] <=> $b->[1] }
2480 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2482 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2485 foreach my $cust_svc (@sorted_cust_svc) {
2486 my $part_svc = $cust_svc->part_svc;
2487 next if ( defined($part_svc) and $part_svc->preserve );
2488 my $error = $cust_svc->cancel; # immediate cancel, no date option
2489 push @errors, $error if $error;
2495 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2496 $self->custnum. "\n"
2500 if ($opt{'cust_pkg_reason'}) {
2501 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2507 my $cpr = shift @cprs;
2509 $lopt{'reason'} = $cpr->reasonnum;
2510 $lopt{'reason_otaker'} = $cpr->otaker;
2512 warn "no reason found when canceling package ".$_->pkgnum."\n";
2513 # we're not actually required to pass a reason to cust_pkg::cancel,
2514 # but if we're getting to this point, something has gone awry.
2515 $null_reason ||= FS::reason->new_or_existing(
2516 reason => 'unknown reason',
2517 type => 'Cancel Reason',
2520 $lopt{'reason'} = $null_reason->reasonnum;
2521 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2524 my $error = $_->cancel(%lopt);
2525 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2531 sub _banned_pay_hashref {
2542 'payby' => $payby2ban{$self->payby},
2543 'payinfo' => $self->payinfo,
2544 #don't ever *search* on reason! #'reason' =>
2550 Returns all notes (see L<FS::cust_main_note>) for this customer.
2555 my($self,$orderby_classnum) = (shift,shift);
2556 my $orderby = "sticky DESC, _date DESC";
2557 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2558 qsearch( 'cust_main_note',
2559 { 'custnum' => $self->custnum },
2561 "ORDER BY $orderby",
2567 Returns the agent (see L<FS::agent>) for this customer.
2571 Returns the agent name (see L<FS::agent>) for this customer.
2577 $self->agent->agent;
2582 Returns any tags associated with this customer, as FS::cust_tag objects,
2583 or an empty list if there are no tags.
2587 Returns any tags associated with this customer, as FS::part_tag objects,
2588 or an empty list if there are no tags.
2594 map $_->part_tag, $self->cust_tag;
2600 Returns the customer class, as an FS::cust_class object, or the empty string
2601 if there is no customer class.
2605 Returns the customer category name, or the empty string if there is no customer
2612 my $cust_class = $self->cust_class;
2614 ? $cust_class->categoryname
2620 Returns the customer class name, or the empty string if there is no customer
2627 my $cust_class = $self->cust_class;
2629 ? $cust_class->classname
2635 Returns the external tax status, as an FS::tax_status object, or the empty
2636 string if there is no tax status.
2642 if ( $self->taxstatusnum ) {
2643 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2651 Returns the tax status code if there is one.
2657 my $tax_status = $self->tax_status;
2659 ? $tax_status->taxstatus
2663 =item BILLING METHODS
2665 Documentation on billing methods has been moved to
2666 L<FS::cust_main::Billing>.
2668 =item REALTIME BILLING METHODS
2670 Documentation on realtime billing methods has been moved to
2671 L<FS::cust_main::Billing_Realtime>.
2675 Removes the I<paycvv> field from the database directly.
2677 If there is an error, returns the error, otherwise returns false.
2679 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2685 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2686 or return dbh->errstr;
2687 $sth->execute($self->custnum)
2688 or return $sth->errstr;
2695 Returns the total owed for this customer on all invoices
2696 (see L<FS::cust_bill/owed>).
2702 $self->total_owed_date(2145859200); #12/31/2037
2705 =item total_owed_date TIME
2707 Returns the total owed for this customer on all invoices with date earlier than
2708 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2709 see L<Time::Local> and L<Date::Parse> for conversion functions.
2713 sub total_owed_date {
2717 my $custnum = $self->custnum;
2719 my $owed_sql = FS::cust_bill->owed_sql;
2722 SELECT SUM($owed_sql) FROM cust_bill
2723 WHERE custnum = $custnum
2727 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2731 =item total_owed_pkgnum PKGNUM
2733 Returns the total owed on all invoices for this customer's specific package
2734 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2738 sub total_owed_pkgnum {
2739 my( $self, $pkgnum ) = @_;
2740 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2743 =item total_owed_date_pkgnum TIME PKGNUM
2745 Returns the total owed for this customer's specific package when using
2746 experimental package balances on all invoices with date earlier than
2747 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2748 see L<Time::Local> and L<Date::Parse> for conversion functions.
2752 sub total_owed_date_pkgnum {
2753 my( $self, $time, $pkgnum ) = @_;
2756 foreach my $cust_bill (
2757 grep { $_->_date <= $time }
2758 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2760 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2762 sprintf( "%.2f", $total_bill );
2768 Returns the total amount of all payments.
2775 $total += $_->paid foreach $self->cust_pay;
2776 sprintf( "%.2f", $total );
2779 =item total_unapplied_credits
2781 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2782 customer. See L<FS::cust_credit/credited>.
2784 =item total_credited
2786 Old name for total_unapplied_credits. Don't use.
2790 sub total_credited {
2791 #carp "total_credited deprecated, use total_unapplied_credits";
2792 shift->total_unapplied_credits(@_);
2795 sub total_unapplied_credits {
2798 my $custnum = $self->custnum;
2800 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2803 SELECT SUM($unapplied_sql) FROM cust_credit
2804 WHERE custnum = $custnum
2807 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2811 =item total_unapplied_credits_pkgnum PKGNUM
2813 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2814 customer. See L<FS::cust_credit/credited>.
2818 sub total_unapplied_credits_pkgnum {
2819 my( $self, $pkgnum ) = @_;
2820 my $total_credit = 0;
2821 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2822 sprintf( "%.2f", $total_credit );
2826 =item total_unapplied_payments
2828 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2829 See L<FS::cust_pay/unapplied>.
2833 sub total_unapplied_payments {
2836 my $custnum = $self->custnum;
2838 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2841 SELECT SUM($unapplied_sql) FROM cust_pay
2842 WHERE custnum = $custnum
2845 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2849 =item total_unapplied_payments_pkgnum PKGNUM
2851 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2852 specific package when using experimental package balances. See
2853 L<FS::cust_pay/unapplied>.
2857 sub total_unapplied_payments_pkgnum {
2858 my( $self, $pkgnum ) = @_;
2859 my $total_unapplied = 0;
2860 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2861 sprintf( "%.2f", $total_unapplied );
2865 =item total_unapplied_refunds
2867 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2868 customer. See L<FS::cust_refund/unapplied>.
2872 sub total_unapplied_refunds {
2874 my $custnum = $self->custnum;
2876 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2879 SELECT SUM($unapplied_sql) FROM cust_refund
2880 WHERE custnum = $custnum
2883 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2889 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2890 total_unapplied_credits minus total_unapplied_payments).
2896 $self->balance_date_range;
2899 =item balance_date TIME
2901 Returns the balance for this customer, only considering invoices with date
2902 earlier than TIME (total_owed_date minus total_credited minus
2903 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2904 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2911 $self->balance_date_range(shift);
2914 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2916 Returns the balance for this customer, optionally considering invoices with
2917 date earlier than START_TIME, and not later than END_TIME
2918 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2920 Times are specified as SQL fragments or numeric
2921 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2922 L<Date::Parse> for conversion functions. The empty string can be passed
2923 to disable that time constraint completely.
2925 Accepts the same options as L<balance_date_sql>:
2929 =item unapplied_date
2931 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)
2935 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2936 time will be ignored. Note that START_TIME and END_TIME only limit the date
2937 range for invoices and I<unapplied> payments, credits, and refunds.
2943 sub balance_date_range {
2945 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2946 ') FROM cust_main WHERE custnum='. $self->custnum;
2947 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2950 =item balance_pkgnum PKGNUM
2952 Returns the balance for this customer's specific package when using
2953 experimental package balances (total_owed plus total_unrefunded, minus
2954 total_unapplied_credits minus total_unapplied_payments)
2958 sub balance_pkgnum {
2959 my( $self, $pkgnum ) = @_;
2962 $self->total_owed_pkgnum($pkgnum)
2963 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2964 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2965 - $self->total_unapplied_credits_pkgnum($pkgnum)
2966 - $self->total_unapplied_payments_pkgnum($pkgnum)
2972 Returns a hash of useful information for making a payment.
2982 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2983 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2984 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2988 For credit card transactions:
3000 For electronic check transactions:
3015 $return{balance} = $self->balance;
3017 $return{payname} = $self->payname
3018 || ( $self->first. ' '. $self->get('last') );
3020 $return{$_} = $self->bill_location->$_
3021 for qw(address1 address2 city state zip);
3023 $return{payby} = $self->payby;
3024 $return{stateid_state} = $self->stateid_state;
3026 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3027 $return{card_type} = cardtype($self->payinfo);
3028 $return{payinfo} = $self->paymask;
3030 @return{'month', 'year'} = $self->paydate_monthyear;
3034 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3035 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3036 $return{payinfo1} = $payinfo1;
3037 $return{payinfo2} = $payinfo2;
3038 $return{paytype} = $self->paytype;
3039 $return{paystate} = $self->paystate;
3043 #doubleclick protection
3045 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3053 Returns the next payment expiration date for this customer. If they have no
3054 payment methods that will expire, returns 0.
3060 # filter out the ones that individually return 0, but then return 0 if
3061 # there are no results
3062 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3063 min( @epochs ) || 0;
3066 =item paydate_epoch_sql
3068 Returns an SQL expression to get the next payment expiration date for a
3069 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3070 dates, so that it's safe to test for "will it expire before date X" for any
3075 sub paydate_epoch_sql {
3077 my $paydate = FS::cust_payby->paydate_epoch_sql;
3078 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3082 my( $self, $taxname ) = @_;
3084 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3085 'taxname' => $taxname,
3090 =item cust_main_exemption
3092 =item invoicing_list
3094 Returns a list of email addresses (with svcnum entries expanded), and the word
3095 'POST' if the customer receives postal invoices.
3099 sub invoicing_list {
3100 my( $self, $arrayref ) = @_;
3103 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3106 my @emails = $self->invoicing_list_emailonly;
3107 push @emails, 'POST' if $self->get('postal_invoice');
3112 =item check_invoicing_list ARRAYREF
3114 Checks these arguements as valid input for the invoicing_list method. If there
3115 is an error, returns the error, otherwise returns false.
3119 sub check_invoicing_list {
3120 my( $self, $arrayref ) = @_;
3122 foreach my $address ( @$arrayref ) {
3124 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3125 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3128 my $cust_main_invoice = new FS::cust_main_invoice ( {
3129 'custnum' => $self->custnum,
3132 my $error = $self->custnum
3133 ? $cust_main_invoice->check
3134 : $cust_main_invoice->checkdest
3136 return $error if $error;
3140 return "Email address required"
3141 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3142 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3149 Returns the email addresses of all accounts provisioned for this customer.
3156 foreach my $cust_pkg ( $self->all_pkgs ) {
3157 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3159 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3160 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3162 $list{$_}=1 foreach map { $_->email } @svc_acct;
3167 =item invoicing_list_addpost
3169 Adds postal invoicing to this customer. If this customer is already configured
3170 to receive postal invoices, does nothing.
3174 sub invoicing_list_addpost {
3176 if ( $self->get('postal_invoice') eq '' ) {
3177 $self->set('postal_invoice', 'Y');
3178 my $error = $self->replace;
3179 warn $error if $error; # should fail harder, but this is traditional
3183 =item invoicing_list_emailonly
3185 Returns the list of email invoice recipients (invoicing_list without non-email
3186 destinations such as POST and FAX).
3190 sub invoicing_list_emailonly {
3192 warn "$me invoicing_list_emailonly called"
3194 return () if !$self->custnum; # not yet inserted
3195 return map { $_->emailaddress }
3197 table => 'cust_contact',
3198 select => 'emailaddress',
3199 addl_from => ' JOIN contact USING (contactnum) '.
3200 ' JOIN contact_email USING (contactnum)',
3201 hashref => { 'custnum' => $self->custnum, },
3202 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3206 =item invoicing_list_emailonly_scalar
3208 Returns the list of email invoice recipients (invoicing_list without non-email
3209 destinations such as POST and FAX) as a comma-separated scalar.
3213 sub invoicing_list_emailonly_scalar {
3215 warn "$me invoicing_list_emailonly_scalar called"
3217 join(', ', $self->invoicing_list_emailonly);
3220 =item contact_list [ CLASSNUM, ... ]
3222 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3223 a list of contact classnums is given, returns only contacts in those
3224 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3225 are marked as invoice destinations. If '0' is given, also returns contacts
3228 If no arguments are given, returns all contacts for the customer.
3236 select => 'contact.*, cust_contact.invoice_dest',
3237 addl_from => ' JOIN cust_contact USING (contactnum)',
3238 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3244 if ( $_ eq 'invoice' ) {
3245 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3246 } elsif ( $_ eq '0' ) {
3247 push @orwhere, 'cust_contact.classnum is null';
3248 } elsif ( /^\d+$/ ) {
3249 push @classnums, $_;
3251 die "bad classnum argument '$_'";
3256 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3259 $search->{extra_sql} .= ' AND (' .
3260 join(' OR ', map "( $_ )", @orwhere) .
3267 =item contact_list_email [ CLASSNUM, ... ]
3269 Same as L</contact_list>, but returns email destinations instead of contact
3274 sub contact_list_email {
3276 my @contacts = $self->contact_list(@_);
3278 foreach my $contact (@contacts) {
3279 foreach my $contact_email ($contact->contact_email) {
3281 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3287 =item referral_custnum_cust_main
3289 Returns the customer who referred this customer (or the empty string, if
3290 this customer was not referred).
3292 Note the difference with referral_cust_main method: This method,
3293 referral_custnum_cust_main returns the single customer (if any) who referred
3294 this customer, while referral_cust_main returns an array of customers referred
3299 sub referral_custnum_cust_main {
3301 return '' unless $self->referral_custnum;
3302 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3305 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3307 Returns an array of customers referred by this customer (referral_custnum set
3308 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3309 customers referred by customers referred by this customer and so on, inclusive.
3310 The default behavior is DEPTH 1 (no recursion).
3312 Note the difference with referral_custnum_cust_main method: This method,
3313 referral_cust_main, returns an array of customers referred BY this customer,
3314 while referral_custnum_cust_main returns the single customer (if any) who
3315 referred this customer.
3319 sub referral_cust_main {
3321 my $depth = @_ ? shift : 1;
3322 my $exclude = @_ ? shift : {};
3325 map { $exclude->{$_->custnum}++; $_; }
3326 grep { ! $exclude->{ $_->custnum } }
3327 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3331 map { $_->referral_cust_main($depth-1, $exclude) }
3338 =item referral_cust_main_ncancelled
3340 Same as referral_cust_main, except only returns customers with uncancelled
3345 sub referral_cust_main_ncancelled {
3347 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3350 =item referral_cust_pkg [ DEPTH ]
3352 Like referral_cust_main, except returns a flat list of all unsuspended (and
3353 uncancelled) packages for each customer. The number of items in this list may
3354 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3358 sub referral_cust_pkg {
3360 my $depth = @_ ? shift : 1;
3362 map { $_->unsuspended_pkgs }
3363 grep { $_->unsuspended_pkgs }
3364 $self->referral_cust_main($depth);
3367 =item referring_cust_main
3369 Returns the single cust_main record for the customer who referred this customer
3370 (referral_custnum), or false.
3374 sub referring_cust_main {
3376 return '' unless $self->referral_custnum;
3377 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3380 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3382 Applies a credit to this customer. If there is an error, returns the error,
3383 otherwise returns false.
3385 REASON can be a text string, an FS::reason object, or a scalar reference to
3386 a reasonnum. If a text string, it will be automatically inserted as a new
3387 reason, and a 'reason_type' option must be passed to indicate the
3388 FS::reason_type for the new reason.
3390 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3391 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3392 I<commission_pkgnum>.
3394 Any other options are passed to FS::cust_credit::insert.
3399 my( $self, $amount, $reason, %options ) = @_;
3401 my $cust_credit = new FS::cust_credit {
3402 'custnum' => $self->custnum,
3403 'amount' => $amount,
3406 if ( ref($reason) ) {
3408 if ( ref($reason) eq 'SCALAR' ) {
3409 $cust_credit->reasonnum( $$reason );
3411 $cust_credit->reasonnum( $reason->reasonnum );
3415 $cust_credit->set('reason', $reason)
3418 $cust_credit->$_( delete $options{$_} )
3419 foreach grep exists($options{$_}),
3420 qw( addlinfo eventnum ),
3421 map "commission_$_", qw( agentnum salesnum pkgnum );
3423 $cust_credit->insert(%options);
3427 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3429 Creates a one-time charge for this customer. If there is an error, returns
3430 the error, otherwise returns false.
3432 New-style, with a hashref of options:
3434 my $error = $cust_main->charge(
3438 'start_date' => str2time('7/4/2009'),
3439 'pkg' => 'Description',
3440 'comment' => 'Comment',
3441 'additional' => [], #extra invoice detail
3442 'classnum' => 1, #pkg_class
3444 'setuptax' => '', # or 'Y' for tax exempt
3446 'locationnum'=> 1234, # optional
3449 'taxclass' => 'Tax class',
3452 'taxproduct' => 2, #part_pkg_taxproduct
3453 'override' => {}, #XXX describe
3455 #will be filled in with the new object
3456 'cust_pkg_ref' => \$cust_pkg,
3458 #generate an invoice immediately
3460 'invoice_terms' => '', #with these terms
3466 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3470 #super false laziness w/quotation::charge
3473 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3474 my ( $pkg, $comment, $additional );
3475 my ( $setuptax, $taxclass ); #internal taxes
3476 my ( $taxproduct, $override ); #vendor (CCH) taxes
3478 my $separate_bill = '';
3479 my $cust_pkg_ref = '';
3480 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3482 if ( ref( $_[0] ) ) {
3483 $amount = $_[0]->{amount};
3484 $setup_cost = $_[0]->{setup_cost};
3485 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3486 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3487 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3488 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3489 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3490 : '$'. sprintf("%.2f",$amount);
3491 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3492 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3493 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3494 $additional = $_[0]->{additional} || [];
3495 $taxproduct = $_[0]->{taxproductnum};
3496 $override = { '' => $_[0]->{tax_override} };
3497 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3498 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3499 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3500 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3501 $separate_bill = $_[0]->{separate_bill} || '';
3507 $pkg = @_ ? shift : 'One-time charge';
3508 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3510 $taxclass = @_ ? shift : '';
3514 local $SIG{HUP} = 'IGNORE';
3515 local $SIG{INT} = 'IGNORE';
3516 local $SIG{QUIT} = 'IGNORE';
3517 local $SIG{TERM} = 'IGNORE';
3518 local $SIG{TSTP} = 'IGNORE';
3519 local $SIG{PIPE} = 'IGNORE';
3521 my $oldAutoCommit = $FS::UID::AutoCommit;
3522 local $FS::UID::AutoCommit = 0;
3525 my $part_pkg = new FS::part_pkg ( {
3527 'comment' => $comment,
3531 'classnum' => ( $classnum ? $classnum : '' ),
3532 'setuptax' => $setuptax,
3533 'taxclass' => $taxclass,
3534 'taxproductnum' => $taxproduct,
3535 'setup_cost' => $setup_cost,
3538 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3539 ( 0 .. @$additional - 1 )
3541 'additional_count' => scalar(@$additional),
3542 'setup_fee' => $amount,
3545 my $error = $part_pkg->insert( options => \%options,
3546 tax_overrides => $override,
3549 $dbh->rollback if $oldAutoCommit;
3553 my $pkgpart = $part_pkg->pkgpart;
3554 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3555 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3556 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3557 $error = $type_pkgs->insert;
3559 $dbh->rollback if $oldAutoCommit;
3564 my $cust_pkg = new FS::cust_pkg ( {
3565 'custnum' => $self->custnum,
3566 'pkgpart' => $pkgpart,
3567 'quantity' => $quantity,
3568 'start_date' => $start_date,
3569 'no_auto' => $no_auto,
3570 'separate_bill' => $separate_bill,
3571 'locationnum'=> $locationnum,
3574 $error = $cust_pkg->insert;
3576 $dbh->rollback if $oldAutoCommit;
3578 } elsif ( $cust_pkg_ref ) {
3579 ${$cust_pkg_ref} = $cust_pkg;
3583 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3584 'pkg_list' => [ $cust_pkg ],
3587 $dbh->rollback if $oldAutoCommit;
3592 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3597 #=item charge_postal_fee
3599 #Applies a one time charge this customer. If there is an error,
3600 #returns the error, returns the cust_pkg charge object or false
3601 #if there was no charge.
3605 # This should be a customer event. For that to work requires that bill
3606 # also be a customer event.
3608 sub charge_postal_fee {
3611 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3612 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3614 my $cust_pkg = new FS::cust_pkg ( {
3615 'custnum' => $self->custnum,
3616 'pkgpart' => $pkgpart,
3620 my $error = $cust_pkg->insert;
3621 $error ? $error : $cust_pkg;
3624 =item num_cust_attachment_deleted
3626 Returns the number of deleted attachments for this customer (see
3627 L<FS::num_cust_attachment>).
3631 sub num_cust_attachments_deleted {
3634 " SELECT COUNT(*) FROM cust_attachment ".
3635 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3640 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3642 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3644 Optionally, a list or hashref of additional arguments to the qsearch call can
3651 my $opt = ref($_[0]) ? shift : { @_ };
3653 #return $self->num_cust_bill unless wantarray || keys %$opt;
3655 $opt->{'table'} = 'cust_bill';
3656 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3657 $opt->{'hashref'}{'custnum'} = $self->custnum;
3658 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3660 map { $_ } #behavior of sort undefined in scalar context
3661 sort { $a->_date <=> $b->_date }
3665 =item open_cust_bill
3667 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3672 sub open_cust_bill {
3676 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3682 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3684 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3688 sub legacy_cust_bill {
3691 #return $self->num_legacy_cust_bill unless wantarray;
3693 map { $_ } #behavior of sort undefined in scalar context
3694 sort { $a->_date <=> $b->_date }
3695 qsearch({ 'table' => 'legacy_cust_bill',
3696 'hashref' => { 'custnum' => $self->custnum, },
3697 'order_by' => 'ORDER BY _date ASC',
3701 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3703 Returns all the statements (see L<FS::cust_statement>) for this customer.
3705 Optionally, a list or hashref of additional arguments to the qsearch call can
3710 =item cust_bill_void
3712 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3716 sub cust_bill_void {
3719 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3720 sort { $a->_date <=> $b->_date }
3721 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3724 sub cust_statement {
3726 my $opt = ref($_[0]) ? shift : { @_ };
3728 #return $self->num_cust_statement unless wantarray || keys %$opt;
3730 $opt->{'table'} = 'cust_statement';
3731 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3732 $opt->{'hashref'}{'custnum'} = $self->custnum;
3733 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3735 map { $_ } #behavior of sort undefined in scalar context
3736 sort { $a->_date <=> $b->_date }
3740 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3742 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3744 Optionally, a list or hashref of additional arguments to the qsearch call can
3745 be passed following the SVCDB.
3752 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3753 warn "$me svc_x requires a svcdb";
3756 my $opt = ref($_[0]) ? shift : { @_ };
3758 $opt->{'table'} = $svcdb;
3759 $opt->{'addl_from'} =
3760 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3761 ($opt->{'addl_from'} || '');
3763 my $custnum = $self->custnum;
3764 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3765 my $where = "cust_pkg.custnum = $custnum";
3767 my $extra_sql = $opt->{'extra_sql'} || '';
3768 if ( keys %{ $opt->{'hashref'} } ) {
3769 $extra_sql = " AND $where $extra_sql";
3772 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3773 $extra_sql = "WHERE $where AND $1";
3776 $extra_sql = "WHERE $where $extra_sql";
3779 $opt->{'extra_sql'} = $extra_sql;
3784 # required for use as an eventtable;
3787 $self->svc_x('svc_acct', @_);
3792 Returns all the credits (see L<FS::cust_credit>) for this customer.
3799 #return $self->num_cust_credit unless wantarray;
3801 map { $_ } #behavior of sort undefined in scalar context
3802 sort { $a->_date <=> $b->_date }
3803 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3806 =item cust_credit_pkgnum
3808 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3809 package when using experimental package balances.
3813 sub cust_credit_pkgnum {
3814 my( $self, $pkgnum ) = @_;
3815 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3816 sort { $a->_date <=> $b->_date }
3817 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3818 'pkgnum' => $pkgnum,
3823 =item cust_credit_void
3825 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3829 sub cust_credit_void {
3832 sort { $a->_date <=> $b->_date }
3833 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3838 Returns all the payments (see L<FS::cust_pay>) for this customer.
3844 my $opt = ref($_[0]) ? shift : { @_ };
3846 return $self->num_cust_pay unless wantarray || keys %$opt;
3848 $opt->{'table'} = 'cust_pay';
3849 $opt->{'hashref'}{'custnum'} = $self->custnum;
3851 map { $_ } #behavior of sort undefined in scalar context
3852 sort { $a->_date <=> $b->_date }
3859 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3860 called automatically when the cust_pay method is used in a scalar context.
3866 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3867 my $sth = dbh->prepare($sql) or die dbh->errstr;
3868 $sth->execute($self->custnum) or die $sth->errstr;
3869 $sth->fetchrow_arrayref->[0];
3872 =item unapplied_cust_pay
3874 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3878 sub unapplied_cust_pay {
3882 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3888 =item cust_pay_pkgnum
3890 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3891 package when using experimental package balances.
3895 sub cust_pay_pkgnum {
3896 my( $self, $pkgnum ) = @_;
3897 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3898 sort { $a->_date <=> $b->_date }
3899 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3900 'pkgnum' => $pkgnum,
3907 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3913 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3914 sort { $a->_date <=> $b->_date }
3915 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3918 =item cust_pay_pending
3920 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3921 (without status "done").
3925 sub cust_pay_pending {
3927 return $self->num_cust_pay_pending unless wantarray;
3928 sort { $a->_date <=> $b->_date }
3929 qsearch( 'cust_pay_pending', {
3930 'custnum' => $self->custnum,
3931 'status' => { op=>'!=', value=>'done' },
3936 =item cust_pay_pending_attempt
3938 Returns all payment attempts / declined payments for this customer, as pending
3939 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3940 a corresponding payment (see L<FS::cust_pay>).
3944 sub cust_pay_pending_attempt {
3946 return $self->num_cust_pay_pending_attempt unless wantarray;
3947 sort { $a->_date <=> $b->_date }
3948 qsearch( 'cust_pay_pending', {
3949 'custnum' => $self->custnum,
3956 =item num_cust_pay_pending
3958 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3959 customer (without status "done"). Also called automatically when the
3960 cust_pay_pending method is used in a scalar context.
3964 sub num_cust_pay_pending {
3967 " SELECT COUNT(*) FROM cust_pay_pending ".
3968 " WHERE custnum = ? AND status != 'done' ",
3973 =item num_cust_pay_pending_attempt
3975 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3976 customer, with status "done" but without a corresp. Also called automatically when the
3977 cust_pay_pending method is used in a scalar context.
3981 sub num_cust_pay_pending_attempt {
3984 " SELECT COUNT(*) FROM cust_pay_pending ".
3985 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3992 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3998 map { $_ } #return $self->num_cust_refund unless wantarray;
3999 sort { $a->_date <=> $b->_date }
4000 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4003 =item display_custnum
4005 Returns the displayed customer number for this customer: agent_custid if
4006 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4010 sub display_custnum {
4013 return $self->agent_custid
4014 if $default_agent_custid && $self->agent_custid;
4016 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4020 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4021 } elsif ( $custnum_display_length ) {
4022 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4024 return $self->custnum;
4030 Returns a name string for this customer, either "Company (Last, First)" or
4037 my $name = $self->contact;
4038 $name = $self->company. " ($name)" if $self->company;
4042 =item service_contact
4044 Returns the L<FS::contact> object for this customer that has the 'Service'
4045 contact class, or undef if there is no such contact. Deprecated; don't use
4050 sub service_contact {
4052 if ( !exists($self->{service_contact}) ) {
4053 my $classnum = $self->scalar_sql(
4054 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4055 ) || 0; #if it's zero, qsearchs will return nothing
4056 my $cust_contact = qsearchs('cust_contact', {
4057 'classnum' => $classnum,
4058 'custnum' => $self->custnum,
4060 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4062 $self->{service_contact};
4067 Returns a name string for this (service/shipping) contact, either
4068 "Company (Last, First)" or "Last, First".
4075 my $name = $self->ship_contact;
4076 $name = $self->company. " ($name)" if $self->company;
4082 Returns a name string for this customer, either "Company" or "First Last".
4088 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4091 =item ship_name_short
4093 Returns a name string for this (service/shipping) contact, either "Company"
4098 sub ship_name_short {
4100 $self->service_contact
4101 ? $self->ship_contact_firstlast
4107 Returns this customer's full (billing) contact name only, "Last, First"
4113 $self->get('last'). ', '. $self->first;
4118 Returns this customer's full (shipping) contact name only, "Last, First"
4124 my $contact = $self->service_contact || $self;
4125 $contact->get('last') . ', ' . $contact->get('first');
4128 =item contact_firstlast
4130 Returns this customers full (billing) contact name only, "First Last".
4134 sub contact_firstlast {
4136 $self->first. ' '. $self->get('last');
4139 =item ship_contact_firstlast
4141 Returns this customer's full (shipping) contact name only, "First Last".
4145 sub ship_contact_firstlast {
4147 my $contact = $self->service_contact || $self;
4148 $contact->get('first') . ' '. $contact->get('last');
4151 sub bill_country_full {
4153 $self->bill_location->country_full;
4156 sub ship_country_full {
4158 $self->ship_location->country_full;
4161 =item county_state_county [ PREFIX ]
4163 Returns a string consisting of just the county, state and country.
4167 sub county_state_country {
4170 if ( @_ && $_[0] && $self->has_ship_address ) {
4171 $locationnum = $self->ship_locationnum;
4173 $locationnum = $self->bill_locationnum;
4175 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4176 $cust_location->county_state_country;
4179 =item geocode DATA_VENDOR
4181 Returns a value for the customer location as encoded by DATA_VENDOR.
4182 Currently this only makes sense for "CCH" as DATA_VENDOR.
4190 Returns a status string for this customer, currently:
4196 No packages have ever been ordered. Displayed as "No packages".
4200 Recurring packages all are new (not yet billed).
4204 One or more recurring packages is active.
4208 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4212 All non-cancelled recurring packages are suspended.
4216 All recurring packages are cancelled.
4220 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4221 cust_main-status_module configuration option.
4225 sub status { shift->cust_status(@_); }
4229 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4230 for my $status ( FS::cust_main->statuses() ) {
4231 my $method = $status.'_sql';
4232 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4233 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4234 $sth->execute( ($self->custnum) x $numnum )
4235 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4236 if ( $sth->fetchrow_arrayref->[0] ) {
4237 $self->hashref->{cust_status} = $status;
4243 =item is_status_delay_cancel
4245 Returns true if customer status is 'suspended'
4246 and all suspended cust_pkg return true for
4247 cust_pkg->is_status_delay_cancel.
4249 This is not a real status, this only meant for hacking display
4250 values, because otherwise treating the customer as suspended is
4251 really the whole point of the delay_cancel option.
4255 sub is_status_delay_cancel {
4257 return 0 unless $self->status eq 'suspended';
4258 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4259 return 0 unless $cust_pkg->is_status_delay_cancel;
4264 =item ucfirst_cust_status
4266 =item ucfirst_status
4268 Deprecated, use the cust_status_label method instead.
4270 Returns the status with the first character capitalized.
4274 sub ucfirst_status {
4275 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4276 local($ucfirst_nowarn) = 1;
4277 shift->ucfirst_cust_status(@_);
4280 sub ucfirst_cust_status {
4281 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4283 ucfirst($self->cust_status);
4286 =item cust_status_label
4290 Returns the display label for this status.
4294 sub status_label { shift->cust_status_label(@_); }
4296 sub cust_status_label {
4298 __PACKAGE__->statuslabels->{$self->cust_status};
4303 Returns a hex triplet color string for this customer's status.
4307 sub statuscolor { shift->cust_statuscolor(@_); }
4309 sub cust_statuscolor {
4311 __PACKAGE__->statuscolors->{$self->cust_status};
4314 =item tickets [ STATUS ]
4316 Returns an array of hashes representing the customer's RT tickets.
4318 An optional status (or arrayref or hashref of statuses) may be specified.
4324 my $status = ( @_ && $_[0] ) ? shift : '';
4326 my $num = $conf->config('cust_main-max_tickets') || 10;
4329 if ( $conf->config('ticket_system') ) {
4330 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4332 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4341 foreach my $priority (
4342 $conf->config('ticket_system-custom_priority_field-values'), ''
4344 last if scalar(@tickets) >= $num;
4346 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4347 $num - scalar(@tickets),
4358 =item appointments [ STATUS ]
4360 Returns an array of hashes representing the customer's RT tickets which
4367 my $status = ( @_ && $_[0] ) ? shift : '';
4369 return () unless $conf->config('ticket_system');
4371 my $queueid = $conf->config('ticket_system-appointment-queueid');
4373 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4382 # Return services representing svc_accts in customer support packages
4383 sub support_services {
4385 my %packages = map { $_ => 1 } $conf->config('support_packages');
4387 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4388 grep { $_->part_svc->svcdb eq 'svc_acct' }
4389 map { $_->cust_svc }
4390 grep { exists $packages{ $_->pkgpart } }
4391 $self->ncancelled_pkgs;
4395 # Return a list of latitude/longitude for one of the services (if any)
4396 sub service_coordinates {
4400 grep { $_->latitude && $_->longitude }
4402 map { $_->cust_svc }
4403 $self->ncancelled_pkgs;
4405 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4410 Returns a masked version of the named field
4415 my ($self,$field) = @_;
4419 'x'x(length($self->getfield($field))-4).
4420 substr($self->getfield($field), (length($self->getfield($field))-4));
4424 =item payment_history
4426 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4427 cust_credit and cust_refund objects. Each hashref has the following fields:
4429 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4431 I<date> - value of _date field, unix timestamp
4433 I<date_pretty> - user-friendly date
4435 I<description> - user-friendly description of item
4437 I<amount> - impact of item on user's balance
4438 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4439 Not to be confused with the native 'amount' field in cust_credit, see below.
4441 I<amount_pretty> - includes money char
4443 I<balance> - customer balance, chronologically as of this item
4445 I<balance_pretty> - includes money char
4447 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4449 I<paid> - amount paid for cust_pay records, undef for other types
4451 I<credit> - amount credited for cust_credit records, undef for other types.
4452 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4454 I<refund> - amount refunded for cust_refund records, undef for other types
4456 The four table-specific keys always have positive values, whether they reflect charges or payments.
4458 The following options may be passed to this method:
4460 I<line_items> - if true, returns charges ('Line item') rather than invoices
4462 I<start_date> - unix timestamp, only include records on or after.
4463 If specified, an item of type 'Previous' will also be included.
4464 It does not have table-specific fields.
4466 I<end_date> - unix timestamp, only include records before
4468 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4470 I<conf> - optional already-loaded FS::Conf object.
4474 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4475 # and also for sending customer statements, which should both be kept customer-friendly.
4476 # If you add anything that shouldn't be passed on through the API or exposed
4477 # to customers, add a new option to include it, don't include it by default
4478 sub payment_history {
4480 my $opt = ref($_[0]) ? $_[0] : { @_ };
4482 my $conf = $$opt{'conf'} || new FS::Conf;
4483 my $money_char = $conf->config("money_char") || '$',
4485 #first load entire history,
4486 #need previous to calculate previous balance
4487 #loading after end_date shouldn't hurt too much?
4489 if ( $$opt{'line_items'} ) {
4491 foreach my $cust_bill ( $self->cust_bill ) {
4494 'type' => 'Line item',
4495 'description' => $_->desc( $self->locale ).
4496 ( $_->sdate && $_->edate
4497 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4498 ' To '. time2str('%d-%b-%Y', $_->edate)
4501 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4502 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4503 'date' => $cust_bill->_date,
4504 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4506 foreach $cust_bill->cust_bill_pkg;
4513 'type' => 'Invoice',
4514 'description' => 'Invoice #'. $_->display_invnum,
4515 'amount' => sprintf('%.2f', $_->charged ),
4516 'charged' => sprintf('%.2f', $_->charged ),
4517 'date' => $_->_date,
4518 'date_pretty' => $self->time2str_local('short', $_->_date ),
4520 foreach $self->cust_bill;
4525 'type' => 'Payment',
4526 'description' => 'Payment', #XXX type
4527 'amount' => sprintf('%.2f', 0 - $_->paid ),
4528 'paid' => sprintf('%.2f', $_->paid ),
4529 'date' => $_->_date,
4530 'date_pretty' => $self->time2str_local('short', $_->_date ),
4532 foreach $self->cust_pay;
4536 'description' => 'Credit', #more info?
4537 'amount' => sprintf('%.2f', 0 -$_->amount ),
4538 'credit' => sprintf('%.2f', $_->amount ),
4539 'date' => $_->_date,
4540 'date_pretty' => $self->time2str_local('short', $_->_date ),
4542 foreach $self->cust_credit;
4546 'description' => 'Refund', #more info? type, like payment?
4547 'amount' => $_->refund,
4548 'refund' => $_->refund,
4549 'date' => $_->_date,
4550 'date_pretty' => $self->time2str_local('short', $_->_date ),
4552 foreach $self->cust_refund;
4554 #put it all in chronological order
4555 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4557 #calculate balance, filter items outside date range
4561 foreach my $item (@history) {
4562 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4563 $balance += $$item{'amount'};
4564 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4565 $previous += $$item{'amount'};
4568 $$item{'balance'} = sprintf("%.2f",$balance);
4569 foreach my $key ( qw(amount balance) ) {
4570 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4575 # start with previous balance, if there was one
4578 'type' => 'Previous',
4579 'description' => 'Previous balance',
4580 'amount' => sprintf("%.2f",$previous),
4581 'balance' => sprintf("%.2f",$previous),
4582 'date' => $$opt{'start_date'},
4583 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4585 #false laziness with above
4586 foreach my $key ( qw(amount balance) ) {
4587 $$item{$key.'_pretty'} = $$item{$key};
4588 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4590 unshift(@out,$item);
4593 @out = reverse @history if $$opt{'reverse_sort'};
4598 =item save_cust_payby
4600 Saves a new cust_payby for this customer, replacing an existing entry only
4601 in select circumstances. Does not validate input.
4603 If auto is specified, marks this as the customer's primary method, or the
4604 specified weight. Existing payment methods have their weight incremented as
4607 If bill_location is specified with auto, also sets location in cust_main.
4609 Will not insert complete duplicates of existing records, or records in which the
4610 only difference from an existing record is to turn off automatic payment (will
4611 return without error.) Will replace existing records in which the only difference
4612 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4613 Fields marked as preserved are optional, and existing values will not be overwritten with
4614 blanks when replacing.
4616 Accepts the following named parameters:
4626 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4630 optional, set higher than 1 for secondary, etc.
4638 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4646 optional, will be preserved when replacing
4654 CARD only, required, FS::cust_location object
4656 =item paystart_month
4658 CARD only, optional, will be preserved when replacing
4662 CARD only, optional, will be preserved when replacing
4666 CARD only, optional, will be preserved when replacing
4670 CARD only, only used if conf cvv-save is set appropriately
4684 #The code for this option is in place, but it's not currently used
4688 # existing cust_payby object to be replaced (must match custnum)
4690 # stateid/stateid_state/ss are not currently supported in cust_payby,
4691 # might not even work properly in 4.x, but will need to work here if ever added
4693 sub save_cust_payby {
4697 my $old = $opt{'replace'};
4698 my $new = new FS::cust_payby { $old ? $old->hash : () };
4699 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4700 $new->set( 'custnum' => $self->custnum );
4702 my $payby = $opt{'payment_payby'};
4703 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4705 # don't allow turning off auto when replacing
4706 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4708 my @check_existing; # payby relevant to this payment_payby
4710 # set payby based on auto
4711 if ( $payby eq 'CARD' ) {
4712 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4713 @check_existing = qw( CARD DCRD );
4714 } elsif ( $payby eq 'CHEK' ) {
4715 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4716 @check_existing = qw( CHEK DCHK );
4719 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4722 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4723 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4724 $new->set( 'payname' => $opt{'payname'} );
4725 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4727 my $conf = new FS::Conf;
4729 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4730 if ( $payby eq 'CARD' &&
4731 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4732 || $conf->exists('business-onlinepayment-verification')
4735 $new->set( 'paycvv' => $opt{'paycvv'} );
4737 $new->set( 'paycvv' => '');
4740 local $SIG{HUP} = 'IGNORE';
4741 local $SIG{INT} = 'IGNORE';
4742 local $SIG{QUIT} = 'IGNORE';
4743 local $SIG{TERM} = 'IGNORE';
4744 local $SIG{TSTP} = 'IGNORE';
4745 local $SIG{PIPE} = 'IGNORE';
4747 my $oldAutoCommit = $FS::UID::AutoCommit;
4748 local $FS::UID::AutoCommit = 0;
4751 # set fields specific to payment_payby
4752 if ( $payby eq 'CARD' ) {
4753 if ($opt{'bill_location'}) {
4754 $opt{'bill_location'}->set('custnum' => $self->custnum);
4755 my $error = $opt{'bill_location'}->find_or_insert;
4757 $dbh->rollback if $oldAutoCommit;
4760 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4762 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4763 $new->set( $field => $opt{$field} );
4766 foreach my $field ( qw(paytype paystate) ) {
4767 $new->set( $field => $opt{$field} );
4771 # other cust_payby to compare this to
4772 my @existing = $self->cust_payby(@check_existing);
4774 # fields that can overwrite blanks with values, but not values with blanks
4775 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4777 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4779 # generally, we don't want to overwrite existing cust_payby with this,
4780 # but we can replace if we're only marking it auto or adding a preserved field
4781 # and we can avoid saving a total duplicate or merely turning off auto
4783 foreach my $cust_payby (@existing) {
4784 # check fields that absolutely should not change
4785 foreach my $field ($new->fields) {
4786 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4787 next if grep(/^$field$/, @preserve );
4788 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4790 # now check fields that can replace if one value is blank
4792 foreach my $field (@preserve) {
4794 ( $new->get($field) and !$cust_payby->get($field) ) or
4795 ( $cust_payby->get($field) and !$new->get($field) )
4797 # prevention of overwriting values with blanks happens farther below
4799 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4803 unless ( $replace ) {
4804 # nearly identical, now check weight
4805 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4806 # ignore identical cust_payby, and ignore attempts to turn off auto
4807 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4808 $skip_cust_payby = 1;
4811 # otherwise, only change is to mark this as primary
4813 # if we got this far, we're definitely replacing
4820 $new->set( 'custpaybynum' => $old->custpaybynum );
4821 # don't turn off automatic payment (but allow it to be turned on)
4822 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4824 $new->set( 'payby' => $old->payby );
4825 $new->set( 'weight' => 1 );
4827 # make sure we're not overwriting values with blanks
4828 foreach my $field (@preserve) {
4829 if ( $old->get($field) and !$new->get($field) ) {
4830 $new->set( $field => $old->get($field) );
4835 # only overwrite cust_main bill_location if auto
4836 if ($opt{'auto'} && $opt{'bill_location'}) {
4837 $self->set('bill_location' => $opt{'bill_location'});
4838 my $error = $self->replace;
4840 $dbh->rollback if $oldAutoCommit;
4845 # done with everything except reweighting and saving cust_payby
4846 # still need to commit changes to cust_main and cust_location
4847 if ($skip_cust_payby) {
4848 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4852 # re-weight existing primary cust_pay for this payby
4854 foreach my $cust_payby (@existing) {
4855 # relies on cust_payby return order
4856 last unless $cust_payby->payby !~ /^D/;
4857 last if $cust_payby->weight > 1;
4858 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4859 next if $cust_payby->weight < ($opt{'weight'} || 1);
4860 $cust_payby->weight( $cust_payby->weight + 1 );
4861 my $error = $cust_payby->replace;
4863 $dbh->rollback if $oldAutoCommit;
4864 return "Error reweighting cust_payby: $error";
4869 # finally, save cust_payby
4870 my $error = $old ? $new->replace($old) : $new->insert;
4872 $dbh->rollback if $oldAutoCommit;
4876 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4881 =item remove_cvv_from_cust_payby PAYINFO
4883 Removes paycvv from associated cust_payby with matching PAYINFO.
4887 sub remove_cvv_from_cust_payby {
4888 my ($self,$payinfo) = @_;
4890 my $oldAutoCommit = $FS::UID::AutoCommit;
4891 local $FS::UID::AutoCommit = 0;
4894 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4895 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4896 $cust_payby->paycvv('');
4897 my $error = $cust_payby->replace;
4899 $dbh->rollback if $oldAutoCommit;
4904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4910 =head1 CLASS METHODS
4916 Class method that returns the list of possible status strings for customers
4917 (see L<the status method|/status>). For example:
4919 @statuses = FS::cust_main->statuses();
4925 keys %{ $self->statuscolors };
4928 =item cust_status_sql
4930 Returns an SQL fragment to determine the status of a cust_main record, as a
4935 sub cust_status_sql {
4937 for my $status ( FS::cust_main->statuses() ) {
4938 my $method = $status.'_sql';
4939 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4948 Returns an SQL expression identifying prospective cust_main records (customers
4949 with no packages ever ordered)
4953 use vars qw($select_count_pkgs);
4954 $select_count_pkgs =
4955 "SELECT COUNT(*) FROM cust_pkg
4956 WHERE cust_pkg.custnum = cust_main.custnum";
4958 sub select_count_pkgs_sql {
4963 " 0 = ( $select_count_pkgs ) ";
4968 Returns an SQL expression identifying ordered cust_main records (customers with
4969 no active packages, but recurring packages not yet setup or one time charges
4975 FS::cust_main->none_active_sql.
4976 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4981 Returns an SQL expression identifying active cust_main records (customers with
4982 active recurring packages).
4987 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4990 =item none_active_sql
4992 Returns an SQL expression identifying cust_main records with no active
4993 recurring packages. This includes customers of status prospect, ordered,
4994 inactive, and suspended.
4998 sub none_active_sql {
4999 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5004 Returns an SQL expression identifying inactive cust_main records (customers with
5005 no active recurring packages, but otherwise unsuspended/uncancelled).
5010 FS::cust_main->none_active_sql.
5011 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5017 Returns an SQL expression identifying suspended cust_main records.
5022 sub suspended_sql { susp_sql(@_); }
5024 FS::cust_main->none_active_sql.
5025 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5031 Returns an SQL expression identifying cancelled cust_main records.
5035 sub cancel_sql { shift->cancelled_sql(@_); }
5038 =item uncancelled_sql
5040 Returns an SQL expression identifying un-cancelled cust_main records.
5044 sub uncancelled_sql { uncancel_sql(@_); }
5047 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5052 Returns an SQL fragment to retreive the balance.
5057 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5058 WHERE cust_bill.custnum = cust_main.custnum )
5059 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5060 WHERE cust_pay.custnum = cust_main.custnum )
5061 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5062 WHERE cust_credit.custnum = cust_main.custnum )
5063 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5064 WHERE cust_refund.custnum = cust_main.custnum )
5067 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5069 Returns an SQL fragment to retreive the balance for this customer, optionally
5070 considering invoices with date earlier than START_TIME, and not
5071 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5072 total_unapplied_payments).
5074 Times are specified as SQL fragments or numeric
5075 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5076 L<Date::Parse> for conversion functions. The empty string can be passed
5077 to disable that time constraint completely.
5079 Available options are:
5083 =item unapplied_date
5085 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)
5090 set to true to remove all customer comparison clauses, for totals
5095 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5100 JOIN clause (typically used with the total option)
5104 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5105 time will be ignored. Note that START_TIME and END_TIME only limit the date
5106 range for invoices and I<unapplied> payments, credits, and refunds.
5112 sub balance_date_sql {
5113 my( $class, $start, $end, %opt ) = @_;
5115 my $cutoff = $opt{'cutoff'};
5117 my $owed = FS::cust_bill->owed_sql($cutoff);
5118 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5119 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5120 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5122 my $j = $opt{'join'} || '';
5124 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5125 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5126 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5127 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5129 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5130 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5131 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5132 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5137 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5139 Returns an SQL fragment to retreive the total unapplied payments for this
5140 customer, only considering payments with date earlier than START_TIME, and
5141 optionally not later than END_TIME.
5143 Times are specified as SQL fragments or numeric
5144 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5145 L<Date::Parse> for conversion functions. The empty string can be passed
5146 to disable that time constraint completely.
5148 Available options are:
5152 sub unapplied_payments_date_sql {
5153 my( $class, $start, $end, %opt ) = @_;
5155 my $cutoff = $opt{'cutoff'};
5157 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5159 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5160 'unapplied_date'=>1 );
5162 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5165 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5167 Helper method for balance_date_sql; name (and usage) subject to change
5168 (suggestions welcome).
5170 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5171 cust_refund, cust_credit or cust_pay).
5173 If TABLE is "cust_bill" or the unapplied_date option is true, only
5174 considers records with date earlier than START_TIME, and optionally not
5175 later than END_TIME .
5179 sub _money_table_where {
5180 my( $class, $table, $start, $end, %opt ) = @_;
5183 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5184 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5185 push @where, "$table._date <= $start" if defined($start) && length($start);
5186 push @where, "$table._date > $end" if defined($end) && length($end);
5188 push @where, @{$opt{'where'}} if $opt{'where'};
5189 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5195 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5196 use FS::cust_main::Search;
5199 FS::cust_main::Search->search(@_);
5208 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5210 #Deprecated. Use event notification and message templates
5211 #(L<FS::msg_template>) instead.
5213 #Sends a templated email notification to the customer (see L<Text::Template>).
5215 #OPTIONS is a hash and may include
5217 #I<from> - the email sender (default is invoice_from)
5219 #I<to> - comma-separated scalar or arrayref of recipients
5220 # (default is invoicing_list)
5222 #I<subject> - The subject line of the sent email notification
5223 # (default is "Notice from company_name")
5225 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5228 #The following variables are vavailable in the template.
5230 #I<$first> - the customer first name
5231 #I<$last> - the customer last name
5232 #I<$company> - the customer company
5233 #I<$payby> - a description of the method of payment for the customer
5234 # # would be nice to use FS::payby::shortname
5235 #I<$payinfo> - the account information used to collect for this customer
5236 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5241 # my ($self, $template, %options) = @_;
5243 # return unless $conf->exists($template);
5245 # my $from = $conf->invoice_from_full($self->agentnum)
5246 # if $conf->exists('invoice_from', $self->agentnum);
5247 # $from = $options{from} if exists($options{from});
5249 # my $to = join(',', $self->invoicing_list_emailonly);
5250 # $to = $options{to} if exists($options{to});
5252 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5253 # if $conf->exists('company_name', $self->agentnum);
5254 # $subject = $options{subject} if exists($options{subject});
5256 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5257 # SOURCE => [ map "$_\n",
5258 # $conf->config($template)]
5260 # or die "can't create new Text::Template object: Text::Template::ERROR";
5261 # $notify_template->compile()
5262 # or die "can't compile template: Text::Template::ERROR";
5264 # $FS::notify_template::_template::company_name =
5265 # $conf->config('company_name', $self->agentnum);
5266 # $FS::notify_template::_template::company_address =
5267 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5269 # my $paydate = $self->paydate || '2037-12-31';
5270 # $FS::notify_template::_template::first = $self->first;
5271 # $FS::notify_template::_template::last = $self->last;
5272 # $FS::notify_template::_template::company = $self->company;
5273 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5274 # my $payby = $self->payby;
5275 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5276 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5278 # #credit cards expire at the end of the month/year of their exp date
5279 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5280 # $FS::notify_template::_template::payby = 'credit card';
5281 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5282 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5284 # }elsif ($payby eq 'COMP') {
5285 # $FS::notify_template::_template::payby = 'complimentary account';
5287 # $FS::notify_template::_template::payby = 'current method';
5289 # $FS::notify_template::_template::expdate = $expire_time;
5291 # for (keys %{$options{extra_fields}}){
5293 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5296 # send_email(from => $from,
5298 # subject => $subject,
5299 # body => $notify_template->fill_in( PACKAGE =>
5300 # 'FS::notify_template::_template' ),
5305 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5307 Generates a templated notification to the customer (see L<Text::Template>).
5309 OPTIONS is a hash and may include
5311 I<extra_fields> - a hashref of name/value pairs which will be substituted
5312 into the template. These values may override values mentioned below
5313 and those from the customer record.
5315 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5317 The following variables are available in the template instead of or in addition
5318 to the fields of the customer record.
5320 I<$payby> - a description of the method of payment for the customer
5321 # would be nice to use FS::payby::shortname
5322 I<$payinfo> - the masked account information used to collect for this customer
5323 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5324 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5328 # a lot like cust_bill::print_latex
5329 sub generate_letter {
5330 my ($self, $template, %options) = @_;
5332 warn "Template $template does not exist" && return
5333 unless $conf->exists($template) || $options{'template_text'};
5335 my $template_source = $options{'template_text'}
5336 ? [ $options{'template_text'} ]
5337 : [ map "$_\n", $conf->config($template) ];
5339 my $letter_template = new Text::Template
5341 SOURCE => $template_source,
5342 DELIMITERS => [ '[@--', '--@]' ],
5344 or die "can't create new Text::Template object: Text::Template::ERROR";
5346 $letter_template->compile()
5347 or die "can't compile template: Text::Template::ERROR";
5349 my %letter_data = map { $_ => $self->$_ } $self->fields;
5350 $letter_data{payinfo} = $self->mask_payinfo;
5352 #my $paydate = $self->paydate || '2037-12-31';
5353 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5355 my $payby = $self->payby;
5356 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5357 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5359 #credit cards expire at the end of the month/year of their exp date
5360 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5361 $letter_data{payby} = 'credit card';
5362 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5363 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5365 }elsif ($payby eq 'COMP') {
5366 $letter_data{payby} = 'complimentary account';
5368 $letter_data{payby} = 'current method';
5370 $letter_data{expdate} = $expire_time;
5372 for (keys %{$options{extra_fields}}){
5373 $letter_data{$_} = $options{extra_fields}->{$_};
5376 unless(exists($letter_data{returnaddress})){
5377 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5378 $self->agent_template)
5380 if ( length($retadd) ) {
5381 $letter_data{returnaddress} = $retadd;
5382 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5383 $letter_data{returnaddress} =
5384 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5388 ( $conf->config('company_name', $self->agentnum),
5389 $conf->config('company_address', $self->agentnum),
5393 $letter_data{returnaddress} = '~';
5397 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5399 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5401 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5403 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5407 ) or die "can't open temp file: $!\n";
5408 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5409 or die "can't write temp file: $!\n";
5411 $letter_data{'logo_file'} = $lh->filename;
5413 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5417 ) or die "can't open temp file: $!\n";
5419 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5421 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5422 return ($1, $letter_data{'logo_file'});
5426 =item print_ps TEMPLATE
5428 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5434 my($file, $lfile) = $self->generate_letter(@_);
5435 my $ps = FS::Misc::generate_ps($file);
5436 unlink($file.'.tex');
5442 =item print TEMPLATE
5444 Prints the filled in template.
5446 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5450 sub queueable_print {
5453 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5454 or die "invalid customer number: " . $opt{custnum};
5456 #do not backport this change to 3.x
5457 # my $error = $self->print( { 'template' => $opt{template} } );
5458 my $error = $self->print( $opt{'template'} );
5459 die $error if $error;
5463 my ($self, $template) = (shift, shift);
5465 [ $self->print_ps($template) ],
5466 'agentnum' => $self->agentnum,
5470 #these three subs should just go away once agent stuff is all config overrides
5472 sub agent_template {
5474 $self->_agent_plandata('agent_templatename');
5477 sub agent_invoice_from {
5479 $self->_agent_plandata('agent_invoice_from');
5482 sub _agent_plandata {
5483 my( $self, $option ) = @_;
5485 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5486 #agent-specific Conf
5488 use FS::part_event::Condition;
5490 my $agentnum = $self->agentnum;
5492 my $regexp = regexp_sql();
5494 my $part_event_option =
5496 'select' => 'part_event_option.*',
5497 'table' => 'part_event_option',
5499 LEFT JOIN part_event USING ( eventpart )
5500 LEFT JOIN part_event_option AS peo_agentnum
5501 ON ( part_event.eventpart = peo_agentnum.eventpart
5502 AND peo_agentnum.optionname = 'agentnum'
5503 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5505 LEFT JOIN part_event_condition
5506 ON ( part_event.eventpart = part_event_condition.eventpart
5507 AND part_event_condition.conditionname = 'cust_bill_age'
5509 LEFT JOIN part_event_condition_option
5510 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5511 AND part_event_condition_option.optionname = 'age'
5514 #'hashref' => { 'optionname' => $option },
5515 #'hashref' => { 'part_event_option.optionname' => $option },
5517 " WHERE part_event_option.optionname = ". dbh->quote($option).
5518 " AND action = 'cust_bill_send_agent' ".
5519 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5520 " AND peo_agentnum.optionname = 'agentnum' ".
5521 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5523 CASE WHEN part_event_condition_option.optionname IS NULL
5525 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5527 , part_event.weight".
5531 unless ( $part_event_option ) {
5532 return $self->agent->invoice_template || ''
5533 if $option eq 'agent_templatename';
5537 $part_event_option->optionvalue;
5541 sub process_o2m_qsearch {
5544 return qsearch($table, @_) unless $table eq 'contact';
5546 my $hashref = shift;
5547 my %hash = %$hashref;
5548 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5549 or die 'guru meditation #4343';
5551 qsearch({ 'table' => 'contact',
5552 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5553 'hashref' => \%hash,
5554 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5555 " cust_contact.custnum = $custnum "
5559 sub process_o2m_qsearchs {
5562 return qsearchs($table, @_) unless $table eq 'contact';
5564 my $hashref = shift;
5565 my %hash = %$hashref;
5566 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5567 or die 'guru meditation #2121';
5569 qsearchs({ 'table' => 'contact',
5570 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5571 'hashref' => \%hash,
5572 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5573 " cust_contact.custnum = $custnum "
5577 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5579 Subroutine (not a method), designed to be called from the queue.
5581 Takes a list of options and values.
5583 Pulls up the customer record via the custnum option and calls bill_and_collect.
5588 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5590 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5591 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5593 #without this errors don't get rolled back
5594 $args{'fatal'} = 1; # runs from job queue, will be caught
5596 $cust_main->bill_and_collect( %args );
5599 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5601 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5602 C<collect> part. This is used in batch tax calculation, where invoice
5603 generation and collection events have to be completely separated.
5607 sub queued_collect {
5609 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5611 $cust_main->collect(%args);
5614 sub process_bill_and_collect {
5617 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5618 or die "custnum '$param->{custnum}' not found!\n";
5619 $param->{'job'} = $job;
5620 $param->{'fatal'} = 1; # runs from job queue, will be caught
5621 $param->{'retry'} = 1;
5623 $cust_main->bill_and_collect( %$param );
5626 #starting to take quite a while for big dbs
5627 # (JRNL: journaled so it only happens once per database)
5628 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5629 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5630 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5631 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5632 # JRNL leading/trailing spaces in first, last, company
5633 # JRNL migrate to cust_payby
5634 # - otaker upgrade? journal and call it good? (double check to make sure
5635 # we're not still setting otaker here)
5637 #only going to get worse with new location stuff...
5639 sub _upgrade_data { #class method
5640 my ($class, %opts) = @_;
5643 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5646 #this seems to be the only expensive one.. why does it take so long?
5647 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5649 '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';
5650 FS::upgrade_journal->set_done('cust_main__signupdate');
5653 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5655 # fix yyyy-m-dd formatted paydates
5656 if ( driver_name =~ /^mysql/i ) {
5658 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5659 } else { # the SQL standard
5661 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5663 FS::upgrade_journal->set_done('cust_main__paydate');
5666 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5668 push @statements, #fix the weird BILL with a cc# in payinfo problem
5670 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5672 FS::upgrade_journal->set_done('cust_main__payinfo');
5677 foreach my $sql ( @statements ) {
5678 my $sth = dbh->prepare($sql) or die dbh->errstr;
5679 $sth->execute or die $sth->errstr;
5680 #warn ( (time - $t). " seconds\n" );
5684 local($ignore_expired_card) = 1;
5685 local($ignore_banned_card) = 1;
5686 local($skip_fuzzyfiles) = 1;
5687 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5689 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5691 #we don't want to decrypt them, just stuff them as-is into cust_payby
5692 local(@encrypted_fields) = ();
5694 local($FS::cust_payby::ignore_expired_card) = 1;
5695 local($FS::cust_payby::ignore_banned_card) = 1;
5696 local($FS::cust_payby::ignore_cardtype) = 1;
5698 my @payfields = qw( payby payinfo paycvv paymask
5699 paydate paystart_month paystart_year payissue
5700 payname paystate paytype payip
5703 my $search = new FS::Cursor {
5704 'table' => 'cust_main',
5705 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5708 while (my $cust_main = $search->fetch) {
5710 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5712 my $cust_payby = new FS::cust_payby {
5713 'custnum' => $cust_main->custnum,
5715 map { $_ => $cust_main->$_(); } @payfields
5718 my $error = $cust_payby->insert;
5719 die $error if $error;
5723 # at the time we do this, also migrate paytype into cust_pay_batch
5724 # so that batches that are open before the migration can still be
5726 my @cust_pay_batch = qsearch('cust_pay_batch', {
5727 'custnum' => $cust_main->custnum,
5731 foreach my $cust_pay_batch (@cust_pay_batch) {
5732 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5733 my $error = $cust_pay_batch->replace;
5734 die "$error (setting cust_pay_batch.paytype)" if $error;
5737 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5739 $cust_main->invoice_attn( $cust_main->payname )
5740 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5741 $cust_main->po_number( $cust_main->payinfo )
5742 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5744 $cust_main->setfield($_, '') foreach @payfields;
5745 my $error = $cust_main->replace;
5746 die "Error upgradging payment information for custnum ".
5747 $cust_main->custnum. ": $error"
5752 FS::upgrade_journal->set_done('cust_main__cust_payby');
5755 FS::cust_main::Location->_upgrade_data(%opts);
5757 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5759 foreach my $cust_main ( qsearch({
5760 'table' => 'cust_main',
5762 'extra_sql' => 'WHERE '.
5764 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5765 qw( first last company )
5768 my $error = $cust_main->replace;
5769 die $error if $error;
5772 FS::upgrade_journal->set_done('cust_main__trimspaces');
5776 $class->_upgrade_otaker(%opts);
5786 The delete method should possibly take an FS::cust_main object reference
5787 instead of a scalar customer number.
5789 Bill and collect options should probably be passed as references instead of a
5792 There should probably be a configuration file with a list of allowed credit
5795 No multiple currency support (probably a larger project than just this module).
5797 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5799 Birthdates rely on negative epoch values.
5801 The payby for card/check batches is broken. With mixed batching, bad
5804 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5808 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5809 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5810 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.