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);
32 use FS::UID qw( dbh driver_name );
33 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
35 use FS::Misc qw( generate_ps do_print money_pretty card_types );
36 use FS::Msgcat qw(gettext);
43 use FS::cust_bill_void;
44 use FS::legacy_cust_bill;
46 use FS::cust_pay_pending;
47 use FS::cust_pay_void;
48 use FS::cust_pay_batch;
51 use FS::part_referral;
52 use FS::cust_main_county;
53 use FS::cust_location;
56 use FS::cust_main_exemption;
57 use FS::cust_tax_adjustment;
58 use FS::cust_tax_location;
59 use FS::agent_currency;
60 use FS::cust_main_invoice;
62 use FS::prepay_credit;
68 use FS::payment_gateway;
69 use FS::agent_payment_gateway;
71 use FS::cust_main_note;
72 use FS::cust_attachment;
75 use FS::upgrade_journal;
81 # 1 is mostly method/subroutine entry and options
82 # 2 traces progress of some operations
83 # 3 is even more information including possibly sensitive data
85 our $me = '[FS::cust_main]';
88 our $ignore_expired_card = 0;
89 our $ignore_banned_card = 0;
90 our $ignore_invalid_card = 0;
92 our $skip_fuzzyfiles = 0;
94 our $ucfirst_nowarn = 0;
96 #this info is in cust_payby as of 4.x
97 #this and the fields themselves can be removed in 5.x
98 our @encrypted_fields = ('payinfo', 'paycvv');
99 sub nohistory_fields { ('payinfo', 'paycvv'); }
102 our $default_agent_custid;
103 our $custnum_display_length;
104 #ask FS::UID to run this stuff for us later
105 #$FS::UID::callback{'FS::cust_main'} = sub {
106 install_callback FS::UID sub {
107 $conf = new FS::Conf;
108 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
109 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
110 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
115 my ( $hashref, $cache ) = @_;
116 if ( exists $hashref->{'pkgnum'} ) {
117 #@{ $self->{'_pkgnum'} } = ();
118 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
119 $self->{'_pkgnum'} = $subcache;
120 #push @{ $self->{'_pkgnum'} },
121 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
127 FS::cust_main - Object methods for cust_main records
133 $record = new FS::cust_main \%hash;
134 $record = new FS::cust_main { 'column' => 'value' };
136 $error = $record->insert;
138 $error = $new_record->replace($old_record);
140 $error = $record->delete;
142 $error = $record->check;
144 @cust_pkg = $record->all_pkgs;
146 @cust_pkg = $record->ncancelled_pkgs;
148 @cust_pkg = $record->suspended_pkgs;
150 $error = $record->bill;
151 $error = $record->bill %options;
152 $error = $record->bill 'time' => $time;
154 $error = $record->collect;
155 $error = $record->collect %options;
156 $error = $record->collect 'invoice_time' => $time,
161 An FS::cust_main object represents a customer. FS::cust_main inherits from
162 FS::Record. The following fields are currently supported:
168 Primary key (assigned automatically for new customers)
172 Agent (see L<FS::agent>)
176 Advertising source (see L<FS::part_referral>)
188 Cocial security number (optional)
212 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
216 Payment Information (See L<FS::payinfo_Mixin> for data format)
220 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
224 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
228 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
232 Start date month (maestro/solo cards only)
236 Start date year (maestro/solo cards only)
240 Issue number (maestro/solo cards only)
244 Name on card or billing name
248 IP address from which payment information was received
252 Tax exempt, empty or `Y'
256 Order taker (see L<FS::access_user>)
262 =item referral_custnum
264 Referring customer number
268 Enable individual CDR spooling, empty or `Y'
272 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
276 Discourage individual CDR printing, empty or `Y'
280 Allow self-service editing of ticket subjects, empty or 'Y'
282 =item calling_list_exempt
284 Do not call, empty or 'Y'
286 =item invoice_ship_address
288 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
298 Creates a new customer. To add the customer to the database, see L<"insert">.
300 Note that this stores the hash reference, not a distinct copy of the hash it
301 points to. You can ask the object for a copy with the I<hash> method.
305 sub table { 'cust_main'; }
307 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
309 Adds this customer to the database. If there is an error, returns the error,
310 otherwise returns false.
312 Usually the customer's location will not yet exist in the database, and
313 the C<bill_location> and C<ship_location> pseudo-fields must be set to
314 uninserted L<FS::cust_location> objects. These will be inserted and linked
315 (in both directions) to the new customer record. If they're references
316 to the same object, they will become the same location.
318 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
319 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
320 are inserted atomicly, or the transaction is rolled back. Passing an empty
321 hash reference is equivalent to not supplying this parameter. There should be
322 a better explanation of this, but until then, here's an example:
325 tie %hash, 'Tie::RefHash'; #this part is important
327 $cust_pkg => [ $svc_acct ],
330 $cust_main->insert( \%hash );
332 INVOICING_LIST_ARYREF: No longer supported.
334 Currently available options are: I<depend_jobnum>, I<noexport>,
335 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
337 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
338 on the supplied jobnum (they will not run until the specific job completes).
339 This can be used to defer provisioning until some action completes (such
340 as running the customer's credit card successfully).
342 The I<noexport> option is deprecated. If I<noexport> is set true, no
343 provisioning jobs (exports) are scheduled. (You can schedule them later with
344 the B<reexport> method.)
346 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
347 of tax names and exemption numbers. FS::cust_main_exemption records will be
348 created and inserted.
350 If I<prospectnum> is set, moves contacts and locations from that prospect.
352 If I<contact> is set to an arrayref of FS::contact objects, those will be
355 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
356 unset), inserts those new contacts with this new customer. Handles CGI
357 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
359 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
360 new stored payment records with this new customer. Handles CGI parameters
361 for an "m2" multiple entry field as passed by edit/cust_main.cgi
367 my $cust_pkgs = @_ ? shift : {};
369 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
370 warn "cust_main::insert using deprecated invoicing list argument";
371 $invoicing_list = shift;
374 warn "$me insert called with options ".
375 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
378 local $SIG{HUP} = 'IGNORE';
379 local $SIG{INT} = 'IGNORE';
380 local $SIG{QUIT} = 'IGNORE';
381 local $SIG{TERM} = 'IGNORE';
382 local $SIG{TSTP} = 'IGNORE';
383 local $SIG{PIPE} = 'IGNORE';
385 my $oldAutoCommit = $FS::UID::AutoCommit;
386 local $FS::UID::AutoCommit = 0;
389 my $prepay_identifier = '';
390 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
392 if ( $self->payby eq 'PREPAY' ) {
394 $self->payby(''); #'BILL');
395 $prepay_identifier = $self->payinfo;
398 warn " looking up prepaid card $prepay_identifier\n"
401 my $error = $self->get_prepay( $prepay_identifier,
402 'amount_ref' => \$amount,
403 'seconds_ref' => \$seconds,
404 'upbytes_ref' => \$upbytes,
405 'downbytes_ref' => \$downbytes,
406 'totalbytes_ref' => \$totalbytes,
409 $dbh->rollback if $oldAutoCommit;
410 #return "error applying prepaid card (transaction rolled back): $error";
414 $payby = 'PREP' if $amount;
416 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
419 $self->payby(''); #'BILL');
420 $amount = $self->paid;
425 foreach my $l (qw(bill_location ship_location)) {
427 my $loc = delete $self->hashref->{$l} or next;
429 if ( !$loc->locationnum ) {
430 # warn the location that we're going to insert it with no custnum
431 $loc->set(custnum_pending => 1);
432 warn " inserting $l\n"
434 my $error = $loc->insert;
436 $dbh->rollback if $oldAutoCommit;
437 my $label = $l eq 'ship_location' ? 'service' : 'billing';
438 return "$error (in $label location)";
441 } elsif ( $loc->prospectnum ) {
443 $loc->prospectnum('');
444 $loc->set(custnum_pending => 1);
445 my $error = $loc->replace;
447 $dbh->rollback if $oldAutoCommit;
448 my $label = $l eq 'ship_location' ? 'service' : 'billing';
449 return "$error (moving $label location)";
452 } elsif ( ($loc->custnum || 0) > 0 ) {
453 # then it somehow belongs to another customer--shouldn't happen
454 $dbh->rollback if $oldAutoCommit;
455 return "$l belongs to customer ".$loc->custnum;
457 # else it already belongs to this customer
458 # (happens when ship_location is identical to bill_location)
460 $self->set($l.'num', $loc->locationnum);
462 if ( $self->get($l.'num') eq '' ) {
463 $dbh->rollback if $oldAutoCommit;
468 warn " inserting $self\n"
471 $self->signupdate(time) unless $self->signupdate;
473 $self->auto_agent_custid()
474 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
476 my $error = $self->check_payinfo_cardtype
477 || $self->SUPER::insert;
479 $dbh->rollback if $oldAutoCommit;
480 #return "inserting cust_main record (transaction rolled back): $error";
484 # now set cust_location.custnum
485 foreach my $l (qw(bill_location ship_location)) {
486 warn " setting $l.custnum\n"
488 my $loc = $self->$l or next;
489 unless ( $loc->custnum ) {
490 $loc->set(custnum => $self->custnum);
491 $error ||= $loc->replace;
495 $dbh->rollback if $oldAutoCommit;
496 return "error setting $l custnum: $error";
500 warn " setting customer tags\n"
503 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
504 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
505 'custnum' => $self->custnum };
506 my $error = $cust_tag->insert;
508 $dbh->rollback if $oldAutoCommit;
513 my $prospectnum = delete $options{'prospectnum'};
514 if ( $prospectnum ) {
516 warn " moving contacts and locations from prospect $prospectnum\n"
520 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
521 unless ( $prospect_main ) {
522 $dbh->rollback if $oldAutoCommit;
523 return "Unknown prospectnum $prospectnum";
525 $prospect_main->custnum($self->custnum);
526 $prospect_main->disabled('Y');
527 my $error = $prospect_main->replace;
529 $dbh->rollback if $oldAutoCommit;
533 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
534 my $cust_contact = new FS::cust_contact {
535 'custnum' => $self->custnum,
536 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
537 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
539 my $error = $cust_contact->insert
540 || $prospect_contact->delete;
542 $dbh->rollback if $oldAutoCommit;
547 my @cust_location = $prospect_main->cust_location;
548 my @qual = $prospect_main->qual;
550 foreach my $r ( @cust_location, @qual ) {
552 $r->custnum($self->custnum);
553 my $error = $r->replace;
555 $dbh->rollback if $oldAutoCommit;
559 # since we set invoice_dest on all migrated prospect contacts (for now),
560 # don't process invoicing_list.
561 delete $options{'invoicing_list'};
562 $invoicing_list = undef;
565 warn " setting contacts\n"
568 $invoicing_list ||= $options{'invoicing_list'};
569 if ( $invoicing_list ) {
571 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
574 foreach my $dest (@$invoicing_list ) {
575 if ($dest eq 'POST') {
576 $self->set('postal_invoice', 'Y');
579 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
580 if ( $contact_email ) {
581 my $cust_contact = FS::cust_contact->new({
582 contactnum => $contact_email->contactnum,
583 custnum => $self->custnum,
585 $cust_contact->set('invoice_dest', 'Y');
586 my $error = $cust_contact->insert;
588 $dbh->rollback if $oldAutoCommit;
589 return "$error (linking to email address $dest)";
593 # this email address is not yet linked to any contact
594 $email .= ',' if length($email);
600 my $contact = FS::contact->new({
601 'custnum' => $self->get('custnum'),
602 'last' => $self->get('last'),
603 'first' => $self->get('first'),
604 'emailaddress' => $email,
605 'invoice_dest' => 'Y', # yes, you can set this via the contact
607 my $error = $contact->insert;
609 $dbh->rollback if $oldAutoCommit;
615 if ( my $contact = delete $options{'contact'} ) {
617 foreach my $c ( @$contact ) {
618 $c->custnum($self->custnum);
619 my $error = $c->insert;
621 $dbh->rollback if $oldAutoCommit;
627 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
629 my $error = $self->process_o2m( 'table' => 'contact',
630 'fields' => FS::contact->cgi_contact_fields,
631 'params' => $contact_params,
634 $dbh->rollback if $oldAutoCommit;
639 warn " setting cust_payby\n"
642 if ( $options{cust_payby} ) {
644 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
645 $cust_payby->custnum($self->custnum);
646 my $error = $cust_payby->insert;
648 $dbh->rollback if $oldAutoCommit;
653 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
655 my $error = $self->process_o2m(
656 'table' => 'cust_payby',
657 'fields' => FS::cust_payby->cgi_cust_payby_fields,
658 'params' => $cust_payby_params,
659 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
662 $dbh->rollback if $oldAutoCommit;
668 warn " setting cust_main_exemption\n"
671 my $tax_exemption = delete $options{'tax_exemption'};
672 if ( $tax_exemption ) {
674 $tax_exemption = { map { $_ => '' } @$tax_exemption }
675 if ref($tax_exemption) eq 'ARRAY';
677 foreach my $taxname ( keys %$tax_exemption ) {
678 my $cust_main_exemption = new FS::cust_main_exemption {
679 'custnum' => $self->custnum,
680 'taxname' => $taxname,
681 'exempt_number' => $tax_exemption->{$taxname},
683 my $error = $cust_main_exemption->insert;
685 $dbh->rollback if $oldAutoCommit;
686 return "inserting cust_main_exemption (transaction rolled back): $error";
691 warn " ordering packages\n"
694 $error = $self->order_pkgs( $cust_pkgs,
696 'seconds_ref' => \$seconds,
697 'upbytes_ref' => \$upbytes,
698 'downbytes_ref' => \$downbytes,
699 'totalbytes_ref' => \$totalbytes,
702 $dbh->rollback if $oldAutoCommit;
707 $dbh->rollback if $oldAutoCommit;
708 return "No svc_acct record to apply pre-paid time";
710 if ( $upbytes || $downbytes || $totalbytes ) {
711 $dbh->rollback if $oldAutoCommit;
712 return "No svc_acct record to apply pre-paid data";
716 warn " inserting initial $payby payment of $amount\n"
718 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
720 $dbh->rollback if $oldAutoCommit;
721 return "inserting payment (transaction rolled back): $error";
725 unless ( $import || $skip_fuzzyfiles ) {
726 warn " queueing fuzzyfiles update\n"
728 $error = $self->queue_fuzzyfiles_update;
730 $dbh->rollback if $oldAutoCommit;
731 return "updating fuzzy search cache: $error";
735 # FS::geocode_Mixin::after_insert or something?
736 if ( $conf->config('tax_district_method') and !$import ) {
737 # if anything non-empty, try to look it up
738 my $queue = new FS::queue {
739 'job' => 'FS::geocode_Mixin::process_district_update',
740 'custnum' => $self->custnum,
742 my $error = $queue->insert( ref($self), $self->custnum );
744 $dbh->rollback if $oldAutoCommit;
745 return "queueing tax district update: $error";
750 warn " exporting\n" if $DEBUG > 1;
752 my $export_args = $options{'export_args'} || [];
755 map qsearch( 'part_export', {exportnum=>$_} ),
756 $conf->config('cust_main-exports'); #, $agentnum
758 foreach my $part_export ( @part_export ) {
759 my $error = $part_export->export_insert($self, @$export_args);
761 $dbh->rollback if $oldAutoCommit;
762 return "exporting to ". $part_export->exporttype.
763 " (transaction rolled back): $error";
767 #foreach my $depend_jobnum ( @$depend_jobnums ) {
768 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
770 # foreach my $jobnum ( @jobnums ) {
771 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
772 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
774 # my $error = $queue->depend_insert($depend_jobnum);
776 # $dbh->rollback if $oldAutoCommit;
777 # return "error queuing job dependancy: $error";
784 #if ( exists $options{'jobnums'} ) {
785 # push @{ $options{'jobnums'} }, @jobnums;
788 warn " insert complete; committing transaction\n"
791 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
796 use File::CounterFile;
797 sub auto_agent_custid {
800 my $format = $conf->config('cust_main-auto_agent_custid');
802 if ( $format eq '1YMMXXXXXXXX' ) {
804 my $counter = new File::CounterFile 'cust_main.agent_custid';
807 my $ym = 100000000000 + time2str('%y%m00000000', time);
808 if ( $ym > $counter->value ) {
809 $counter->{'value'} = $agent_custid = $ym;
810 $counter->{'updated'} = 1;
812 $agent_custid = $counter->inc;
818 die "Unknown cust_main-auto_agent_custid format: $format";
821 $self->agent_custid($agent_custid);
825 =item PACKAGE METHODS
827 Documentation on customer package methods has been moved to
828 L<FS::cust_main::Packages>.
830 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
832 Recharges this (existing) customer with the specified prepaid card (see
833 L<FS::prepay_credit>), specified either by I<identifier> or as an
834 FS::prepay_credit object. If there is an error, returns the error, otherwise
837 Optionally, five scalar references can be passed as well. They will have their
838 values filled in with the amount, number of seconds, and number of upload,
839 download, and total bytes applied by this prepaid card.
843 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
844 #the only place that uses these args
845 sub recharge_prepay {
846 my( $self, $prepay_credit, $amountref, $secondsref,
847 $upbytesref, $downbytesref, $totalbytesref ) = @_;
849 local $SIG{HUP} = 'IGNORE';
850 local $SIG{INT} = 'IGNORE';
851 local $SIG{QUIT} = 'IGNORE';
852 local $SIG{TERM} = 'IGNORE';
853 local $SIG{TSTP} = 'IGNORE';
854 local $SIG{PIPE} = 'IGNORE';
856 my $oldAutoCommit = $FS::UID::AutoCommit;
857 local $FS::UID::AutoCommit = 0;
860 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
862 my $error = $self->get_prepay( $prepay_credit,
863 'amount_ref' => \$amount,
864 'seconds_ref' => \$seconds,
865 'upbytes_ref' => \$upbytes,
866 'downbytes_ref' => \$downbytes,
867 'totalbytes_ref' => \$totalbytes,
869 || $self->increment_seconds($seconds)
870 || $self->increment_upbytes($upbytes)
871 || $self->increment_downbytes($downbytes)
872 || $self->increment_totalbytes($totalbytes)
873 || $self->insert_cust_pay_prepay( $amount,
875 ? $prepay_credit->identifier
880 $dbh->rollback if $oldAutoCommit;
884 if ( defined($amountref) ) { $$amountref = $amount; }
885 if ( defined($secondsref) ) { $$secondsref = $seconds; }
886 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
887 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
888 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
890 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
895 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
897 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
898 specified either by I<identifier> or as an FS::prepay_credit object.
900 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
901 incremented by the values of the prepaid card.
903 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
904 check or set this customer's I<agentnum>.
906 If there is an error, returns the error, otherwise returns false.
912 my( $self, $prepay_credit, %opt ) = @_;
914 local $SIG{HUP} = 'IGNORE';
915 local $SIG{INT} = 'IGNORE';
916 local $SIG{QUIT} = 'IGNORE';
917 local $SIG{TERM} = 'IGNORE';
918 local $SIG{TSTP} = 'IGNORE';
919 local $SIG{PIPE} = 'IGNORE';
921 my $oldAutoCommit = $FS::UID::AutoCommit;
922 local $FS::UID::AutoCommit = 0;
925 unless ( ref($prepay_credit) ) {
927 my $identifier = $prepay_credit;
929 $prepay_credit = qsearchs(
931 { 'identifier' => $identifier },
936 unless ( $prepay_credit ) {
937 $dbh->rollback if $oldAutoCommit;
938 return "Invalid prepaid card: ". $identifier;
943 if ( $prepay_credit->agentnum ) {
944 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
945 $dbh->rollback if $oldAutoCommit;
946 return "prepaid card not valid for agent ". $self->agentnum;
948 $self->agentnum($prepay_credit->agentnum);
951 my $error = $prepay_credit->delete;
953 $dbh->rollback if $oldAutoCommit;
954 return "removing prepay_credit (transaction rolled back): $error";
957 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
958 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
960 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
965 =item increment_upbytes SECONDS
967 Updates this customer's single or primary account (see L<FS::svc_acct>) by
968 the specified number of upbytes. If there is an error, returns the error,
969 otherwise returns false.
973 sub increment_upbytes {
974 _increment_column( shift, 'upbytes', @_);
977 =item increment_downbytes SECONDS
979 Updates this customer's single or primary account (see L<FS::svc_acct>) by
980 the specified number of downbytes. If there is an error, returns the error,
981 otherwise returns false.
985 sub increment_downbytes {
986 _increment_column( shift, 'downbytes', @_);
989 =item increment_totalbytes SECONDS
991 Updates this customer's single or primary account (see L<FS::svc_acct>) by
992 the specified number of totalbytes. If there is an error, returns the error,
993 otherwise returns false.
997 sub increment_totalbytes {
998 _increment_column( shift, 'totalbytes', @_);
1001 =item increment_seconds SECONDS
1003 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1004 the specified number of seconds. If there is an error, returns the error,
1005 otherwise returns false.
1009 sub increment_seconds {
1010 _increment_column( shift, 'seconds', @_);
1013 =item _increment_column AMOUNT
1015 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1016 the specified number of seconds or bytes. If there is an error, returns
1017 the error, otherwise returns false.
1021 sub _increment_column {
1022 my( $self, $column, $amount ) = @_;
1023 warn "$me increment_column called: $column, $amount\n"
1026 return '' unless $amount;
1028 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1029 $self->ncancelled_pkgs;
1031 if ( ! @cust_pkg ) {
1032 return 'No packages with primary or single services found'.
1033 ' to apply pre-paid time';
1034 } elsif ( scalar(@cust_pkg) > 1 ) {
1035 #maybe have a way to specify the package/account?
1036 return 'Multiple packages found to apply pre-paid time';
1039 my $cust_pkg = $cust_pkg[0];
1040 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1044 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1046 if ( ! @cust_svc ) {
1047 return 'No account found to apply pre-paid time';
1048 } elsif ( scalar(@cust_svc) > 1 ) {
1049 return 'Multiple accounts found to apply pre-paid time';
1052 my $svc_acct = $cust_svc[0]->svc_x;
1053 warn " found service svcnum ". $svc_acct->pkgnum.
1054 ' ('. $svc_acct->email. ")\n"
1057 $column = "increment_$column";
1058 $svc_acct->$column($amount);
1062 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1064 Inserts a prepayment in the specified amount for this customer. An optional
1065 second argument can specify the prepayment identifier for tracking purposes.
1066 If there is an error, returns the error, otherwise returns false.
1070 sub insert_cust_pay_prepay {
1071 shift->insert_cust_pay('PREP', @_);
1074 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1076 Inserts a cash payment in the specified amount for this customer. An optional
1077 second argument can specify the payment identifier for tracking purposes.
1078 If there is an error, returns the error, otherwise returns false.
1082 sub insert_cust_pay_cash {
1083 shift->insert_cust_pay('CASH', @_);
1086 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1088 Inserts a Western Union payment in the specified amount for this customer. An
1089 optional second argument can specify the prepayment identifier for tracking
1090 purposes. If there is an error, returns the error, otherwise returns false.
1094 sub insert_cust_pay_west {
1095 shift->insert_cust_pay('WEST', @_);
1098 sub insert_cust_pay {
1099 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1100 my $payinfo = scalar(@_) ? shift : '';
1102 my $cust_pay = new FS::cust_pay {
1103 'custnum' => $self->custnum,
1104 'paid' => sprintf('%.2f', $amount),
1105 #'_date' => #date the prepaid card was purchased???
1107 'payinfo' => $payinfo,
1113 =item delete [ OPTION => VALUE ... ]
1115 This deletes the customer. If there is an error, returns the error, otherwise
1118 This will completely remove all traces of the customer record. This is not
1119 what you want when a customer cancels service; for that, cancel all of the
1120 customer's packages (see L</cancel>).
1122 If the customer has any uncancelled packages, you need to pass a new (valid)
1123 customer number for those packages to be transferred to, as the "new_customer"
1124 option. Cancelled packages will be deleted. Did I mention that this is NOT
1125 what you want when a customer cancels service and that you really should be
1126 looking at L<FS::cust_pkg/cancel>?
1128 You can't delete a customer with invoices (see L<FS::cust_bill>),
1129 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1130 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1131 set the "delete_financials" option to a true value.
1136 my( $self, %opt ) = @_;
1138 local $SIG{HUP} = 'IGNORE';
1139 local $SIG{INT} = 'IGNORE';
1140 local $SIG{QUIT} = 'IGNORE';
1141 local $SIG{TERM} = 'IGNORE';
1142 local $SIG{TSTP} = 'IGNORE';
1143 local $SIG{PIPE} = 'IGNORE';
1145 my $oldAutoCommit = $FS::UID::AutoCommit;
1146 local $FS::UID::AutoCommit = 0;
1149 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1150 $dbh->rollback if $oldAutoCommit;
1151 return "Can't delete a master agent customer";
1154 #use FS::access_user
1155 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1156 $dbh->rollback if $oldAutoCommit;
1157 return "Can't delete a master employee customer";
1160 tie my %financial_tables, 'Tie::IxHash',
1161 'cust_bill' => 'invoices',
1162 'cust_statement' => 'statements',
1163 'cust_credit' => 'credits',
1164 'cust_pay' => 'payments',
1165 'cust_refund' => 'refunds',
1168 foreach my $table ( keys %financial_tables ) {
1170 my @records = $self->$table();
1172 if ( @records && ! $opt{'delete_financials'} ) {
1173 $dbh->rollback if $oldAutoCommit;
1174 return "Can't delete a customer with ". $financial_tables{$table};
1177 foreach my $record ( @records ) {
1178 my $error = $record->delete;
1180 $dbh->rollback if $oldAutoCommit;
1181 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1187 my @cust_pkg = $self->ncancelled_pkgs;
1189 my $new_custnum = $opt{'new_custnum'};
1190 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1191 $dbh->rollback if $oldAutoCommit;
1192 return "Invalid new customer number: $new_custnum";
1194 foreach my $cust_pkg ( @cust_pkg ) {
1195 my %hash = $cust_pkg->hash;
1196 $hash{'custnum'} = $new_custnum;
1197 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1198 my $error = $new_cust_pkg->replace($cust_pkg,
1199 options => { $cust_pkg->options },
1202 $dbh->rollback if $oldAutoCommit;
1207 my @cancelled_cust_pkg = $self->all_pkgs;
1208 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1209 my $error = $cust_pkg->delete;
1211 $dbh->rollback if $oldAutoCommit;
1216 #cust_tax_adjustment in financials?
1217 #cust_pay_pending? ouch
1218 foreach my $table (qw(
1219 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1220 cust_payby cust_location cust_main_note cust_tax_adjustment
1221 cust_pay_void cust_pay_batch queue cust_tax_exempt
1223 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1224 my $error = $record->delete;
1226 $dbh->rollback if $oldAutoCommit;
1232 my $sth = $dbh->prepare(
1233 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1235 my $errstr = $dbh->errstr;
1236 $dbh->rollback if $oldAutoCommit;
1239 $sth->execute($self->custnum) or do {
1240 my $errstr = $sth->errstr;
1241 $dbh->rollback if $oldAutoCommit;
1247 my $ticket_dbh = '';
1248 if ($conf->config('ticket_system') eq 'RT_Internal') {
1250 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1251 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1252 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1253 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1256 if ( $ticket_dbh ) {
1258 my $ticket_sth = $ticket_dbh->prepare(
1259 'DELETE FROM Links WHERE Target = ?'
1261 my $errstr = $ticket_dbh->errstr;
1262 $dbh->rollback if $oldAutoCommit;
1265 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1267 my $errstr = $ticket_sth->errstr;
1268 $dbh->rollback if $oldAutoCommit;
1272 #check and see if the customer is the only link on the ticket, and
1273 #if so, set the ticket to deleted status in RT?
1274 #maybe someday, for now this will at least fix tickets not displaying
1278 #delete the customer record
1280 my $error = $self->SUPER::delete;
1282 $dbh->rollback if $oldAutoCommit;
1286 # cust_main exports!
1288 #my $export_args = $options{'export_args'} || [];
1291 map qsearch( 'part_export', {exportnum=>$_} ),
1292 $conf->config('cust_main-exports'); #, $agentnum
1294 foreach my $part_export ( @part_export ) {
1295 my $error = $part_export->export_delete( $self ); #, @$export_args);
1297 $dbh->rollback if $oldAutoCommit;
1298 return "exporting to ". $part_export->exporttype.
1299 " (transaction rolled back): $error";
1303 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1308 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1310 Replaces the OLD_RECORD with this one in the database. If there is an error,
1311 returns the error, otherwise returns false.
1313 To change the customer's address, set the pseudo-fields C<bill_location> and
1314 C<ship_location>. The address will still only change if at least one of the
1315 address fields differs from the existing values.
1317 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1318 set as the contact email address for a default contact with the same name as
1321 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1322 I<contact_params>, I<invoicing_list>.
1324 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1325 of tax names and exemption numbers. FS::cust_main_exemption records will be
1326 deleted and inserted as appropriate.
1328 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1329 groups (describing the customer's payment methods and contacts, respectively)
1330 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1331 and L<FS::contact> for the fields these can contain.
1333 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1334 should be used instead if possible.
1341 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1343 : $self->replace_old;
1347 warn "$me replace called\n"
1350 my $curuser = $FS::CurrentUser::CurrentUser;
1351 return "You are not permitted to create complimentary accounts."
1352 if $self->complimentary eq 'Y'
1353 && $self->complimentary ne $old->complimentary
1354 && ! $curuser->access_right('Complimentary customer');
1356 local($ignore_expired_card) = 1
1357 if $old->payby =~ /^(CARD|DCRD)$/
1358 && $self->payby =~ /^(CARD|DCRD)$/
1359 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1361 local($ignore_banned_card) = 1
1362 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1363 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1364 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1366 if ( $self->payby =~ /^(CARD|DCRD)$/
1367 && $old->payinfo ne $self->payinfo
1368 && $old->paymask ne $self->paymask )
1370 my $error = $self->check_payinfo_cardtype;
1371 return $error if $error;
1374 return "Invoicing locale is required"
1377 && $conf->exists('cust_main-require_locale');
1379 local $SIG{HUP} = 'IGNORE';
1380 local $SIG{INT} = 'IGNORE';
1381 local $SIG{QUIT} = 'IGNORE';
1382 local $SIG{TERM} = 'IGNORE';
1383 local $SIG{TSTP} = 'IGNORE';
1384 local $SIG{PIPE} = 'IGNORE';
1386 my $oldAutoCommit = $FS::UID::AutoCommit;
1387 local $FS::UID::AutoCommit = 0;
1390 for my $l (qw(bill_location ship_location)) {
1391 #my $old_loc = $old->$l;
1392 my $new_loc = $self->$l or next;
1394 # find the existing location if there is one
1395 $new_loc->set('custnum' => $self->custnum);
1396 my $error = $new_loc->find_or_insert;
1398 $dbh->rollback if $oldAutoCommit;
1401 $self->set($l.'num', $new_loc->locationnum);
1405 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1406 warn "cust_main::replace: using deprecated invoicing list argument";
1407 $invoicing_list = shift @param;
1410 my %options = @param;
1412 $invoicing_list ||= $options{invoicing_list};
1414 my @contacts = map { $_->contact } $self->cust_contact;
1415 # find a contact that matches the customer's name
1416 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1417 and $_->last eq $old->get('last') }
1419 $implicit_contact ||= FS::contact->new({
1420 'custnum' => $self->custnum,
1421 'locationnum' => $self->get('bill_locationnum'),
1424 # for any of these that are already contact emails, link to the existing
1426 if ( $invoicing_list ) {
1429 # kind of like process_m2m on these, except:
1430 # - the other side is two tables in a join
1431 # - and we might have to create new contact_emails
1432 # - and possibly a new contact
1434 # Find existing invoice emails that aren't on the implicit contact.
1435 # Any of these that are not on the new invoicing list will be removed.
1436 my %old_email_cust_contact;
1437 foreach my $cust_contact ($self->cust_contact) {
1438 next if !$cust_contact->invoice_dest;
1439 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1441 foreach my $contact_email ($cust_contact->contact->contact_email) {
1442 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1446 foreach my $dest (@$invoicing_list) {
1448 if ($dest eq 'POST') {
1450 $self->set('postal_invoice', 'Y');
1452 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1454 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1458 # See if it belongs to some other contact; if so, link it.
1459 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1461 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1462 my $cust_contact = qsearchs('cust_contact', {
1463 contactnum => $contact_email->contactnum,
1464 custnum => $self->custnum,
1465 }) || FS::cust_contact->new({
1466 contactnum => $contact_email->contactnum,
1467 custnum => $self->custnum,
1469 $cust_contact->set('invoice_dest', 'Y');
1470 my $error = $cust_contact->custcontactnum ?
1471 $cust_contact->replace : $cust_contact->insert;
1473 $dbh->rollback if $oldAutoCommit;
1474 return "$error (linking to email address $dest)";
1478 # This email address is not yet linked to any contact, so it will
1479 # be added to the implicit contact.
1480 $email .= ',' if length($email);
1486 foreach my $remove_dest (keys %old_email_cust_contact) {
1487 my $cust_contact = $old_email_cust_contact{$remove_dest};
1488 # These were not in the list of requested destinations, so take them off.
1489 $cust_contact->set('invoice_dest', '');
1490 my $error = $cust_contact->replace;
1492 $dbh->rollback if $oldAutoCommit;
1493 return "$error (unlinking email address $remove_dest)";
1497 # make sure it keeps up with the changed customer name, if any
1498 $implicit_contact->set('last', $self->get('last'));
1499 $implicit_contact->set('first', $self->get('first'));
1500 $implicit_contact->set('emailaddress', $email);
1501 $implicit_contact->set('invoice_dest', 'Y');
1502 $implicit_contact->set('custnum', $self->custnum);
1505 if ( $implicit_contact->contactnum ) {
1506 $error = $implicit_contact->replace;
1507 } elsif ( length($email) ) { # don't create a new contact if not needed
1508 $error = $implicit_contact->insert;
1512 $dbh->rollback if $oldAutoCommit;
1513 return "$error (adding email address $email)";
1518 # replace the customer record
1519 my $error = $self->SUPER::replace($old);
1522 $dbh->rollback if $oldAutoCommit;
1526 # now move packages to the new service location
1527 $self->set('ship_location', ''); #flush cache
1528 if ( $old->ship_locationnum and # should only be null during upgrade...
1529 $old->ship_locationnum != $self->ship_locationnum ) {
1530 $error = $old->ship_location->move_to($self->ship_location);
1532 $dbh->rollback if $oldAutoCommit;
1536 # don't move packages based on the billing location, but
1537 # disable it if it's no longer in use
1538 if ( $old->bill_locationnum and
1539 $old->bill_locationnum != $self->bill_locationnum ) {
1540 $error = $old->bill_location->disable_if_unused;
1542 $dbh->rollback if $oldAutoCommit;
1547 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1549 #this could be more efficient than deleting and re-inserting, if it matters
1550 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1551 my $error = $cust_tag->delete;
1553 $dbh->rollback if $oldAutoCommit;
1557 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1558 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1559 'custnum' => $self->custnum };
1560 my $error = $cust_tag->insert;
1562 $dbh->rollback if $oldAutoCommit;
1569 my $tax_exemption = delete $options{'tax_exemption'};
1570 if ( $tax_exemption ) {
1572 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1573 if ref($tax_exemption) eq 'ARRAY';
1575 my %cust_main_exemption =
1576 map { $_->taxname => $_ }
1577 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1579 foreach my $taxname ( keys %$tax_exemption ) {
1581 if ( $cust_main_exemption{$taxname} &&
1582 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1585 delete $cust_main_exemption{$taxname};
1589 my $cust_main_exemption = new FS::cust_main_exemption {
1590 'custnum' => $self->custnum,
1591 'taxname' => $taxname,
1592 'exempt_number' => $tax_exemption->{$taxname},
1594 my $error = $cust_main_exemption->insert;
1596 $dbh->rollback if $oldAutoCommit;
1597 return "inserting cust_main_exemption (transaction rolled back): $error";
1601 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1602 my $error = $cust_main_exemption->delete;
1604 $dbh->rollback if $oldAutoCommit;
1605 return "deleting cust_main_exemption (transaction rolled back): $error";
1611 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1613 my $error = $self->process_o2m(
1614 'table' => 'cust_payby',
1615 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1616 'params' => $cust_payby_params,
1617 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1620 $dbh->rollback if $oldAutoCommit;
1626 if ( my $contact_params = delete $options{'contact_params'} ) {
1628 # this can potentially replace contacts that were created by the
1629 # invoicing list argument, but the UI shouldn't allow both of them
1632 my $error = $self->process_o2m(
1633 'table' => 'contact',
1634 'fields' => FS::contact->cgi_contact_fields,
1635 'params' => $contact_params,
1638 $dbh->rollback if $oldAutoCommit;
1644 unless ( $import || $skip_fuzzyfiles ) {
1645 $error = $self->queue_fuzzyfiles_update;
1647 $dbh->rollback if $oldAutoCommit;
1648 return "updating fuzzy search cache: $error";
1652 # tax district update in cust_location
1654 # cust_main exports!
1656 my $export_args = $options{'export_args'} || [];
1659 map qsearch( 'part_export', {exportnum=>$_} ),
1660 $conf->config('cust_main-exports'); #, $agentnum
1662 foreach my $part_export ( @part_export ) {
1663 my $error = $part_export->export_replace( $self, $old, @$export_args);
1665 $dbh->rollback if $oldAutoCommit;
1666 return "exporting to ". $part_export->exporttype.
1667 " (transaction rolled back): $error";
1671 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1676 =item queue_fuzzyfiles_update
1678 Used by insert & replace to update the fuzzy search cache
1682 use FS::cust_main::Search;
1683 sub queue_fuzzyfiles_update {
1686 local $SIG{HUP} = 'IGNORE';
1687 local $SIG{INT} = 'IGNORE';
1688 local $SIG{QUIT} = 'IGNORE';
1689 local $SIG{TERM} = 'IGNORE';
1690 local $SIG{TSTP} = 'IGNORE';
1691 local $SIG{PIPE} = 'IGNORE';
1693 my $oldAutoCommit = $FS::UID::AutoCommit;
1694 local $FS::UID::AutoCommit = 0;
1697 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1698 my $queue = new FS::queue {
1699 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1701 my @args = "cust_main.$field", $self->get($field);
1702 my $error = $queue->insert( @args );
1704 $dbh->rollback if $oldAutoCommit;
1705 return "queueing job (transaction rolled back): $error";
1710 push @locations, $self->bill_location if $self->bill_locationnum;
1711 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1712 foreach my $location (@locations) {
1713 my $queue = new FS::queue {
1714 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1716 my @args = 'cust_location.address1', $location->address1;
1717 my $error = $queue->insert( @args );
1719 $dbh->rollback if $oldAutoCommit;
1720 return "queueing job (transaction rolled back): $error";
1724 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1731 Checks all fields to make sure this is a valid customer record. If there is
1732 an error, returns the error, otherwise returns false. Called by the insert
1733 and replace methods.
1740 warn "$me check BEFORE: \n". $self->_dump
1744 $self->ut_numbern('custnum')
1745 || $self->ut_number('agentnum')
1746 || $self->ut_textn('agent_custid')
1747 || $self->ut_number('refnum')
1748 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1749 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1750 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1751 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1752 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1753 || $self->ut_textn('custbatch')
1754 || $self->ut_name('last')
1755 || $self->ut_name('first')
1756 || $self->ut_snumbern('signupdate')
1757 || $self->ut_snumbern('birthdate')
1758 || $self->ut_namen('spouse_last')
1759 || $self->ut_namen('spouse_first')
1760 || $self->ut_snumbern('spouse_birthdate')
1761 || $self->ut_snumbern('anniversary_date')
1762 || $self->ut_textn('company')
1763 || $self->ut_textn('ship_company')
1764 || $self->ut_anything('comments')
1765 || $self->ut_numbern('referral_custnum')
1766 || $self->ut_textn('stateid')
1767 || $self->ut_textn('stateid_state')
1768 || $self->ut_textn('invoice_terms')
1769 || $self->ut_floatn('cdr_termination_percentage')
1770 || $self->ut_floatn('credit_limit')
1771 || $self->ut_numbern('billday')
1772 || $self->ut_numbern('prorate_day')
1773 || $self->ut_flag('edit_subject')
1774 || $self->ut_flag('calling_list_exempt')
1775 || $self->ut_flag('invoice_noemail')
1776 || $self->ut_flag('message_noemail')
1777 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1778 || $self->ut_currencyn('currency')
1779 || $self->ut_textn('po_number')
1780 || $self->ut_enum('complimentary', [ '', 'Y' ])
1781 || $self->ut_flag('invoice_ship_address')
1782 || $self->ut_flag('invoice_dest')
1785 foreach (qw(company ship_company)) {
1786 my $company = $self->get($_);
1787 $company =~ s/^\s+//;
1788 $company =~ s/\s+$//;
1789 $company =~ s/\s+/ /g;
1790 $self->set($_, $company);
1793 #barf. need message catalogs. i18n. etc.
1794 $error .= "Please select an advertising source."
1795 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1796 return $error if $error;
1798 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1799 or return "Unknown agent";
1801 if ( $self->currency ) {
1802 my $agent_currency = qsearchs( 'agent_currency', {
1803 'agentnum' => $agent->agentnum,
1804 'currency' => $self->currency,
1806 or return "Agent ". $agent->agent.
1807 " not permitted to offer ". $self->currency. " invoicing";
1810 return "Unknown refnum"
1811 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1813 return "Unknown referring custnum: ". $self->referral_custnum
1814 unless ! $self->referral_custnum
1815 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1817 if ( $self->ss eq '' ) {
1822 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1823 or return "Illegal social security number: ". $self->ss;
1824 $self->ss("$1-$2-$3");
1827 #turn off invoice_ship_address if ship & bill are the same
1828 if ($self->bill_locationnum eq $self->ship_locationnum) {
1829 $self->invoice_ship_address('');
1832 # cust_main_county verification now handled by cust_location check
1835 $self->ut_phonen('daytime', $self->country)
1836 || $self->ut_phonen('night', $self->country)
1837 || $self->ut_phonen('fax', $self->country)
1838 || $self->ut_phonen('mobile', $self->country)
1840 return $error if $error;
1842 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1844 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1847 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1849 : FS::Msgcat::_gettext('daytime');
1850 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1852 : FS::Msgcat::_gettext('night');
1854 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1856 : FS::Msgcat::_gettext('mobile');
1858 return "$daytime_label, $night_label or $mobile_label is required"
1862 ### start of stuff moved to cust_payby
1863 # then mostly kept here to support upgrades (can remove in 5.x)
1864 # but modified to allow everything to be empty
1866 if ( $self->payby ) {
1867 FS::payby->can_payby($self->table, $self->payby)
1868 or return "Illegal payby: ". $self->payby;
1873 $error = $self->ut_numbern('paystart_month')
1874 || $self->ut_numbern('paystart_year')
1875 || $self->ut_numbern('payissue')
1876 || $self->ut_textn('paytype')
1878 return $error if $error;
1880 if ( $self->payip eq '' ) {
1883 $error = $self->ut_ip('payip');
1884 return $error if $error;
1887 # If it is encrypted and the private key is not availaible then we can't
1888 # check the credit card.
1889 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1891 # Need some kind of global flag to accept invalid cards, for testing
1893 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1894 $self->payby =~ /^(CARD|DCRD)$/ ) {
1896 my $payinfo = $self->payinfo;
1897 $payinfo =~ s/\D//g;
1898 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1899 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1901 $self->payinfo($payinfo);
1903 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1905 return gettext('unknown_card_type')
1906 if $self->payinfo !~ /^99\d{14}$/ #token
1907 && cardtype($self->payinfo) eq "Unknown";
1909 unless ( $ignore_banned_card ) {
1910 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1912 if ( $ban->bantype eq 'warn' ) {
1913 #or others depending on value of $ban->reason ?
1914 return '_duplicate_card'.
1915 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1916 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1917 ' (ban# '. $ban->bannum. ')'
1918 unless $self->override_ban_warn;
1920 return 'Banned credit card: banned on '.
1921 time2str('%a %h %o at %r', $ban->_date).
1922 ' by '. $ban->otaker.
1923 ' (ban# '. $ban->bannum. ')';
1928 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1929 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1930 $self->paycvv =~ /^(\d{4})$/
1931 or return "CVV2 (CID) for American Express cards is four digits.";
1934 $self->paycvv =~ /^(\d{3})$/
1935 or return "CVV2 (CVC2/CID) is three digits.";
1942 my $cardtype = cardtype($payinfo);
1943 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1945 return "Start date or issue number is required for $cardtype cards"
1946 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1948 return "Start month must be between 1 and 12"
1949 if $self->paystart_month
1950 and $self->paystart_month < 1 || $self->paystart_month > 12;
1952 return "Start year must be 1990 or later"
1953 if $self->paystart_year
1954 and $self->paystart_year < 1990;
1956 return "Issue number must be beween 1 and 99"
1958 and $self->payissue < 1 || $self->payissue > 99;
1961 $self->paystart_month('');
1962 $self->paystart_year('');
1963 $self->payissue('');
1966 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1967 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1969 my $payinfo = $self->payinfo;
1970 $payinfo =~ s/[^\d\@\.]//g;
1971 if ( $conf->config('echeck-country') eq 'CA' ) {
1972 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1973 or return 'invalid echeck account@branch.bank';
1974 $payinfo = "$1\@$2.$3";
1975 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1976 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1977 $payinfo = "$1\@$2";
1979 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1980 $payinfo = "$1\@$2";
1982 $self->payinfo($payinfo);
1985 unless ( $ignore_banned_card ) {
1986 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1988 if ( $ban->bantype eq 'warn' ) {
1989 #or others depending on value of $ban->reason ?
1990 return '_duplicate_ach' unless $self->override_ban_warn;
1992 return 'Banned ACH account: banned on '.
1993 time2str('%a %h %o at %r', $ban->_date).
1994 ' by '. $ban->otaker.
1995 ' (ban# '. $ban->bannum. ')';
2000 } elsif ( $self->payby eq 'LECB' ) {
2002 my $payinfo = $self->payinfo;
2003 $payinfo =~ s/\D//g;
2004 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2006 $self->payinfo($payinfo);
2009 } elsif ( $self->payby eq 'BILL' ) {
2011 $error = $self->ut_textn('payinfo');
2012 return "Illegal P.O. number: ". $self->payinfo if $error;
2015 } elsif ( $self->payby eq 'COMP' ) {
2017 my $curuser = $FS::CurrentUser::CurrentUser;
2018 if ( ! $self->custnum
2019 && ! $curuser->access_right('Complimentary customer')
2022 return "You are not permitted to create complimentary accounts."
2025 $error = $self->ut_textn('payinfo');
2026 return "Illegal comp account issuer: ". $self->payinfo if $error;
2029 } elsif ( $self->payby eq 'PREPAY' ) {
2031 my $payinfo = $self->payinfo;
2032 $payinfo =~ s/\W//g; #anything else would just confuse things
2033 $self->payinfo($payinfo);
2034 $error = $self->ut_alpha('payinfo');
2035 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2036 return "Unknown prepayment identifier"
2037 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2042 return "You are not permitted to create complimentary accounts."
2044 && $self->complimentary eq 'Y'
2045 && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2047 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2048 return "Expiration date required"
2049 # shouldn't payinfo_check do this?
2050 unless ! $self->payby
2051 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2055 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2056 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2057 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2058 ( $m, $y ) = ( $2, "19$1" );
2059 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2060 ( $m, $y ) = ( $3, "20$2" );
2062 return "Illegal expiration date: ". $self->paydate;
2064 $m = sprintf('%02d',$m);
2065 $self->paydate("$y-$m-01");
2066 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2067 return gettext('expired_card')
2069 && !$ignore_expired_card
2070 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2073 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2074 ( ! $conf->exists('require_cardname')
2075 || $self->payby !~ /^(CARD|DCRD)$/ )
2077 $self->payname( $self->first. " ". $self->getfield('last') );
2080 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2081 $self->payname =~ /^([\w \,\.\-\']*)$/
2082 or return gettext('illegal_name'). " payname: ". $self->payname;
2085 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2086 or return gettext('illegal_name'). " payname: ". $self->payname;
2092 ### end of stuff moved to cust_payby
2094 return "Please select an invoicing locale"
2097 && $conf->exists('cust_main-require_locale');
2099 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2100 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2104 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2106 warn "$me check AFTER: \n". $self->_dump
2109 $self->SUPER::check;
2112 sub check_payinfo_cardtype {
2115 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2117 my $payinfo = $self->payinfo;
2118 $payinfo =~ s/\D//g;
2120 return '' if $payinfo =~ /^99\d{14}$/; #token
2122 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2123 my $cardtype = cardtype($payinfo);
2125 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2133 Additional checks for replace only.
2138 my ($new,$old) = @_;
2139 #preserve old value if global config is set
2140 if ($old && $conf->exists('invoice-ship_address')) {
2141 $new->invoice_ship_address($old->invoice_ship_address);
2148 Returns a list of fields which have ship_ duplicates.
2153 qw( last first company
2155 address1 address2 city county state zip country
2157 daytime night fax mobile
2161 =item has_ship_address
2163 Returns true if this customer record has a separate shipping address.
2167 sub has_ship_address {
2169 $self->bill_locationnum != $self->ship_locationnum;
2174 Returns a list of key/value pairs, with the following keys: address1,
2175 adddress2, city, county, state, zip, country, district, and geocode. The
2176 shipping address is used if present.
2182 $self->ship_location->location_hash;
2187 Returns all locations (see L<FS::cust_location>) for this customer.
2194 'table' => 'cust_location',
2195 'hashref' => { 'custnum' => $self->custnum,
2196 'prospectnum' => '',
2198 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2204 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2210 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2213 =item cust_payby PAYBY
2215 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2217 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2218 Does not validate PAYBY.
2226 'table' => 'cust_payby',
2227 'hashref' => { 'custnum' => $self->custnum },
2228 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2230 $search->{'extra_sql'} = ' AND payby IN ( '.
2231 join(',', map dbh->quote($_), @payby).
2238 =item has_cust_payby_auto
2240 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2244 sub has_cust_payby_auto {
2247 'table' => 'cust_payby',
2248 'hashref' => { 'custnum' => $self->custnum, },
2249 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2250 'order_by' => 'LIMIT 1',
2257 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2258 and L<FS::cust_pkg>) for this customer, except those on hold.
2260 Returns a list: an empty list on success or a list of errors.
2266 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2271 Unsuspends all suspended packages in the on-hold state (those without setup
2272 dates) for this customer.
2278 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2283 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2285 Returns a list: an empty list on success or a list of errors.
2291 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2294 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2296 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2297 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2298 of a list of pkgparts; the hashref has the following keys:
2302 =item pkgparts - listref of pkgparts
2304 =item (other options are passed to the suspend method)
2309 Returns a list: an empty list on success or a list of errors.
2313 sub suspend_if_pkgpart {
2315 my (@pkgparts, %opt);
2316 if (ref($_[0]) eq 'HASH'){
2317 @pkgparts = @{$_[0]{pkgparts}};
2322 grep { $_->suspend(%opt) }
2323 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2324 $self->unsuspended_pkgs;
2327 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2329 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2330 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2331 instead of a list of pkgparts; the hashref has the following keys:
2335 =item pkgparts - listref of pkgparts
2337 =item (other options are passed to the suspend method)
2341 Returns a list: an empty list on success or a list of errors.
2345 sub suspend_unless_pkgpart {
2347 my (@pkgparts, %opt);
2348 if (ref($_[0]) eq 'HASH'){
2349 @pkgparts = @{$_[0]{pkgparts}};
2354 grep { $_->suspend(%opt) }
2355 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2356 $self->unsuspended_pkgs;
2359 =item cancel [ OPTION => VALUE ... ]
2361 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2362 The cancellation time will be now.
2366 Always returns a list: an empty list on success or a list of errors.
2373 warn "$me cancel called on customer ". $self->custnum. " with options ".
2374 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2376 my @pkgs = $self->ncancelled_pkgs;
2378 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2381 =item cancel_pkgs OPTIONS
2383 Cancels a specified list of packages. OPTIONS can include:
2387 =item cust_pkg - an arrayref of the packages. Required.
2389 =item time - the cancellation time, used to calculate final bills and
2390 unused-time credits if any. Will be passed through to the bill() and
2391 FS::cust_pkg::cancel() methods.
2393 =item quiet - can be set true to supress email cancellation notices.
2395 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2396 reasonnum of an existing reason, or passing a hashref will create a new reason.
2397 The hashref should have the following keys:
2398 typenum - Reason type (see L<FS::reason_type>)
2399 reason - Text of the new reason.
2401 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2402 for the individual packages, parallel to the C<cust_pkg> argument. The
2403 reason and reason_otaker arguments will be taken from those objects.
2405 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2407 =item nobill - can be set true to skip billing if it might otherwise be done.
2412 my( $self, %opt ) = @_;
2414 # we're going to cancel services, which is not reversible
2415 die "cancel_pkgs cannot be run inside a transaction"
2416 if $FS::UID::AutoCommit == 0;
2418 local $FS::UID::AutoCommit = 0;
2420 return ( 'access denied' )
2421 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2423 if ( $opt{'ban'} ) {
2425 foreach my $cust_payby ( $self->cust_payby ) {
2427 #well, if they didn't get decrypted on search, then we don't have to
2428 # try again... queue a job for the server that does have decryption
2429 # capability if we're in a paranoid multi-server implementation?
2430 return ( "Can't (yet) ban encrypted credit cards" )
2431 if $cust_payby->is_encrypted($cust_payby->payinfo);
2433 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2434 my $error = $ban->insert;
2444 my @pkgs = @{ delete $opt{'cust_pkg'} };
2445 my $cancel_time = $opt{'time'} || time;
2447 # bill all packages first, so we don't lose usage, service counts for
2448 # bulk billing, etc.
2449 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2451 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2453 'time' => $cancel_time );
2455 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2457 return ( "Error billing during cancellation: $error" );
2462 $FS::UID::AutoCommit = 1;
2464 # now cancel all services, the same way we would for individual packages.
2465 # if any of them fail, cancel the rest anyway.
2466 my @cust_svc = map { $_->cust_svc } @pkgs;
2467 my @sorted_cust_svc =
2469 sort { $a->[1] <=> $b->[1] }
2470 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2472 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2475 foreach my $cust_svc (@sorted_cust_svc) {
2476 my $part_svc = $cust_svc->part_svc;
2477 next if ( defined($part_svc) and $part_svc->preserve );
2478 my $error = $cust_svc->cancel; # immediate cancel, no date option
2479 push @errors, $error if $error;
2485 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2486 $self->custnum. "\n"
2490 if ($opt{'cust_pkg_reason'}) {
2491 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2497 my $cpr = shift @cprs;
2499 $lopt{'reason'} = $cpr->reasonnum;
2500 $lopt{'reason_otaker'} = $cpr->otaker;
2502 warn "no reason found when canceling package ".$_->pkgnum."\n";
2503 # we're not actually required to pass a reason to cust_pkg::cancel,
2504 # but if we're getting to this point, something has gone awry.
2505 $null_reason ||= FS::reason->new_or_existing(
2506 reason => 'unknown reason',
2507 type => 'Cancel Reason',
2510 $lopt{'reason'} = $null_reason->reasonnum;
2511 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2514 my $error = $_->cancel(%lopt);
2515 push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2521 sub _banned_pay_hashref {
2532 'payby' => $payby2ban{$self->payby},
2533 'payinfo' => $self->payinfo,
2534 #don't ever *search* on reason! #'reason' =>
2540 Returns all notes (see L<FS::cust_main_note>) for this customer.
2545 my($self,$orderby_classnum) = (shift,shift);
2546 my $orderby = "sticky DESC, _date DESC";
2547 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2548 qsearch( 'cust_main_note',
2549 { 'custnum' => $self->custnum },
2551 "ORDER BY $orderby",
2557 Returns the agent (see L<FS::agent>) for this customer.
2561 Returns the agent name (see L<FS::agent>) for this customer.
2567 $self->agent->agent;
2572 Returns any tags associated with this customer, as FS::cust_tag objects,
2573 or an empty list if there are no tags.
2577 Returns any tags associated with this customer, as FS::part_tag objects,
2578 or an empty list if there are no tags.
2584 map $_->part_tag, $self->cust_tag;
2590 Returns the customer class, as an FS::cust_class object, or the empty string
2591 if there is no customer class.
2595 Returns the customer category name, or the empty string if there is no customer
2602 my $cust_class = $self->cust_class;
2604 ? $cust_class->categoryname
2610 Returns the customer class name, or the empty string if there is no customer
2617 my $cust_class = $self->cust_class;
2619 ? $cust_class->classname
2625 Returns the external tax status, as an FS::tax_status object, or the empty
2626 string if there is no tax status.
2632 if ( $self->taxstatusnum ) {
2633 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2641 Returns the tax status code if there is one.
2647 my $tax_status = $self->tax_status;
2649 ? $tax_status->taxstatus
2653 =item BILLING METHODS
2655 Documentation on billing methods has been moved to
2656 L<FS::cust_main::Billing>.
2658 =item REALTIME BILLING METHODS
2660 Documentation on realtime billing methods has been moved to
2661 L<FS::cust_main::Billing_Realtime>.
2665 Removes the I<paycvv> field from the database directly.
2667 If there is an error, returns the error, otherwise returns false.
2669 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2675 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2676 or return dbh->errstr;
2677 $sth->execute($self->custnum)
2678 or return $sth->errstr;
2685 Returns the total owed for this customer on all invoices
2686 (see L<FS::cust_bill/owed>).
2692 $self->total_owed_date(2145859200); #12/31/2037
2695 =item total_owed_date TIME
2697 Returns the total owed for this customer on all invoices with date earlier than
2698 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2699 see L<Time::Local> and L<Date::Parse> for conversion functions.
2703 sub total_owed_date {
2707 my $custnum = $self->custnum;
2709 my $owed_sql = FS::cust_bill->owed_sql;
2712 SELECT SUM($owed_sql) FROM cust_bill
2713 WHERE custnum = $custnum
2717 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2721 =item total_owed_pkgnum PKGNUM
2723 Returns the total owed on all invoices for this customer's specific package
2724 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2728 sub total_owed_pkgnum {
2729 my( $self, $pkgnum ) = @_;
2730 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2733 =item total_owed_date_pkgnum TIME PKGNUM
2735 Returns the total owed for this customer's specific package when using
2736 experimental package balances on all invoices with date earlier than
2737 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2738 see L<Time::Local> and L<Date::Parse> for conversion functions.
2742 sub total_owed_date_pkgnum {
2743 my( $self, $time, $pkgnum ) = @_;
2746 foreach my $cust_bill (
2747 grep { $_->_date <= $time }
2748 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2750 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2752 sprintf( "%.2f", $total_bill );
2758 Returns the total amount of all payments.
2765 $total += $_->paid foreach $self->cust_pay;
2766 sprintf( "%.2f", $total );
2769 =item total_unapplied_credits
2771 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2772 customer. See L<FS::cust_credit/credited>.
2774 =item total_credited
2776 Old name for total_unapplied_credits. Don't use.
2780 sub total_credited {
2781 #carp "total_credited deprecated, use total_unapplied_credits";
2782 shift->total_unapplied_credits(@_);
2785 sub total_unapplied_credits {
2788 my $custnum = $self->custnum;
2790 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2793 SELECT SUM($unapplied_sql) FROM cust_credit
2794 WHERE custnum = $custnum
2797 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2801 =item total_unapplied_credits_pkgnum PKGNUM
2803 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2804 customer. See L<FS::cust_credit/credited>.
2808 sub total_unapplied_credits_pkgnum {
2809 my( $self, $pkgnum ) = @_;
2810 my $total_credit = 0;
2811 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2812 sprintf( "%.2f", $total_credit );
2816 =item total_unapplied_payments
2818 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2819 See L<FS::cust_pay/unapplied>.
2823 sub total_unapplied_payments {
2826 my $custnum = $self->custnum;
2828 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2831 SELECT SUM($unapplied_sql) FROM cust_pay
2832 WHERE custnum = $custnum
2835 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2839 =item total_unapplied_payments_pkgnum PKGNUM
2841 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2842 specific package when using experimental package balances. See
2843 L<FS::cust_pay/unapplied>.
2847 sub total_unapplied_payments_pkgnum {
2848 my( $self, $pkgnum ) = @_;
2849 my $total_unapplied = 0;
2850 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2851 sprintf( "%.2f", $total_unapplied );
2855 =item total_unapplied_refunds
2857 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2858 customer. See L<FS::cust_refund/unapplied>.
2862 sub total_unapplied_refunds {
2864 my $custnum = $self->custnum;
2866 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2869 SELECT SUM($unapplied_sql) FROM cust_refund
2870 WHERE custnum = $custnum
2873 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2879 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2880 total_unapplied_credits minus total_unapplied_payments).
2886 $self->balance_date_range;
2889 =item balance_date TIME
2891 Returns the balance for this customer, only considering invoices with date
2892 earlier than TIME (total_owed_date minus total_credited minus
2893 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2894 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2901 $self->balance_date_range(shift);
2904 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2906 Returns the balance for this customer, optionally considering invoices with
2907 date earlier than START_TIME, and not later than END_TIME
2908 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2910 Times are specified as SQL fragments or numeric
2911 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2912 L<Date::Parse> for conversion functions. The empty string can be passed
2913 to disable that time constraint completely.
2915 Accepts the same options as L<balance_date_sql>:
2919 =item unapplied_date
2921 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)
2925 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2926 time will be ignored. Note that START_TIME and END_TIME only limit the date
2927 range for invoices and I<unapplied> payments, credits, and refunds.
2933 sub balance_date_range {
2935 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2936 ') FROM cust_main WHERE custnum='. $self->custnum;
2937 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2940 =item balance_pkgnum PKGNUM
2942 Returns the balance for this customer's specific package when using
2943 experimental package balances (total_owed plus total_unrefunded, minus
2944 total_unapplied_credits minus total_unapplied_payments)
2948 sub balance_pkgnum {
2949 my( $self, $pkgnum ) = @_;
2952 $self->total_owed_pkgnum($pkgnum)
2953 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2954 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2955 - $self->total_unapplied_credits_pkgnum($pkgnum)
2956 - $self->total_unapplied_payments_pkgnum($pkgnum)
2962 Returns a hash of useful information for making a payment.
2972 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2973 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2974 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2978 For credit card transactions:
2990 For electronic check transactions:
3005 $return{balance} = $self->balance;
3007 $return{payname} = $self->payname
3008 || ( $self->first. ' '. $self->get('last') );
3010 $return{$_} = $self->bill_location->$_
3011 for qw(address1 address2 city state zip);
3013 $return{payby} = $self->payby;
3014 $return{stateid_state} = $self->stateid_state;
3016 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3017 $return{card_type} = cardtype($self->payinfo);
3018 $return{payinfo} = $self->paymask;
3020 @return{'month', 'year'} = $self->paydate_monthyear;
3024 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3025 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3026 $return{payinfo1} = $payinfo1;
3027 $return{payinfo2} = $payinfo2;
3028 $return{paytype} = $self->paytype;
3029 $return{paystate} = $self->paystate;
3033 #doubleclick protection
3035 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3043 Returns the next payment expiration date for this customer. If they have no
3044 payment methods that will expire, returns 0.
3050 # filter out the ones that individually return 0, but then return 0 if
3051 # there are no results
3052 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3053 min( @epochs ) || 0;
3056 =item paydate_epoch_sql
3058 Returns an SQL expression to get the next payment expiration date for a
3059 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3060 dates, so that it's safe to test for "will it expire before date X" for any
3065 sub paydate_epoch_sql {
3067 my $paydate = FS::cust_payby->paydate_epoch_sql;
3068 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3072 my( $self, $taxname ) = @_;
3074 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3075 'taxname' => $taxname,
3080 =item cust_main_exemption
3082 =item invoicing_list
3084 Returns a list of email addresses (with svcnum entries expanded), and the word
3085 'POST' if the customer receives postal invoices.
3089 sub invoicing_list {
3090 my( $self, $arrayref ) = @_;
3093 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3096 my @emails = $self->invoicing_list_emailonly;
3097 push @emails, 'POST' if $self->get('postal_invoice');
3102 =item check_invoicing_list ARRAYREF
3104 Checks these arguements as valid input for the invoicing_list method. If there
3105 is an error, returns the error, otherwise returns false.
3109 sub check_invoicing_list {
3110 my( $self, $arrayref ) = @_;
3112 foreach my $address ( @$arrayref ) {
3114 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3115 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3118 my $cust_main_invoice = new FS::cust_main_invoice ( {
3119 'custnum' => $self->custnum,
3122 my $error = $self->custnum
3123 ? $cust_main_invoice->check
3124 : $cust_main_invoice->checkdest
3126 return $error if $error;
3130 return "Email address required"
3131 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3132 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3139 Returns the email addresses of all accounts provisioned for this customer.
3146 foreach my $cust_pkg ( $self->all_pkgs ) {
3147 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3149 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3150 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3152 $list{$_}=1 foreach map { $_->email } @svc_acct;
3157 =item invoicing_list_addpost
3159 Adds postal invoicing to this customer. If this customer is already configured
3160 to receive postal invoices, does nothing.
3164 sub invoicing_list_addpost {
3166 if ( $self->get('postal_invoice') eq '' ) {
3167 $self->set('postal_invoice', 'Y');
3168 my $error = $self->replace;
3169 warn $error if $error; # should fail harder, but this is traditional
3173 =item invoicing_list_emailonly
3175 Returns the list of email invoice recipients (invoicing_list without non-email
3176 destinations such as POST and FAX).
3180 sub invoicing_list_emailonly {
3182 warn "$me invoicing_list_emailonly called"
3184 return () if !$self->custnum; # not yet inserted
3185 return map { $_->emailaddress }
3187 table => 'cust_contact',
3188 select => 'emailaddress',
3189 addl_from => ' JOIN contact USING (contactnum) '.
3190 ' JOIN contact_email USING (contactnum)',
3191 hashref => { 'custnum' => $self->custnum, },
3192 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3196 =item invoicing_list_emailonly_scalar
3198 Returns the list of email invoice recipients (invoicing_list without non-email
3199 destinations such as POST and FAX) as a comma-separated scalar.
3203 sub invoicing_list_emailonly_scalar {
3205 warn "$me invoicing_list_emailonly_scalar called"
3207 join(', ', $self->invoicing_list_emailonly);
3210 =item contact_list [ CLASSNUM, ... ]
3212 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3213 a list of contact classnums is given, returns only contacts in those
3214 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3215 are marked as invoice destinations. If '0' is given, also returns contacts
3218 If no arguments are given, returns all contacts for the customer.
3226 select => 'contact.*, cust_contact.invoice_dest',
3227 addl_from => ' JOIN cust_contact USING (contactnum)',
3228 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3234 if ( $_ eq 'invoice' ) {
3235 push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3236 } elsif ( $_ eq '0' ) {
3237 push @orwhere, 'cust_contact.classnum is null';
3238 } elsif ( /^\d+$/ ) {
3239 push @classnums, $_;
3241 die "bad classnum argument '$_'";
3246 push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3249 $search->{extra_sql} .= ' AND (' .
3250 join(' OR ', map "( $_ )", @orwhere) .
3257 =item contact_list_email [ CLASSNUM, ... ]
3259 Same as L</contact_list>, but returns email destinations instead of contact
3264 sub contact_list_email {
3266 my @contacts = $self->contact_list(@_);
3268 foreach my $contact (@contacts) {
3269 foreach my $contact_email ($contact->contact_email) {
3271 $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3277 =item referral_custnum_cust_main
3279 Returns the customer who referred this customer (or the empty string, if
3280 this customer was not referred).
3282 Note the difference with referral_cust_main method: This method,
3283 referral_custnum_cust_main returns the single customer (if any) who referred
3284 this customer, while referral_cust_main returns an array of customers referred
3289 sub referral_custnum_cust_main {
3291 return '' unless $self->referral_custnum;
3292 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3295 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3297 Returns an array of customers referred by this customer (referral_custnum set
3298 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3299 customers referred by customers referred by this customer and so on, inclusive.
3300 The default behavior is DEPTH 1 (no recursion).
3302 Note the difference with referral_custnum_cust_main method: This method,
3303 referral_cust_main, returns an array of customers referred BY this customer,
3304 while referral_custnum_cust_main returns the single customer (if any) who
3305 referred this customer.
3309 sub referral_cust_main {
3311 my $depth = @_ ? shift : 1;
3312 my $exclude = @_ ? shift : {};
3315 map { $exclude->{$_->custnum}++; $_; }
3316 grep { ! $exclude->{ $_->custnum } }
3317 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3321 map { $_->referral_cust_main($depth-1, $exclude) }
3328 =item referral_cust_main_ncancelled
3330 Same as referral_cust_main, except only returns customers with uncancelled
3335 sub referral_cust_main_ncancelled {
3337 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3340 =item referral_cust_pkg [ DEPTH ]
3342 Like referral_cust_main, except returns a flat list of all unsuspended (and
3343 uncancelled) packages for each customer. The number of items in this list may
3344 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3348 sub referral_cust_pkg {
3350 my $depth = @_ ? shift : 1;
3352 map { $_->unsuspended_pkgs }
3353 grep { $_->unsuspended_pkgs }
3354 $self->referral_cust_main($depth);
3357 =item referring_cust_main
3359 Returns the single cust_main record for the customer who referred this customer
3360 (referral_custnum), or false.
3364 sub referring_cust_main {
3366 return '' unless $self->referral_custnum;
3367 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3370 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3372 Applies a credit to this customer. If there is an error, returns the error,
3373 otherwise returns false.
3375 REASON can be a text string, an FS::reason object, or a scalar reference to
3376 a reasonnum. If a text string, it will be automatically inserted as a new
3377 reason, and a 'reason_type' option must be passed to indicate the
3378 FS::reason_type for the new reason.
3380 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3381 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3382 I<commission_pkgnum>.
3384 Any other options are passed to FS::cust_credit::insert.
3389 my( $self, $amount, $reason, %options ) = @_;
3391 my $cust_credit = new FS::cust_credit {
3392 'custnum' => $self->custnum,
3393 'amount' => $amount,
3396 if ( ref($reason) ) {
3398 if ( ref($reason) eq 'SCALAR' ) {
3399 $cust_credit->reasonnum( $$reason );
3401 $cust_credit->reasonnum( $reason->reasonnum );
3405 $cust_credit->set('reason', $reason)
3408 $cust_credit->$_( delete $options{$_} )
3409 foreach grep exists($options{$_}),
3410 qw( addlinfo eventnum ),
3411 map "commission_$_", qw( agentnum salesnum pkgnum );
3413 $cust_credit->insert(%options);
3417 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3419 Creates a one-time charge for this customer. If there is an error, returns
3420 the error, otherwise returns false.
3422 New-style, with a hashref of options:
3424 my $error = $cust_main->charge(
3428 'start_date' => str2time('7/4/2009'),
3429 'pkg' => 'Description',
3430 'comment' => 'Comment',
3431 'additional' => [], #extra invoice detail
3432 'classnum' => 1, #pkg_class
3434 'setuptax' => '', # or 'Y' for tax exempt
3436 'locationnum'=> 1234, # optional
3439 'taxclass' => 'Tax class',
3442 'taxproduct' => 2, #part_pkg_taxproduct
3443 'override' => {}, #XXX describe
3445 #will be filled in with the new object
3446 'cust_pkg_ref' => \$cust_pkg,
3448 #generate an invoice immediately
3450 'invoice_terms' => '', #with these terms
3456 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3460 #super false laziness w/quotation::charge
3463 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3464 my ( $pkg, $comment, $additional );
3465 my ( $setuptax, $taxclass ); #internal taxes
3466 my ( $taxproduct, $override ); #vendor (CCH) taxes
3468 my $separate_bill = '';
3469 my $cust_pkg_ref = '';
3470 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3472 if ( ref( $_[0] ) ) {
3473 $amount = $_[0]->{amount};
3474 $setup_cost = $_[0]->{setup_cost};
3475 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3476 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3477 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3478 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3479 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3480 : '$'. sprintf("%.2f",$amount);
3481 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3482 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3483 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3484 $additional = $_[0]->{additional} || [];
3485 $taxproduct = $_[0]->{taxproductnum};
3486 $override = { '' => $_[0]->{tax_override} };
3487 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3488 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3489 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3490 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3491 $separate_bill = $_[0]->{separate_bill} || '';
3497 $pkg = @_ ? shift : 'One-time charge';
3498 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3500 $taxclass = @_ ? shift : '';
3504 local $SIG{HUP} = 'IGNORE';
3505 local $SIG{INT} = 'IGNORE';
3506 local $SIG{QUIT} = 'IGNORE';
3507 local $SIG{TERM} = 'IGNORE';
3508 local $SIG{TSTP} = 'IGNORE';
3509 local $SIG{PIPE} = 'IGNORE';
3511 my $oldAutoCommit = $FS::UID::AutoCommit;
3512 local $FS::UID::AutoCommit = 0;
3515 my $part_pkg = new FS::part_pkg ( {
3517 'comment' => $comment,
3521 'classnum' => ( $classnum ? $classnum : '' ),
3522 'setuptax' => $setuptax,
3523 'taxclass' => $taxclass,
3524 'taxproductnum' => $taxproduct,
3525 'setup_cost' => $setup_cost,
3528 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3529 ( 0 .. @$additional - 1 )
3531 'additional_count' => scalar(@$additional),
3532 'setup_fee' => $amount,
3535 my $error = $part_pkg->insert( options => \%options,
3536 tax_overrides => $override,
3539 $dbh->rollback if $oldAutoCommit;
3543 my $pkgpart = $part_pkg->pkgpart;
3544 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3545 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3546 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3547 $error = $type_pkgs->insert;
3549 $dbh->rollback if $oldAutoCommit;
3554 my $cust_pkg = new FS::cust_pkg ( {
3555 'custnum' => $self->custnum,
3556 'pkgpart' => $pkgpart,
3557 'quantity' => $quantity,
3558 'start_date' => $start_date,
3559 'no_auto' => $no_auto,
3560 'separate_bill' => $separate_bill,
3561 'locationnum'=> $locationnum,
3564 $error = $cust_pkg->insert;
3566 $dbh->rollback if $oldAutoCommit;
3568 } elsif ( $cust_pkg_ref ) {
3569 ${$cust_pkg_ref} = $cust_pkg;
3573 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3574 'pkg_list' => [ $cust_pkg ],
3577 $dbh->rollback if $oldAutoCommit;
3582 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3587 #=item charge_postal_fee
3589 #Applies a one time charge this customer. If there is an error,
3590 #returns the error, returns the cust_pkg charge object or false
3591 #if there was no charge.
3595 # This should be a customer event. For that to work requires that bill
3596 # also be a customer event.
3598 sub charge_postal_fee {
3601 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3602 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3604 my $cust_pkg = new FS::cust_pkg ( {
3605 'custnum' => $self->custnum,
3606 'pkgpart' => $pkgpart,
3610 my $error = $cust_pkg->insert;
3611 $error ? $error : $cust_pkg;
3614 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3616 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3618 Optionally, a list or hashref of additional arguments to the qsearch call can
3625 my $opt = ref($_[0]) ? shift : { @_ };
3627 #return $self->num_cust_bill unless wantarray || keys %$opt;
3629 $opt->{'table'} = 'cust_bill';
3630 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3631 $opt->{'hashref'}{'custnum'} = $self->custnum;
3632 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3634 map { $_ } #behavior of sort undefined in scalar context
3635 sort { $a->_date <=> $b->_date }
3639 =item open_cust_bill
3641 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3646 sub open_cust_bill {
3650 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3656 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3658 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3662 sub legacy_cust_bill {
3665 #return $self->num_legacy_cust_bill unless wantarray;
3667 map { $_ } #behavior of sort undefined in scalar context
3668 sort { $a->_date <=> $b->_date }
3669 qsearch({ 'table' => 'legacy_cust_bill',
3670 'hashref' => { 'custnum' => $self->custnum, },
3671 'order_by' => 'ORDER BY _date ASC',
3675 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3677 Returns all the statements (see L<FS::cust_statement>) for this customer.
3679 Optionally, a list or hashref of additional arguments to the qsearch call can
3684 =item cust_bill_void
3686 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3690 sub cust_bill_void {
3693 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3694 sort { $a->_date <=> $b->_date }
3695 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3698 sub cust_statement {
3700 my $opt = ref($_[0]) ? shift : { @_ };
3702 #return $self->num_cust_statement unless wantarray || keys %$opt;
3704 $opt->{'table'} = 'cust_statement';
3705 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3706 $opt->{'hashref'}{'custnum'} = $self->custnum;
3707 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3709 map { $_ } #behavior of sort undefined in scalar context
3710 sort { $a->_date <=> $b->_date }
3714 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3716 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3718 Optionally, a list or hashref of additional arguments to the qsearch call can
3719 be passed following the SVCDB.
3726 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3727 warn "$me svc_x requires a svcdb";
3730 my $opt = ref($_[0]) ? shift : { @_ };
3732 $opt->{'table'} = $svcdb;
3733 $opt->{'addl_from'} =
3734 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3735 ($opt->{'addl_from'} || '');
3737 my $custnum = $self->custnum;
3738 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3739 my $where = "cust_pkg.custnum = $custnum";
3741 my $extra_sql = $opt->{'extra_sql'} || '';
3742 if ( keys %{ $opt->{'hashref'} } ) {
3743 $extra_sql = " AND $where $extra_sql";
3746 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3747 $extra_sql = "WHERE $where AND $1";
3750 $extra_sql = "WHERE $where $extra_sql";
3753 $opt->{'extra_sql'} = $extra_sql;
3758 # required for use as an eventtable;
3761 $self->svc_x('svc_acct', @_);
3766 Returns all the credits (see L<FS::cust_credit>) for this customer.
3773 #return $self->num_cust_credit unless wantarray;
3775 map { $_ } #behavior of sort undefined in scalar context
3776 sort { $a->_date <=> $b->_date }
3777 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3780 =item cust_credit_pkgnum
3782 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3783 package when using experimental package balances.
3787 sub cust_credit_pkgnum {
3788 my( $self, $pkgnum ) = @_;
3789 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3790 sort { $a->_date <=> $b->_date }
3791 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3792 'pkgnum' => $pkgnum,
3797 =item cust_credit_void
3799 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3803 sub cust_credit_void {
3806 sort { $a->_date <=> $b->_date }
3807 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3812 Returns all the payments (see L<FS::cust_pay>) for this customer.
3818 my $opt = ref($_[0]) ? shift : { @_ };
3820 return $self->num_cust_pay unless wantarray || keys %$opt;
3822 $opt->{'table'} = 'cust_pay';
3823 $opt->{'hashref'}{'custnum'} = $self->custnum;
3825 map { $_ } #behavior of sort undefined in scalar context
3826 sort { $a->_date <=> $b->_date }
3833 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3834 called automatically when the cust_pay method is used in a scalar context.
3840 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3841 my $sth = dbh->prepare($sql) or die dbh->errstr;
3842 $sth->execute($self->custnum) or die $sth->errstr;
3843 $sth->fetchrow_arrayref->[0];
3846 =item unapplied_cust_pay
3848 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3852 sub unapplied_cust_pay {
3856 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3862 =item cust_pay_pkgnum
3864 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3865 package when using experimental package balances.
3869 sub cust_pay_pkgnum {
3870 my( $self, $pkgnum ) = @_;
3871 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3872 sort { $a->_date <=> $b->_date }
3873 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3874 'pkgnum' => $pkgnum,
3881 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3887 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3888 sort { $a->_date <=> $b->_date }
3889 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3892 =item cust_pay_pending
3894 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3895 (without status "done").
3899 sub cust_pay_pending {
3901 return $self->num_cust_pay_pending unless wantarray;
3902 sort { $a->_date <=> $b->_date }
3903 qsearch( 'cust_pay_pending', {
3904 'custnum' => $self->custnum,
3905 'status' => { op=>'!=', value=>'done' },
3910 =item cust_pay_pending_attempt
3912 Returns all payment attempts / declined payments for this customer, as pending
3913 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3914 a corresponding payment (see L<FS::cust_pay>).
3918 sub cust_pay_pending_attempt {
3920 return $self->num_cust_pay_pending_attempt unless wantarray;
3921 sort { $a->_date <=> $b->_date }
3922 qsearch( 'cust_pay_pending', {
3923 'custnum' => $self->custnum,
3930 =item num_cust_pay_pending
3932 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3933 customer (without status "done"). Also called automatically when the
3934 cust_pay_pending method is used in a scalar context.
3938 sub num_cust_pay_pending {
3941 " SELECT COUNT(*) FROM cust_pay_pending ".
3942 " WHERE custnum = ? AND status != 'done' ",
3947 =item num_cust_pay_pending_attempt
3949 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3950 customer, with status "done" but without a corresp. Also called automatically when the
3951 cust_pay_pending method is used in a scalar context.
3955 sub num_cust_pay_pending_attempt {
3958 " SELECT COUNT(*) FROM cust_pay_pending ".
3959 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3966 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3972 map { $_ } #return $self->num_cust_refund unless wantarray;
3973 sort { $a->_date <=> $b->_date }
3974 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3977 =item display_custnum
3979 Returns the displayed customer number for this customer: agent_custid if
3980 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3984 sub display_custnum {
3987 return $self->agent_custid
3988 if $default_agent_custid && $self->agent_custid;
3990 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3994 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3995 } elsif ( $custnum_display_length ) {
3996 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3998 return $self->custnum;
4004 Returns a name string for this customer, either "Company (Last, First)" or
4011 my $name = $self->contact;
4012 $name = $self->company. " ($name)" if $self->company;
4016 =item service_contact
4018 Returns the L<FS::contact> object for this customer that has the 'Service'
4019 contact class, or undef if there is no such contact. Deprecated; don't use
4024 sub service_contact {
4026 if ( !exists($self->{service_contact}) ) {
4027 my $classnum = $self->scalar_sql(
4028 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4029 ) || 0; #if it's zero, qsearchs will return nothing
4030 my $cust_contact = qsearchs('cust_contact', {
4031 'classnum' => $classnum,
4032 'custnum' => $self->custnum,
4034 $self->{service_contact} = $cust_contact->contact if $cust_contact;
4036 $self->{service_contact};
4041 Returns a name string for this (service/shipping) contact, either
4042 "Company (Last, First)" or "Last, First".
4049 my $name = $self->ship_contact;
4050 $name = $self->company. " ($name)" if $self->company;
4056 Returns a name string for this customer, either "Company" or "First Last".
4062 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4065 =item ship_name_short
4067 Returns a name string for this (service/shipping) contact, either "Company"
4072 sub ship_name_short {
4074 $self->service_contact
4075 ? $self->ship_contact_firstlast
4081 Returns this customer's full (billing) contact name only, "Last, First"
4087 $self->get('last'). ', '. $self->first;
4092 Returns this customer's full (shipping) contact name only, "Last, First"
4098 my $contact = $self->service_contact || $self;
4099 $contact->get('last') . ', ' . $contact->get('first');
4102 =item contact_firstlast
4104 Returns this customers full (billing) contact name only, "First Last".
4108 sub contact_firstlast {
4110 $self->first. ' '. $self->get('last');
4113 =item ship_contact_firstlast
4115 Returns this customer's full (shipping) contact name only, "First Last".
4119 sub ship_contact_firstlast {
4121 my $contact = $self->service_contact || $self;
4122 $contact->get('first') . ' '. $contact->get('last');
4125 sub bill_country_full {
4127 $self->bill_location->country_full;
4130 sub ship_country_full {
4132 $self->ship_location->country_full;
4135 =item county_state_county [ PREFIX ]
4137 Returns a string consisting of just the county, state and country.
4141 sub county_state_country {
4144 if ( @_ && $_[0] && $self->has_ship_address ) {
4145 $locationnum = $self->ship_locationnum;
4147 $locationnum = $self->bill_locationnum;
4149 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4150 $cust_location->county_state_country;
4153 =item geocode DATA_VENDOR
4155 Returns a value for the customer location as encoded by DATA_VENDOR.
4156 Currently this only makes sense for "CCH" as DATA_VENDOR.
4164 Returns a status string for this customer, currently:
4170 No packages have ever been ordered. Displayed as "No packages".
4174 Recurring packages all are new (not yet billed).
4178 One or more recurring packages is active.
4182 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4186 All non-cancelled recurring packages are suspended.
4190 All recurring packages are cancelled.
4194 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4195 cust_main-status_module configuration option.
4199 sub status { shift->cust_status(@_); }
4203 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4204 for my $status ( FS::cust_main->statuses() ) {
4205 my $method = $status.'_sql';
4206 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4207 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4208 $sth->execute( ($self->custnum) x $numnum )
4209 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4210 if ( $sth->fetchrow_arrayref->[0] ) {
4211 $self->hashref->{cust_status} = $status;
4217 =item is_status_delay_cancel
4219 Returns true if customer status is 'suspended'
4220 and all suspended cust_pkg return true for
4221 cust_pkg->is_status_delay_cancel.
4223 This is not a real status, this only meant for hacking display
4224 values, because otherwise treating the customer as suspended is
4225 really the whole point of the delay_cancel option.
4229 sub is_status_delay_cancel {
4231 return 0 unless $self->status eq 'suspended';
4232 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4233 return 0 unless $cust_pkg->is_status_delay_cancel;
4238 =item ucfirst_cust_status
4240 =item ucfirst_status
4242 Deprecated, use the cust_status_label method instead.
4244 Returns the status with the first character capitalized.
4248 sub ucfirst_status {
4249 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4250 local($ucfirst_nowarn) = 1;
4251 shift->ucfirst_cust_status(@_);
4254 sub ucfirst_cust_status {
4255 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4257 ucfirst($self->cust_status);
4260 =item cust_status_label
4264 Returns the display label for this status.
4268 sub status_label { shift->cust_status_label(@_); }
4270 sub cust_status_label {
4272 __PACKAGE__->statuslabels->{$self->cust_status};
4277 Returns a hex triplet color string for this customer's status.
4281 sub statuscolor { shift->cust_statuscolor(@_); }
4283 sub cust_statuscolor {
4285 __PACKAGE__->statuscolors->{$self->cust_status};
4288 =item tickets [ STATUS ]
4290 Returns an array of hashes representing the customer's RT tickets.
4292 An optional status (or arrayref or hashref of statuses) may be specified.
4298 my $status = ( @_ && $_[0] ) ? shift : '';
4300 my $num = $conf->config('cust_main-max_tickets') || 10;
4303 if ( $conf->config('ticket_system') ) {
4304 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4306 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4315 foreach my $priority (
4316 $conf->config('ticket_system-custom_priority_field-values'), ''
4318 last if scalar(@tickets) >= $num;
4320 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4321 $num - scalar(@tickets),
4332 =item appointments [ STATUS ]
4334 Returns an array of hashes representing the customer's RT tickets which
4341 my $status = ( @_ && $_[0] ) ? shift : '';
4343 return () unless $conf->config('ticket_system');
4345 my $queueid = $conf->config('ticket_system-appointment-queueid');
4347 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4356 # Return services representing svc_accts in customer support packages
4357 sub support_services {
4359 my %packages = map { $_ => 1 } $conf->config('support_packages');
4361 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4362 grep { $_->part_svc->svcdb eq 'svc_acct' }
4363 map { $_->cust_svc }
4364 grep { exists $packages{ $_->pkgpart } }
4365 $self->ncancelled_pkgs;
4369 # Return a list of latitude/longitude for one of the services (if any)
4370 sub service_coordinates {
4374 grep { $_->latitude && $_->longitude }
4376 map { $_->cust_svc }
4377 $self->ncancelled_pkgs;
4379 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4384 Returns a masked version of the named field
4389 my ($self,$field) = @_;
4393 'x'x(length($self->getfield($field))-4).
4394 substr($self->getfield($field), (length($self->getfield($field))-4));
4398 =item payment_history
4400 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4401 cust_credit and cust_refund objects. Each hashref has the following fields:
4403 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4405 I<date> - value of _date field, unix timestamp
4407 I<date_pretty> - user-friendly date
4409 I<description> - user-friendly description of item
4411 I<amount> - impact of item on user's balance
4412 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4413 Not to be confused with the native 'amount' field in cust_credit, see below.
4415 I<amount_pretty> - includes money char
4417 I<balance> - customer balance, chronologically as of this item
4419 I<balance_pretty> - includes money char
4421 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4423 I<paid> - amount paid for cust_pay records, undef for other types
4425 I<credit> - amount credited for cust_credit records, undef for other types.
4426 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4428 I<refund> - amount refunded for cust_refund records, undef for other types
4430 The four table-specific keys always have positive values, whether they reflect charges or payments.
4432 The following options may be passed to this method:
4434 I<line_items> - if true, returns charges ('Line item') rather than invoices
4436 I<start_date> - unix timestamp, only include records on or after.
4437 If specified, an item of type 'Previous' will also be included.
4438 It does not have table-specific fields.
4440 I<end_date> - unix timestamp, only include records before
4442 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4444 I<conf> - optional already-loaded FS::Conf object.
4448 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4449 # and also for sending customer statements, which should both be kept customer-friendly.
4450 # If you add anything that shouldn't be passed on through the API or exposed
4451 # to customers, add a new option to include it, don't include it by default
4452 sub payment_history {
4454 my $opt = ref($_[0]) ? $_[0] : { @_ };
4456 my $conf = $$opt{'conf'} || new FS::Conf;
4457 my $money_char = $conf->config("money_char") || '$',
4459 #first load entire history,
4460 #need previous to calculate previous balance
4461 #loading after end_date shouldn't hurt too much?
4463 if ( $$opt{'line_items'} ) {
4465 foreach my $cust_bill ( $self->cust_bill ) {
4468 'type' => 'Line item',
4469 'description' => $_->desc( $self->locale ).
4470 ( $_->sdate && $_->edate
4471 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4472 ' To '. time2str('%d-%b-%Y', $_->edate)
4475 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4476 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4477 'date' => $cust_bill->_date,
4478 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4480 foreach $cust_bill->cust_bill_pkg;
4487 'type' => 'Invoice',
4488 'description' => 'Invoice #'. $_->display_invnum,
4489 'amount' => sprintf('%.2f', $_->charged ),
4490 'charged' => sprintf('%.2f', $_->charged ),
4491 'date' => $_->_date,
4492 'date_pretty' => $self->time2str_local('short', $_->_date ),
4494 foreach $self->cust_bill;
4499 'type' => 'Payment',
4500 'description' => 'Payment', #XXX type
4501 'amount' => sprintf('%.2f', 0 - $_->paid ),
4502 'paid' => sprintf('%.2f', $_->paid ),
4503 'date' => $_->_date,
4504 'date_pretty' => $self->time2str_local('short', $_->_date ),
4506 foreach $self->cust_pay;
4510 'description' => 'Credit', #more info?
4511 'amount' => sprintf('%.2f', 0 -$_->amount ),
4512 'credit' => sprintf('%.2f', $_->amount ),
4513 'date' => $_->_date,
4514 'date_pretty' => $self->time2str_local('short', $_->_date ),
4516 foreach $self->cust_credit;
4520 'description' => 'Refund', #more info? type, like payment?
4521 'amount' => $_->refund,
4522 'refund' => $_->refund,
4523 'date' => $_->_date,
4524 'date_pretty' => $self->time2str_local('short', $_->_date ),
4526 foreach $self->cust_refund;
4528 #put it all in chronological order
4529 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4531 #calculate balance, filter items outside date range
4535 foreach my $item (@history) {
4536 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4537 $balance += $$item{'amount'};
4538 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4539 $previous += $$item{'amount'};
4542 $$item{'balance'} = sprintf("%.2f",$balance);
4543 foreach my $key ( qw(amount balance) ) {
4544 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4549 # start with previous balance, if there was one
4552 'type' => 'Previous',
4553 'description' => 'Previous balance',
4554 'amount' => sprintf("%.2f",$previous),
4555 'balance' => sprintf("%.2f",$previous),
4556 'date' => $$opt{'start_date'},
4557 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4559 #false laziness with above
4560 foreach my $key ( qw(amount balance) ) {
4561 $$item{$key.'_pretty'} = $$item{$key};
4562 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4564 unshift(@out,$item);
4567 @out = reverse @history if $$opt{'reverse_sort'};
4572 =item save_cust_payby
4574 Saves a new cust_payby for this customer, replacing an existing entry only
4575 in select circumstances. Does not validate input.
4577 If auto is specified, marks this as the customer's primary method, or the
4578 specified weight. Existing payment methods have their weight incremented as
4581 If bill_location is specified with auto, also sets location in cust_main.
4583 Will not insert complete duplicates of existing records, or records in which the
4584 only difference from an existing record is to turn off automatic payment (will
4585 return without error.) Will replace existing records in which the only difference
4586 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4587 Fields marked as preserved are optional, and existing values will not be overwritten with
4588 blanks when replacing.
4590 Accepts the following named parameters:
4600 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4604 optional, set higher than 1 for secondary, etc.
4612 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4620 optional, will be preserved when replacing
4628 CARD only, required, FS::cust_location object
4630 =item paystart_month
4632 CARD only, optional, will be preserved when replacing
4636 CARD only, optional, will be preserved when replacing
4640 CARD only, optional, will be preserved when replacing
4644 CARD only, only used if conf cvv-save is set appropriately
4658 #The code for this option is in place, but it's not currently used
4662 # existing cust_payby object to be replaced (must match custnum)
4664 # stateid/stateid_state/ss are not currently supported in cust_payby,
4665 # might not even work properly in 4.x, but will need to work here if ever added
4667 sub save_cust_payby {
4671 my $old = $opt{'replace'};
4672 my $new = new FS::cust_payby { $old ? $old->hash : () };
4673 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4674 $new->set( 'custnum' => $self->custnum );
4676 my $payby = $opt{'payment_payby'};
4677 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4679 # don't allow turning off auto when replacing
4680 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4682 my @check_existing; # payby relevant to this payment_payby
4684 # set payby based on auto
4685 if ( $payby eq 'CARD' ) {
4686 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4687 @check_existing = qw( CARD DCRD );
4688 } elsif ( $payby eq 'CHEK' ) {
4689 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4690 @check_existing = qw( CHEK DCHK );
4693 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4696 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4697 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4698 $new->set( 'payname' => $opt{'payname'} );
4699 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4701 my $conf = new FS::Conf;
4703 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4704 if ( $payby eq 'CARD' &&
4705 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4706 || $conf->exists('business-onlinepayment-verification')
4709 $new->set( 'paycvv' => $opt{'paycvv'} );
4711 $new->set( 'paycvv' => '');
4714 local $SIG{HUP} = 'IGNORE';
4715 local $SIG{INT} = 'IGNORE';
4716 local $SIG{QUIT} = 'IGNORE';
4717 local $SIG{TERM} = 'IGNORE';
4718 local $SIG{TSTP} = 'IGNORE';
4719 local $SIG{PIPE} = 'IGNORE';
4721 my $oldAutoCommit = $FS::UID::AutoCommit;
4722 local $FS::UID::AutoCommit = 0;
4725 # set fields specific to payment_payby
4726 if ( $payby eq 'CARD' ) {
4727 if ($opt{'bill_location'}) {
4728 $opt{'bill_location'}->set('custnum' => $self->custnum);
4729 my $error = $opt{'bill_location'}->find_or_insert;
4731 $dbh->rollback if $oldAutoCommit;
4734 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4736 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4737 $new->set( $field => $opt{$field} );
4740 foreach my $field ( qw(paytype paystate) ) {
4741 $new->set( $field => $opt{$field} );
4745 # other cust_payby to compare this to
4746 my @existing = $self->cust_payby(@check_existing);
4748 # fields that can overwrite blanks with values, but not values with blanks
4749 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4751 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4753 # generally, we don't want to overwrite existing cust_payby with this,
4754 # but we can replace if we're only marking it auto or adding a preserved field
4755 # and we can avoid saving a total duplicate or merely turning off auto
4757 foreach my $cust_payby (@existing) {
4758 # check fields that absolutely should not change
4759 foreach my $field ($new->fields) {
4760 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4761 next if grep(/^$field$/, @preserve );
4762 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4764 # now check fields that can replace if one value is blank
4766 foreach my $field (@preserve) {
4768 ( $new->get($field) and !$cust_payby->get($field) ) or
4769 ( $cust_payby->get($field) and !$new->get($field) )
4771 # prevention of overwriting values with blanks happens farther below
4773 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4777 unless ( $replace ) {
4778 # nearly identical, now check weight
4779 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4780 # ignore identical cust_payby, and ignore attempts to turn off auto
4781 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4782 $skip_cust_payby = 1;
4785 # otherwise, only change is to mark this as primary
4787 # if we got this far, we're definitely replacing
4794 $new->set( 'custpaybynum' => $old->custpaybynum );
4795 # don't turn off automatic payment (but allow it to be turned on)
4796 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4798 $new->set( 'payby' => $old->payby );
4799 $new->set( 'weight' => 1 );
4801 # make sure we're not overwriting values with blanks
4802 foreach my $field (@preserve) {
4803 if ( $old->get($field) and !$new->get($field) ) {
4804 $new->set( $field => $old->get($field) );
4809 # only overwrite cust_main bill_location if auto
4810 if ($opt{'auto'} && $opt{'bill_location'}) {
4811 $self->set('bill_location' => $opt{'bill_location'});
4812 my $error = $self->replace;
4814 $dbh->rollback if $oldAutoCommit;
4819 # done with everything except reweighting and saving cust_payby
4820 # still need to commit changes to cust_main and cust_location
4821 if ($skip_cust_payby) {
4822 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4826 # re-weight existing primary cust_pay for this payby
4828 foreach my $cust_payby (@existing) {
4829 # relies on cust_payby return order
4830 last unless $cust_payby->payby !~ /^D/;
4831 last if $cust_payby->weight > 1;
4832 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4833 next if $cust_payby->weight < ($opt{'weight'} || 1);
4834 $cust_payby->weight( $cust_payby->weight + 1 );
4835 my $error = $cust_payby->replace;
4837 $dbh->rollback if $oldAutoCommit;
4838 return "Error reweighting cust_payby: $error";
4843 # finally, save cust_payby
4844 my $error = $old ? $new->replace($old) : $new->insert;
4846 $dbh->rollback if $oldAutoCommit;
4850 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4855 =item remove_cvv_from_cust_payby PAYINFO
4857 Removes paycvv from associated cust_payby with matching PAYINFO.
4861 sub remove_cvv_from_cust_payby {
4862 my ($self,$payinfo) = @_;
4864 my $oldAutoCommit = $FS::UID::AutoCommit;
4865 local $FS::UID::AutoCommit = 0;
4868 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4869 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4870 $cust_payby->paycvv('');
4871 my $error = $cust_payby->replace;
4873 $dbh->rollback if $oldAutoCommit;
4878 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4884 =head1 CLASS METHODS
4890 Class method that returns the list of possible status strings for customers
4891 (see L<the status method|/status>). For example:
4893 @statuses = FS::cust_main->statuses();
4899 keys %{ $self->statuscolors };
4902 =item cust_status_sql
4904 Returns an SQL fragment to determine the status of a cust_main record, as a
4909 sub cust_status_sql {
4911 for my $status ( FS::cust_main->statuses() ) {
4912 my $method = $status.'_sql';
4913 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4922 Returns an SQL expression identifying prospective cust_main records (customers
4923 with no packages ever ordered)
4927 use vars qw($select_count_pkgs);
4928 $select_count_pkgs =
4929 "SELECT COUNT(*) FROM cust_pkg
4930 WHERE cust_pkg.custnum = cust_main.custnum";
4932 sub select_count_pkgs_sql {
4937 " 0 = ( $select_count_pkgs ) ";
4942 Returns an SQL expression identifying ordered cust_main records (customers with
4943 no active packages, but recurring packages not yet setup or one time charges
4949 FS::cust_main->none_active_sql.
4950 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4955 Returns an SQL expression identifying active cust_main records (customers with
4956 active recurring packages).
4961 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4964 =item none_active_sql
4966 Returns an SQL expression identifying cust_main records with no active
4967 recurring packages. This includes customers of status prospect, ordered,
4968 inactive, and suspended.
4972 sub none_active_sql {
4973 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4978 Returns an SQL expression identifying inactive cust_main records (customers with
4979 no active recurring packages, but otherwise unsuspended/uncancelled).
4984 FS::cust_main->none_active_sql.
4985 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4991 Returns an SQL expression identifying suspended cust_main records.
4996 sub suspended_sql { susp_sql(@_); }
4998 FS::cust_main->none_active_sql.
4999 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5005 Returns an SQL expression identifying cancelled cust_main records.
5009 sub cancel_sql { shift->cancelled_sql(@_); }
5012 =item uncancelled_sql
5014 Returns an SQL expression identifying un-cancelled cust_main records.
5018 sub uncancelled_sql { uncancel_sql(@_); }
5021 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5026 Returns an SQL fragment to retreive the balance.
5031 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5032 WHERE cust_bill.custnum = cust_main.custnum )
5033 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5034 WHERE cust_pay.custnum = cust_main.custnum )
5035 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5036 WHERE cust_credit.custnum = cust_main.custnum )
5037 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5038 WHERE cust_refund.custnum = cust_main.custnum )
5041 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5043 Returns an SQL fragment to retreive the balance for this customer, optionally
5044 considering invoices with date earlier than START_TIME, and not
5045 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5046 total_unapplied_payments).
5048 Times are specified as SQL fragments or numeric
5049 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5050 L<Date::Parse> for conversion functions. The empty string can be passed
5051 to disable that time constraint completely.
5053 Available options are:
5057 =item unapplied_date
5059 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)
5064 set to true to remove all customer comparison clauses, for totals
5069 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5074 JOIN clause (typically used with the total option)
5078 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5079 time will be ignored. Note that START_TIME and END_TIME only limit the date
5080 range for invoices and I<unapplied> payments, credits, and refunds.
5086 sub balance_date_sql {
5087 my( $class, $start, $end, %opt ) = @_;
5089 my $cutoff = $opt{'cutoff'};
5091 my $owed = FS::cust_bill->owed_sql($cutoff);
5092 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5093 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5094 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5096 my $j = $opt{'join'} || '';
5098 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5099 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5100 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5101 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5103 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5104 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5105 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5106 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5111 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5113 Returns an SQL fragment to retreive the total unapplied payments for this
5114 customer, only considering payments with date earlier than START_TIME, and
5115 optionally not later than END_TIME.
5117 Times are specified as SQL fragments or numeric
5118 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5119 L<Date::Parse> for conversion functions. The empty string can be passed
5120 to disable that time constraint completely.
5122 Available options are:
5126 sub unapplied_payments_date_sql {
5127 my( $class, $start, $end, %opt ) = @_;
5129 my $cutoff = $opt{'cutoff'};
5131 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5133 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5134 'unapplied_date'=>1 );
5136 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5139 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5141 Helper method for balance_date_sql; name (and usage) subject to change
5142 (suggestions welcome).
5144 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5145 cust_refund, cust_credit or cust_pay).
5147 If TABLE is "cust_bill" or the unapplied_date option is true, only
5148 considers records with date earlier than START_TIME, and optionally not
5149 later than END_TIME .
5153 sub _money_table_where {
5154 my( $class, $table, $start, $end, %opt ) = @_;
5157 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5158 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5159 push @where, "$table._date <= $start" if defined($start) && length($start);
5160 push @where, "$table._date > $end" if defined($end) && length($end);
5162 push @where, @{$opt{'where'}} if $opt{'where'};
5163 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5169 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5170 use FS::cust_main::Search;
5173 FS::cust_main::Search->search(@_);
5182 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5184 #Deprecated. Use event notification and message templates
5185 #(L<FS::msg_template>) instead.
5187 #Sends a templated email notification to the customer (see L<Text::Template>).
5189 #OPTIONS is a hash and may include
5191 #I<from> - the email sender (default is invoice_from)
5193 #I<to> - comma-separated scalar or arrayref of recipients
5194 # (default is invoicing_list)
5196 #I<subject> - The subject line of the sent email notification
5197 # (default is "Notice from company_name")
5199 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5202 #The following variables are vavailable in the template.
5204 #I<$first> - the customer first name
5205 #I<$last> - the customer last name
5206 #I<$company> - the customer company
5207 #I<$payby> - a description of the method of payment for the customer
5208 # # would be nice to use FS::payby::shortname
5209 #I<$payinfo> - the account information used to collect for this customer
5210 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5215 # my ($self, $template, %options) = @_;
5217 # return unless $conf->exists($template);
5219 # my $from = $conf->invoice_from_full($self->agentnum)
5220 # if $conf->exists('invoice_from', $self->agentnum);
5221 # $from = $options{from} if exists($options{from});
5223 # my $to = join(',', $self->invoicing_list_emailonly);
5224 # $to = $options{to} if exists($options{to});
5226 # my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5227 # if $conf->exists('company_name', $self->agentnum);
5228 # $subject = $options{subject} if exists($options{subject});
5230 # my $notify_template = new Text::Template (TYPE => 'ARRAY',
5231 # SOURCE => [ map "$_\n",
5232 # $conf->config($template)]
5234 # or die "can't create new Text::Template object: Text::Template::ERROR";
5235 # $notify_template->compile()
5236 # or die "can't compile template: Text::Template::ERROR";
5238 # $FS::notify_template::_template::company_name =
5239 # $conf->config('company_name', $self->agentnum);
5240 # $FS::notify_template::_template::company_address =
5241 # join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5243 # my $paydate = $self->paydate || '2037-12-31';
5244 # $FS::notify_template::_template::first = $self->first;
5245 # $FS::notify_template::_template::last = $self->last;
5246 # $FS::notify_template::_template::company = $self->company;
5247 # $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5248 # my $payby = $self->payby;
5249 # my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5250 # my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5252 # #credit cards expire at the end of the month/year of their exp date
5253 # if ($payby eq 'CARD' || $payby eq 'DCRD') {
5254 # $FS::notify_template::_template::payby = 'credit card';
5255 # ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5256 # $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5258 # }elsif ($payby eq 'COMP') {
5259 # $FS::notify_template::_template::payby = 'complimentary account';
5261 # $FS::notify_template::_template::payby = 'current method';
5263 # $FS::notify_template::_template::expdate = $expire_time;
5265 # for (keys %{$options{extra_fields}}){
5267 # ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5270 # send_email(from => $from,
5272 # subject => $subject,
5273 # body => $notify_template->fill_in( PACKAGE =>
5274 # 'FS::notify_template::_template' ),
5279 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5281 Generates a templated notification to the customer (see L<Text::Template>).
5283 OPTIONS is a hash and may include
5285 I<extra_fields> - a hashref of name/value pairs which will be substituted
5286 into the template. These values may override values mentioned below
5287 and those from the customer record.
5289 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5291 The following variables are available in the template instead of or in addition
5292 to the fields of the customer record.
5294 I<$payby> - a description of the method of payment for the customer
5295 # would be nice to use FS::payby::shortname
5296 I<$payinfo> - the masked account information used to collect for this customer
5297 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5298 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5302 # a lot like cust_bill::print_latex
5303 sub generate_letter {
5304 my ($self, $template, %options) = @_;
5306 warn "Template $template does not exist" && return
5307 unless $conf->exists($template) || $options{'template_text'};
5309 my $template_source = $options{'template_text'}
5310 ? [ $options{'template_text'} ]
5311 : [ map "$_\n", $conf->config($template) ];
5313 my $letter_template = new Text::Template
5315 SOURCE => $template_source,
5316 DELIMITERS => [ '[@--', '--@]' ],
5318 or die "can't create new Text::Template object: Text::Template::ERROR";
5320 $letter_template->compile()
5321 or die "can't compile template: Text::Template::ERROR";
5323 my %letter_data = map { $_ => $self->$_ } $self->fields;
5324 $letter_data{payinfo} = $self->mask_payinfo;
5326 #my $paydate = $self->paydate || '2037-12-31';
5327 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5329 my $payby = $self->payby;
5330 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5331 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5333 #credit cards expire at the end of the month/year of their exp date
5334 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5335 $letter_data{payby} = 'credit card';
5336 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5337 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5339 }elsif ($payby eq 'COMP') {
5340 $letter_data{payby} = 'complimentary account';
5342 $letter_data{payby} = 'current method';
5344 $letter_data{expdate} = $expire_time;
5346 for (keys %{$options{extra_fields}}){
5347 $letter_data{$_} = $options{extra_fields}->{$_};
5350 unless(exists($letter_data{returnaddress})){
5351 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5352 $self->agent_template)
5354 if ( length($retadd) ) {
5355 $letter_data{returnaddress} = $retadd;
5356 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5357 $letter_data{returnaddress} =
5358 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5362 ( $conf->config('company_name', $self->agentnum),
5363 $conf->config('company_address', $self->agentnum),
5367 $letter_data{returnaddress} = '~';
5371 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5373 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5375 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5377 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5381 ) or die "can't open temp file: $!\n";
5382 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5383 or die "can't write temp file: $!\n";
5385 $letter_data{'logo_file'} = $lh->filename;
5387 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5391 ) or die "can't open temp file: $!\n";
5393 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5395 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5396 return ($1, $letter_data{'logo_file'});
5400 =item print_ps TEMPLATE
5402 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5408 my($file, $lfile) = $self->generate_letter(@_);
5409 my $ps = FS::Misc::generate_ps($file);
5410 unlink($file.'.tex');
5416 =item print TEMPLATE
5418 Prints the filled in template.
5420 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5424 sub queueable_print {
5427 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5428 or die "invalid customer number: " . $opt{custnum};
5430 #do not backport this change to 3.x
5431 # my $error = $self->print( { 'template' => $opt{template} } );
5432 my $error = $self->print( $opt{'template'} );
5433 die $error if $error;
5437 my ($self, $template) = (shift, shift);
5439 [ $self->print_ps($template) ],
5440 'agentnum' => $self->agentnum,
5444 #these three subs should just go away once agent stuff is all config overrides
5446 sub agent_template {
5448 $self->_agent_plandata('agent_templatename');
5451 sub agent_invoice_from {
5453 $self->_agent_plandata('agent_invoice_from');
5456 sub _agent_plandata {
5457 my( $self, $option ) = @_;
5459 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5460 #agent-specific Conf
5462 use FS::part_event::Condition;
5464 my $agentnum = $self->agentnum;
5466 my $regexp = regexp_sql();
5468 my $part_event_option =
5470 'select' => 'part_event_option.*',
5471 'table' => 'part_event_option',
5473 LEFT JOIN part_event USING ( eventpart )
5474 LEFT JOIN part_event_option AS peo_agentnum
5475 ON ( part_event.eventpart = peo_agentnum.eventpart
5476 AND peo_agentnum.optionname = 'agentnum'
5477 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5479 LEFT JOIN part_event_condition
5480 ON ( part_event.eventpart = part_event_condition.eventpart
5481 AND part_event_condition.conditionname = 'cust_bill_age'
5483 LEFT JOIN part_event_condition_option
5484 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5485 AND part_event_condition_option.optionname = 'age'
5488 #'hashref' => { 'optionname' => $option },
5489 #'hashref' => { 'part_event_option.optionname' => $option },
5491 " WHERE part_event_option.optionname = ". dbh->quote($option).
5492 " AND action = 'cust_bill_send_agent' ".
5493 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5494 " AND peo_agentnum.optionname = 'agentnum' ".
5495 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5497 CASE WHEN part_event_condition_option.optionname IS NULL
5499 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5501 , part_event.weight".
5505 unless ( $part_event_option ) {
5506 return $self->agent->invoice_template || ''
5507 if $option eq 'agent_templatename';
5511 $part_event_option->optionvalue;
5515 sub process_o2m_qsearch {
5518 return qsearch($table, @_) unless $table eq 'contact';
5520 my $hashref = shift;
5521 my %hash = %$hashref;
5522 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5523 or die 'guru meditation #4343';
5525 qsearch({ 'table' => 'contact',
5526 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5527 'hashref' => \%hash,
5528 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5529 " cust_contact.custnum = $custnum "
5533 sub process_o2m_qsearchs {
5536 return qsearchs($table, @_) unless $table eq 'contact';
5538 my $hashref = shift;
5539 my %hash = %$hashref;
5540 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5541 or die 'guru meditation #2121';
5543 qsearchs({ 'table' => 'contact',
5544 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5545 'hashref' => \%hash,
5546 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5547 " cust_contact.custnum = $custnum "
5551 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5553 Subroutine (not a method), designed to be called from the queue.
5555 Takes a list of options and values.
5557 Pulls up the customer record via the custnum option and calls bill_and_collect.
5562 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5564 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5565 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5567 #without this errors don't get rolled back
5568 $args{'fatal'} = 1; # runs from job queue, will be caught
5570 $cust_main->bill_and_collect( %args );
5573 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5575 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5576 C<collect> part. This is used in batch tax calculation, where invoice
5577 generation and collection events have to be completely separated.
5581 sub queued_collect {
5583 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5585 $cust_main->collect(%args);
5588 sub process_bill_and_collect {
5591 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5592 or die "custnum '$param->{custnum}' not found!\n";
5593 $param->{'job'} = $job;
5594 $param->{'fatal'} = 1; # runs from job queue, will be caught
5595 $param->{'retry'} = 1;
5597 $cust_main->bill_and_collect( %$param );
5600 #starting to take quite a while for big dbs
5601 # (JRNL: journaled so it only happens once per database)
5602 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5603 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5604 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5605 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5606 # JRNL leading/trailing spaces in first, last, company
5607 # JRNL migrate to cust_payby
5608 # - otaker upgrade? journal and call it good? (double check to make sure
5609 # we're not still setting otaker here)
5611 #only going to get worse with new location stuff...
5613 sub _upgrade_data { #class method
5614 my ($class, %opts) = @_;
5617 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5620 #this seems to be the only expensive one.. why does it take so long?
5621 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5623 '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';
5624 FS::upgrade_journal->set_done('cust_main__signupdate');
5627 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5629 # fix yyyy-m-dd formatted paydates
5630 if ( driver_name =~ /^mysql/i ) {
5632 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5633 } else { # the SQL standard
5635 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5637 FS::upgrade_journal->set_done('cust_main__paydate');
5640 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5642 push @statements, #fix the weird BILL with a cc# in payinfo problem
5644 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5646 FS::upgrade_journal->set_done('cust_main__payinfo');
5651 foreach my $sql ( @statements ) {
5652 my $sth = dbh->prepare($sql) or die dbh->errstr;
5653 $sth->execute or die $sth->errstr;
5654 #warn ( (time - $t). " seconds\n" );
5658 local($ignore_expired_card) = 1;
5659 local($ignore_banned_card) = 1;
5660 local($skip_fuzzyfiles) = 1;
5661 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5663 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5665 #we don't want to decrypt them, just stuff them as-is into cust_payby
5666 local(@encrypted_fields) = ();
5668 local($FS::cust_payby::ignore_expired_card) = 1;
5669 local($FS::cust_payby::ignore_banned_card) = 1;
5670 local($FS::cust_payby::ignore_cardtype) = 1;
5672 my @payfields = qw( payby payinfo paycvv paymask
5673 paydate paystart_month paystart_year payissue
5674 payname paystate paytype payip
5677 my $search = new FS::Cursor {
5678 'table' => 'cust_main',
5679 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5682 while (my $cust_main = $search->fetch) {
5684 unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5686 my $cust_payby = new FS::cust_payby {
5687 'custnum' => $cust_main->custnum,
5689 map { $_ => $cust_main->$_(); } @payfields
5692 my $error = $cust_payby->insert;
5693 die $error if $error;
5697 # at the time we do this, also migrate paytype into cust_pay_batch
5698 # so that batches that are open before the migration can still be
5700 my @cust_pay_batch = qsearch('cust_pay_batch', {
5701 'custnum' => $cust_main->custnum,
5705 foreach my $cust_pay_batch (@cust_pay_batch) {
5706 $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5707 my $error = $cust_pay_batch->replace;
5708 die "$error (setting cust_pay_batch.paytype)" if $error;
5711 $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5713 $cust_main->invoice_attn( $cust_main->payname )
5714 if $cust_main->payby eq 'BILL' && $cust_main->payname;
5715 $cust_main->po_number( $cust_main->payinfo )
5716 if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5718 $cust_main->setfield($_, '') foreach @payfields;
5719 my $error = $cust_main->replace;
5720 die "Error upgradging payment information for custnum ".
5721 $cust_main->custnum. ": $error"
5726 FS::upgrade_journal->set_done('cust_main__cust_payby');
5729 FS::cust_main::Location->_upgrade_data(%opts);
5731 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5733 foreach my $cust_main ( qsearch({
5734 'table' => 'cust_main',
5736 'extra_sql' => 'WHERE '.
5738 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5739 qw( first last company )
5742 my $error = $cust_main->replace;
5743 die $error if $error;
5746 FS::upgrade_journal->set_done('cust_main__trimspaces');
5750 $class->_upgrade_otaker(%opts);
5760 The delete method should possibly take an FS::cust_main object reference
5761 instead of a scalar customer number.
5763 Bill and collect options should probably be passed as references instead of a
5766 There should probably be a configuration file with a list of allowed credit
5769 No multiple currency support (probably a larger project than just this module).
5771 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5773 Birthdates rely on negative epoch values.
5775 The payby for card/check batches is broken. With mixed batching, bad
5778 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5782 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5783 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5784 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.