5 use base qw( FS::cust_main::Packages FS::cust_main::Status
6 FS::cust_main::NationalID
7 FS::cust_main::Billing FS::cust_main::Billing_Realtime
8 FS::cust_main::Billing_Discount
9 FS::cust_main::Location
10 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
11 FS::geocode_Mixin FS::Quotable_Mixin
15 use vars qw( $DEBUG $me $conf
18 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
23 use Scalar::Util qw( blessed );
24 use Time::Local qw(timelocal);
25 use Storable qw(thaw);
29 use Digest::MD5 qw(md5_base64);
32 use File::Temp; #qw( tempfile );
33 use Business::CreditCard 0.28;
35 use FS::UID qw( dbh driver_name );
36 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_email send_email generate_ps do_print );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
57 use FS::cust_main_exemption;
58 use FS::cust_tax_adjustment;
59 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
79 # 1 is mostly method/subroutine entry and options
80 # 2 traces progress of some operations
81 # 3 is even more information including possibly sensitive data
83 $me = '[FS::cust_main]';
86 $ignore_expired_card = 0;
87 $ignore_banned_card = 0;
91 @encrypted_fields = ('payinfo', 'paycvv');
92 sub nohistory_fields { ('payinfo', 'paycvv'); }
94 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
96 #ask FS::UID to run this stuff for us later
97 #$FS::UID::callback{'FS::cust_main'} = sub {
98 install_callback FS::UID sub {
100 #yes, need it for stuff below (prolly should be cached)
105 my ( $hashref, $cache ) = @_;
106 if ( exists $hashref->{'pkgnum'} ) {
107 #@{ $self->{'_pkgnum'} } = ();
108 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
109 $self->{'_pkgnum'} = $subcache;
110 #push @{ $self->{'_pkgnum'} },
111 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
117 FS::cust_main - Object methods for cust_main records
123 $record = new FS::cust_main \%hash;
124 $record = new FS::cust_main { 'column' => 'value' };
126 $error = $record->insert;
128 $error = $new_record->replace($old_record);
130 $error = $record->delete;
132 $error = $record->check;
134 @cust_pkg = $record->all_pkgs;
136 @cust_pkg = $record->ncancelled_pkgs;
138 @cust_pkg = $record->suspended_pkgs;
140 $error = $record->bill;
141 $error = $record->bill %options;
142 $error = $record->bill 'time' => $time;
144 $error = $record->collect;
145 $error = $record->collect %options;
146 $error = $record->collect 'invoice_time' => $time,
151 An FS::cust_main object represents a customer. FS::cust_main inherits from
152 FS::Record. The following fields are currently supported:
158 Primary key (assigned automatically for new customers)
162 Agent (see L<FS::agent>)
166 Advertising source (see L<FS::part_referral>)
178 Cocial security number (optional)
202 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
206 Payment Information (See L<FS::payinfo_Mixin> for data format)
210 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
214 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
218 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
222 Start date month (maestro/solo cards only)
226 Start date year (maestro/solo cards only)
230 Issue number (maestro/solo cards only)
234 Name on card or billing name
238 IP address from which payment information was received
242 Tax exempt, empty or `Y'
246 Order taker (see L<FS::access_user>)
252 =item referral_custnum
254 Referring customer number
258 Enable individual CDR spooling, empty or `Y'
262 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
266 Discourage individual CDR printing, empty or `Y'
270 Allow self-service editing of ticket subjects, empty or 'Y'
272 =item calling_list_exempt
274 Do not call, empty or 'Y'
284 Creates a new customer. To add the customer to the database, see L<"insert">.
286 Note that this stores the hash reference, not a distinct copy of the hash it
287 points to. You can ask the object for a copy with the I<hash> method.
291 sub table { 'cust_main'; }
293 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
295 Adds this customer to the database. If there is an error, returns the error,
296 otherwise returns false.
298 Usually the customer's location will not yet exist in the database, and
299 the C<bill_location> and C<ship_location> pseudo-fields must be set to
300 uninserted L<FS::cust_location> objects. These will be inserted and linked
301 (in both directions) to the new customer record. If they're references
302 to the same object, they will become the same location.
304 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
305 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
306 are inserted atomicly, or the transaction is rolled back. Passing an empty
307 hash reference is equivalent to not supplying this parameter. There should be
308 a better explanation of this, but until then, here's an example:
311 tie %hash, 'Tie::RefHash'; #this part is important
313 $cust_pkg => [ $svc_acct ],
316 $cust_main->insert( \%hash );
318 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
319 be set as the invoicing list (see L<"invoicing_list">). Errors return as
320 expected and rollback the entire transaction; it is not necessary to call
321 check_invoicing_list first. The invoicing_list is set after the records in the
322 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
323 invoicing_list destination to the newly-created svc_acct. Here's an example:
325 $cust_main->insert( {}, [ $email, 'POST' ] );
327 Currently available options are: I<depend_jobnum>, I<noexport>,
328 I<tax_exemption> and I<prospectnum>.
330 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
331 on the supplied jobnum (they will not run until the specific job completes).
332 This can be used to defer provisioning until some action completes (such
333 as running the customer's credit card successfully).
335 The I<noexport> option is deprecated. If I<noexport> is set true, no
336 provisioning jobs (exports) are scheduled. (You can schedule them later with
337 the B<reexport> method.)
339 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
340 of tax names and exemption numbers. FS::cust_main_exemption records will be
341 created and inserted.
343 If I<prospectnum> is set, moves contacts and locations from that prospect.
349 my $cust_pkgs = @_ ? shift : {};
350 my $invoicing_list = @_ ? shift : '';
352 warn "$me insert called with options ".
353 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
356 local $SIG{HUP} = 'IGNORE';
357 local $SIG{INT} = 'IGNORE';
358 local $SIG{QUIT} = 'IGNORE';
359 local $SIG{TERM} = 'IGNORE';
360 local $SIG{TSTP} = 'IGNORE';
361 local $SIG{PIPE} = 'IGNORE';
363 my $oldAutoCommit = $FS::UID::AutoCommit;
364 local $FS::UID::AutoCommit = 0;
367 my $prepay_identifier = '';
368 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
370 if ( $self->payby eq 'PREPAY' ) {
372 $self->payby('BILL');
373 $prepay_identifier = $self->payinfo;
376 warn " looking up prepaid card $prepay_identifier\n"
379 my $error = $self->get_prepay( $prepay_identifier,
380 'amount_ref' => \$amount,
381 'seconds_ref' => \$seconds,
382 'upbytes_ref' => \$upbytes,
383 'downbytes_ref' => \$downbytes,
384 'totalbytes_ref' => \$totalbytes,
387 $dbh->rollback if $oldAutoCommit;
388 #return "error applying prepaid card (transaction rolled back): $error";
392 $payby = 'PREP' if $amount;
394 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
397 $self->payby('BILL');
398 $amount = $self->paid;
403 foreach my $l (qw(bill_location ship_location)) {
404 my $loc = delete $self->hashref->{$l};
405 # XXX if we're moving a prospect's locations, do that here
410 if ( !$loc->locationnum ) {
411 # warn the location that we're going to insert it with no custnum
412 $loc->set(custnum_pending => 1);
413 warn " inserting $l\n"
415 my $error = $loc->insert;
417 $dbh->rollback if $oldAutoCommit;
418 my $label = $l eq 'ship_location' ? 'service' : 'billing';
419 return "$error (in $label location)";
422 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
423 # then it somehow belongs to another customer--shouldn't happen
424 $dbh->rollback if $oldAutoCommit;
425 return "$l belongs to customer ".$loc->custnum;
427 # else it already belongs to this customer
428 # (happens when ship_location is identical to bill_location)
430 $self->set($l.'num', $loc->locationnum);
432 if ( $self->get($l.'num') eq '' ) {
433 $dbh->rollback if $oldAutoCommit;
438 warn " inserting $self\n"
441 $self->signupdate(time) unless $self->signupdate;
443 $self->auto_agent_custid()
444 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
446 my $error = $self->SUPER::insert;
448 $dbh->rollback if $oldAutoCommit;
449 #return "inserting cust_main record (transaction rolled back): $error";
453 # now set cust_location.custnum
454 foreach my $l (qw(bill_location ship_location)) {
455 warn " setting $l.custnum\n"
458 unless ( $loc->custnum ) {
459 $loc->set(custnum => $self->custnum);
460 $error ||= $loc->replace;
464 $dbh->rollback if $oldAutoCommit;
465 return "error setting $l custnum: $error";
469 warn " setting invoicing list\n"
472 if ( $invoicing_list ) {
473 $error = $self->check_invoicing_list( $invoicing_list );
475 $dbh->rollback if $oldAutoCommit;
476 #return "checking invoicing_list (transaction rolled back): $error";
479 $self->invoicing_list( $invoicing_list );
482 warn " setting customer tags\n"
485 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
486 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
487 'custnum' => $self->custnum };
488 my $error = $cust_tag->insert;
490 $dbh->rollback if $oldAutoCommit;
495 my $prospectnum = delete $options{'prospectnum'};
496 if ( $prospectnum ) {
498 warn " moving contacts and locations from prospect $prospectnum\n"
502 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
503 unless ( $prospect_main ) {
504 $dbh->rollback if $oldAutoCommit;
505 return "Unknown prospectnum $prospectnum";
507 $prospect_main->custnum($self->custnum);
508 $prospect_main->disabled('Y');
509 my $error = $prospect_main->replace;
511 $dbh->rollback if $oldAutoCommit;
515 my @contact = $prospect_main->contact;
516 my @cust_location = $prospect_main->cust_location;
517 my @qual = $prospect_main->qual;
519 foreach my $r ( @contact, @cust_location, @qual ) {
521 $r->custnum($self->custnum);
522 my $error = $r->replace;
524 $dbh->rollback if $oldAutoCommit;
531 warn " setting cust_main_exemption\n"
534 my $tax_exemption = delete $options{'tax_exemption'};
535 if ( $tax_exemption ) {
537 $tax_exemption = { map { $_ => '' } @$tax_exemption }
538 if ref($tax_exemption) eq 'ARRAY';
540 foreach my $taxname ( keys %$tax_exemption ) {
541 my $cust_main_exemption = new FS::cust_main_exemption {
542 'custnum' => $self->custnum,
543 'taxname' => $taxname,
544 'exempt_number' => $tax_exemption->{$taxname},
546 my $error = $cust_main_exemption->insert;
548 $dbh->rollback if $oldAutoCommit;
549 return "inserting cust_main_exemption (transaction rolled back): $error";
554 warn " ordering packages\n"
557 $error = $self->order_pkgs( $cust_pkgs,
559 'seconds_ref' => \$seconds,
560 'upbytes_ref' => \$upbytes,
561 'downbytes_ref' => \$downbytes,
562 'totalbytes_ref' => \$totalbytes,
565 $dbh->rollback if $oldAutoCommit;
570 $dbh->rollback if $oldAutoCommit;
571 return "No svc_acct record to apply pre-paid time";
573 if ( $upbytes || $downbytes || $totalbytes ) {
574 $dbh->rollback if $oldAutoCommit;
575 return "No svc_acct record to apply pre-paid data";
579 warn " inserting initial $payby payment of $amount\n"
581 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
583 $dbh->rollback if $oldAutoCommit;
584 return "inserting payment (transaction rolled back): $error";
588 unless ( $import || $skip_fuzzyfiles ) {
589 warn " queueing fuzzyfiles update\n"
591 $error = $self->queue_fuzzyfiles_update;
593 $dbh->rollback if $oldAutoCommit;
594 return "updating fuzzy search cache: $error";
598 # FS::geocode_Mixin::after_insert or something?
599 if ( $conf->config('tax_district_method') and !$import ) {
600 # if anything non-empty, try to look it up
601 my $queue = new FS::queue {
602 'job' => 'FS::geocode_Mixin::process_district_update',
603 'custnum' => $self->custnum,
605 my $error = $queue->insert( ref($self), $self->custnum );
607 $dbh->rollback if $oldAutoCommit;
608 return "queueing tax district update: $error";
613 warn " exporting\n" if $DEBUG > 1;
615 my $export_args = $options{'export_args'} || [];
618 map qsearch( 'part_export', {exportnum=>$_} ),
619 $conf->config('cust_main-exports'); #, $agentnum
621 foreach my $part_export ( @part_export ) {
622 my $error = $part_export->export_insert($self, @$export_args);
624 $dbh->rollback if $oldAutoCommit;
625 return "exporting to ". $part_export->exporttype.
626 " (transaction rolled back): $error";
630 #foreach my $depend_jobnum ( @$depend_jobnums ) {
631 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
633 # foreach my $jobnum ( @jobnums ) {
634 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
635 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
637 # my $error = $queue->depend_insert($depend_jobnum);
639 # $dbh->rollback if $oldAutoCommit;
640 # return "error queuing job dependancy: $error";
647 #if ( exists $options{'jobnums'} ) {
648 # push @{ $options{'jobnums'} }, @jobnums;
651 warn " insert complete; committing transaction\n"
654 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
659 use File::CounterFile;
660 sub auto_agent_custid {
663 my $format = $conf->config('cust_main-auto_agent_custid');
665 if ( $format eq '1YMMXXXXXXXX' ) {
667 my $counter = new File::CounterFile 'cust_main.agent_custid';
670 my $ym = 100000000000 + time2str('%y%m00000000', time);
671 if ( $ym > $counter->value ) {
672 $counter->{'value'} = $agent_custid = $ym;
673 $counter->{'updated'} = 1;
675 $agent_custid = $counter->inc;
681 die "Unknown cust_main-auto_agent_custid format: $format";
684 $self->agent_custid($agent_custid);
688 =item PACKAGE METHODS
690 Documentation on customer package methods has been moved to
691 L<FS::cust_main::Packages>.
693 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
695 Recharges this (existing) customer with the specified prepaid card (see
696 L<FS::prepay_credit>), specified either by I<identifier> or as an
697 FS::prepay_credit object. If there is an error, returns the error, otherwise
700 Optionally, five scalar references can be passed as well. They will have their
701 values filled in with the amount, number of seconds, and number of upload,
702 download, and total bytes applied by this prepaid card.
706 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
707 #the only place that uses these args
708 sub recharge_prepay {
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upbytesref, $downbytesref, $totalbytesref ) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
725 my $error = $self->get_prepay( $prepay_credit,
726 'amount_ref' => \$amount,
727 'seconds_ref' => \$seconds,
728 'upbytes_ref' => \$upbytes,
729 'downbytes_ref' => \$downbytes,
730 'totalbytes_ref' => \$totalbytes,
732 || $self->increment_seconds($seconds)
733 || $self->increment_upbytes($upbytes)
734 || $self->increment_downbytes($downbytes)
735 || $self->increment_totalbytes($totalbytes)
736 || $self->insert_cust_pay_prepay( $amount,
738 ? $prepay_credit->identifier
743 $dbh->rollback if $oldAutoCommit;
747 if ( defined($amountref) ) { $$amountref = $amount; }
748 if ( defined($secondsref) ) { $$secondsref = $seconds; }
749 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
750 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
751 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
753 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
758 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
760 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
761 specified either by I<identifier> or as an FS::prepay_credit object.
763 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
764 incremented by the values of the prepaid card.
766 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
767 check or set this customer's I<agentnum>.
769 If there is an error, returns the error, otherwise returns false.
775 my( $self, $prepay_credit, %opt ) = @_;
777 local $SIG{HUP} = 'IGNORE';
778 local $SIG{INT} = 'IGNORE';
779 local $SIG{QUIT} = 'IGNORE';
780 local $SIG{TERM} = 'IGNORE';
781 local $SIG{TSTP} = 'IGNORE';
782 local $SIG{PIPE} = 'IGNORE';
784 my $oldAutoCommit = $FS::UID::AutoCommit;
785 local $FS::UID::AutoCommit = 0;
788 unless ( ref($prepay_credit) ) {
790 my $identifier = $prepay_credit;
792 $prepay_credit = qsearchs(
794 { 'identifier' => $identifier },
799 unless ( $prepay_credit ) {
800 $dbh->rollback if $oldAutoCommit;
801 return "Invalid prepaid card: ". $identifier;
806 if ( $prepay_credit->agentnum ) {
807 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
808 $dbh->rollback if $oldAutoCommit;
809 return "prepaid card not valid for agent ". $self->agentnum;
811 $self->agentnum($prepay_credit->agentnum);
814 my $error = $prepay_credit->delete;
816 $dbh->rollback if $oldAutoCommit;
817 return "removing prepay_credit (transaction rolled back): $error";
820 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
821 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
828 =item increment_upbytes SECONDS
830 Updates this customer's single or primary account (see L<FS::svc_acct>) by
831 the specified number of upbytes. If there is an error, returns the error,
832 otherwise returns false.
836 sub increment_upbytes {
837 _increment_column( shift, 'upbytes', @_);
840 =item increment_downbytes SECONDS
842 Updates this customer's single or primary account (see L<FS::svc_acct>) by
843 the specified number of downbytes. If there is an error, returns the error,
844 otherwise returns false.
848 sub increment_downbytes {
849 _increment_column( shift, 'downbytes', @_);
852 =item increment_totalbytes SECONDS
854 Updates this customer's single or primary account (see L<FS::svc_acct>) by
855 the specified number of totalbytes. If there is an error, returns the error,
856 otherwise returns false.
860 sub increment_totalbytes {
861 _increment_column( shift, 'totalbytes', @_);
864 =item increment_seconds SECONDS
866 Updates this customer's single or primary account (see L<FS::svc_acct>) by
867 the specified number of seconds. If there is an error, returns the error,
868 otherwise returns false.
872 sub increment_seconds {
873 _increment_column( shift, 'seconds', @_);
876 =item _increment_column AMOUNT
878 Updates this customer's single or primary account (see L<FS::svc_acct>) by
879 the specified number of seconds or bytes. If there is an error, returns
880 the error, otherwise returns false.
884 sub _increment_column {
885 my( $self, $column, $amount ) = @_;
886 warn "$me increment_column called: $column, $amount\n"
889 return '' unless $amount;
891 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
892 $self->ncancelled_pkgs;
895 return 'No packages with primary or single services found'.
896 ' to apply pre-paid time';
897 } elsif ( scalar(@cust_pkg) > 1 ) {
898 #maybe have a way to specify the package/account?
899 return 'Multiple packages found to apply pre-paid time';
902 my $cust_pkg = $cust_pkg[0];
903 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
907 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
910 return 'No account found to apply pre-paid time';
911 } elsif ( scalar(@cust_svc) > 1 ) {
912 return 'Multiple accounts found to apply pre-paid time';
915 my $svc_acct = $cust_svc[0]->svc_x;
916 warn " found service svcnum ". $svc_acct->pkgnum.
917 ' ('. $svc_acct->email. ")\n"
920 $column = "increment_$column";
921 $svc_acct->$column($amount);
925 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
927 Inserts a prepayment in the specified amount for this customer. An optional
928 second argument can specify the prepayment identifier for tracking purposes.
929 If there is an error, returns the error, otherwise returns false.
933 sub insert_cust_pay_prepay {
934 shift->insert_cust_pay('PREP', @_);
937 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
939 Inserts a cash payment in the specified amount for this customer. An optional
940 second argument can specify the payment identifier for tracking purposes.
941 If there is an error, returns the error, otherwise returns false.
945 sub insert_cust_pay_cash {
946 shift->insert_cust_pay('CASH', @_);
949 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
951 Inserts a Western Union payment in the specified amount for this customer. An
952 optional second argument can specify the prepayment identifier for tracking
953 purposes. If there is an error, returns the error, otherwise returns false.
957 sub insert_cust_pay_west {
958 shift->insert_cust_pay('WEST', @_);
961 sub insert_cust_pay {
962 my( $self, $payby, $amount ) = splice(@_, 0, 3);
963 my $payinfo = scalar(@_) ? shift : '';
965 my $cust_pay = new FS::cust_pay {
966 'custnum' => $self->custnum,
967 'paid' => sprintf('%.2f', $amount),
968 #'_date' => #date the prepaid card was purchased???
970 'payinfo' => $payinfo,
976 =item delete [ OPTION => VALUE ... ]
978 This deletes the customer. If there is an error, returns the error, otherwise
981 This will completely remove all traces of the customer record. This is not
982 what you want when a customer cancels service; for that, cancel all of the
983 customer's packages (see L</cancel>).
985 If the customer has any uncancelled packages, you need to pass a new (valid)
986 customer number for those packages to be transferred to, as the "new_customer"
987 option. Cancelled packages will be deleted. Did I mention that this is NOT
988 what you want when a customer cancels service and that you really should be
989 looking at L<FS::cust_pkg/cancel>?
991 You can't delete a customer with invoices (see L<FS::cust_bill>),
992 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
993 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
994 set the "delete_financials" option to a true value.
999 my( $self, %opt ) = @_;
1001 local $SIG{HUP} = 'IGNORE';
1002 local $SIG{INT} = 'IGNORE';
1003 local $SIG{QUIT} = 'IGNORE';
1004 local $SIG{TERM} = 'IGNORE';
1005 local $SIG{TSTP} = 'IGNORE';
1006 local $SIG{PIPE} = 'IGNORE';
1008 my $oldAutoCommit = $FS::UID::AutoCommit;
1009 local $FS::UID::AutoCommit = 0;
1012 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1013 $dbh->rollback if $oldAutoCommit;
1014 return "Can't delete a master agent customer";
1017 #use FS::access_user
1018 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1019 $dbh->rollback if $oldAutoCommit;
1020 return "Can't delete a master employee customer";
1023 tie my %financial_tables, 'Tie::IxHash',
1024 'cust_bill' => 'invoices',
1025 'cust_statement' => 'statements',
1026 'cust_credit' => 'credits',
1027 'cust_pay' => 'payments',
1028 'cust_refund' => 'refunds',
1031 foreach my $table ( keys %financial_tables ) {
1033 my @records = $self->$table();
1035 if ( @records && ! $opt{'delete_financials'} ) {
1036 $dbh->rollback if $oldAutoCommit;
1037 return "Can't delete a customer with ". $financial_tables{$table};
1040 foreach my $record ( @records ) {
1041 my $error = $record->delete;
1043 $dbh->rollback if $oldAutoCommit;
1044 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1050 my @cust_pkg = $self->ncancelled_pkgs;
1052 my $new_custnum = $opt{'new_custnum'};
1053 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "Invalid new customer number: $new_custnum";
1057 foreach my $cust_pkg ( @cust_pkg ) {
1058 my %hash = $cust_pkg->hash;
1059 $hash{'custnum'} = $new_custnum;
1060 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1061 my $error = $new_cust_pkg->replace($cust_pkg,
1062 options => { $cust_pkg->options },
1065 $dbh->rollback if $oldAutoCommit;
1070 my @cancelled_cust_pkg = $self->all_pkgs;
1071 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1072 my $error = $cust_pkg->delete;
1074 $dbh->rollback if $oldAutoCommit;
1079 #cust_tax_adjustment in financials?
1080 #cust_pay_pending? ouch
1082 foreach my $table (qw(
1083 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1084 cust_location cust_main_note cust_tax_adjustment
1085 cust_pay_void cust_pay_batch queue cust_tax_exempt
1087 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1088 my $error = $record->delete;
1090 $dbh->rollback if $oldAutoCommit;
1096 my $sth = $dbh->prepare(
1097 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1099 my $errstr = $dbh->errstr;
1100 $dbh->rollback if $oldAutoCommit;
1103 $sth->execute($self->custnum) or do {
1104 my $errstr = $sth->errstr;
1105 $dbh->rollback if $oldAutoCommit;
1111 my $ticket_dbh = '';
1112 if ($conf->config('ticket_system') eq 'RT_Internal') {
1114 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1115 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1116 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1117 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1120 if ( $ticket_dbh ) {
1122 my $ticket_sth = $ticket_dbh->prepare(
1123 'DELETE FROM Links WHERE Target = ?'
1125 my $errstr = $ticket_dbh->errstr;
1126 $dbh->rollback if $oldAutoCommit;
1129 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1131 my $errstr = $ticket_sth->errstr;
1132 $dbh->rollback if $oldAutoCommit;
1136 #check and see if the customer is the only link on the ticket, and
1137 #if so, set the ticket to deleted status in RT?
1138 #maybe someday, for now this will at least fix tickets not displaying
1142 #delete the customer record
1144 my $error = $self->SUPER::delete;
1146 $dbh->rollback if $oldAutoCommit;
1150 # cust_main exports!
1152 #my $export_args = $options{'export_args'} || [];
1155 map qsearch( 'part_export', {exportnum=>$_} ),
1156 $conf->config('cust_main-exports'); #, $agentnum
1158 foreach my $part_export ( @part_export ) {
1159 my $error = $part_export->export_delete( $self ); #, @$export_args);
1161 $dbh->rollback if $oldAutoCommit;
1162 return "exporting to ". $part_export->exporttype.
1163 " (transaction rolled back): $error";
1167 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1172 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1174 This merges this customer into the provided new custnum, and then deletes the
1175 customer. If there is an error, returns the error, otherwise returns false.
1177 The source customer's name, company name, phone numbers, agent,
1178 referring customer, customer class, advertising source, order taker, and
1179 billing information (except balance) are discarded.
1181 All packages are moved to the target customer. Packages with package locations
1182 are preserved. Packages without package locations are moved to a new package
1183 location with the source customer's service/shipping address.
1185 All invoices, statements, payments, credits and refunds are moved to the target
1186 customer. The source customer's balance is added to the target customer.
1188 All notes, attachments, tickets and customer tags are moved to the target
1191 Change history is not currently moved.
1196 my( $self, $new_custnum, %opt ) = @_;
1198 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1200 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1201 or return "Invalid new customer number: $new_custnum";
1203 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1204 if $self->agentnum != $new_cust_main->agentnum
1205 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1207 local $SIG{HUP} = 'IGNORE';
1208 local $SIG{INT} = 'IGNORE';
1209 local $SIG{QUIT} = 'IGNORE';
1210 local $SIG{TERM} = 'IGNORE';
1211 local $SIG{TSTP} = 'IGNORE';
1212 local $SIG{PIPE} = 'IGNORE';
1214 my $oldAutoCommit = $FS::UID::AutoCommit;
1215 local $FS::UID::AutoCommit = 0;
1218 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1219 $dbh->rollback if $oldAutoCommit;
1220 return "Can't merge a master agent customer";
1223 #use FS::access_user
1224 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1225 $dbh->rollback if $oldAutoCommit;
1226 return "Can't merge a master employee customer";
1229 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1230 'status' => { op=>'!=', value=>'done' },
1234 $dbh->rollback if $oldAutoCommit;
1235 return "Can't merge a customer with pending payments";
1238 tie my %financial_tables, 'Tie::IxHash',
1239 'cust_bill' => 'invoices',
1240 'cust_bill_void' => 'voided invoices',
1241 'cust_statement' => 'statements',
1242 'cust_credit' => 'credits',
1243 'cust_pay' => 'payments',
1244 'cust_pay_void' => 'voided payments',
1245 'cust_refund' => 'refunds',
1248 foreach my $table ( keys %financial_tables ) {
1250 my @records = $self->$table();
1252 foreach my $record ( @records ) {
1253 $record->custnum($new_custnum);
1254 my $error = $record->replace;
1256 $dbh->rollback if $oldAutoCommit;
1257 return "Error merging ". $financial_tables{$table}. ": $error\n";
1263 my $name = $self->ship_name; #?
1265 my $locationnum = '';
1266 foreach my $cust_pkg ( $self->all_pkgs ) {
1267 $cust_pkg->custnum($new_custnum);
1269 unless ( $cust_pkg->locationnum ) {
1270 unless ( $locationnum ) {
1271 my $cust_location = new FS::cust_location {
1272 $self->location_hash,
1273 'custnum' => $new_custnum,
1275 my $error = $cust_location->insert;
1277 $dbh->rollback if $oldAutoCommit;
1280 $locationnum = $cust_location->locationnum;
1282 $cust_pkg->locationnum($locationnum);
1285 my $error = $cust_pkg->replace;
1287 $dbh->rollback if $oldAutoCommit;
1291 # add customer (ship) name to svc_phone.phone_name if blank
1292 my @cust_svc = $cust_pkg->cust_svc;
1293 foreach my $cust_svc (@cust_svc) {
1294 my($label, $value, $svcdb) = $cust_svc->label;
1295 next unless $svcdb eq 'svc_phone';
1296 my $svc_phone = $cust_svc->svc_x;
1297 next if $svc_phone->phone_name;
1298 $svc_phone->phone_name($name);
1299 my $error = $svc_phone->replace;
1301 $dbh->rollback if $oldAutoCommit;
1309 # cust_tax_exempt (texas tax exemptions)
1310 # cust_recon (some sort of not-well understood thing for OnPac)
1312 #these are moved over
1313 foreach my $table (qw(
1314 cust_tag cust_location contact cust_attachment cust_main_note
1315 cust_tax_adjustment cust_pay_batch queue
1317 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1318 $record->custnum($new_custnum);
1319 my $error = $record->replace;
1321 $dbh->rollback if $oldAutoCommit;
1327 #these aren't preserved
1328 foreach my $table (qw(
1329 cust_main_exemption cust_main_invoice
1331 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1332 my $error = $record->delete;
1334 $dbh->rollback if $oldAutoCommit;
1341 my $sth = $dbh->prepare(
1342 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1344 my $errstr = $dbh->errstr;
1345 $dbh->rollback if $oldAutoCommit;
1348 $sth->execute($new_custnum, $self->custnum) or do {
1349 my $errstr = $sth->errstr;
1350 $dbh->rollback if $oldAutoCommit;
1356 my $ticket_dbh = '';
1357 if ($conf->config('ticket_system') eq 'RT_Internal') {
1359 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1360 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1361 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1362 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1365 if ( $ticket_dbh ) {
1367 my $ticket_sth = $ticket_dbh->prepare(
1368 'UPDATE Links SET Target = ? WHERE Target = ?'
1370 my $errstr = $ticket_dbh->errstr;
1371 $dbh->rollback if $oldAutoCommit;
1374 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1375 'freeside://freeside/cust_main/'.$self->custnum)
1377 my $errstr = $ticket_sth->errstr;
1378 $dbh->rollback if $oldAutoCommit;
1384 #delete the customer record
1386 my $error = $self->delete;
1388 $dbh->rollback if $oldAutoCommit;
1392 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1397 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1399 Replaces the OLD_RECORD with this one in the database. If there is an error,
1400 returns the error, otherwise returns false.
1402 To change the customer's address, set the pseudo-fields C<bill_location> and
1403 C<ship_location>. The address will still only change if at least one of the
1404 address fields differs from the existing values.
1406 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1407 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1408 expected and rollback the entire transaction; it is not necessary to call
1409 check_invoicing_list first. Here's an example:
1411 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1413 Currently available options are: I<tax_exemption>.
1415 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1416 of tax names and exemption numbers. FS::cust_main_exemption records will be
1417 deleted and inserted as appropriate.
1424 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1426 : $self->replace_old;
1430 warn "$me replace called\n"
1433 my $curuser = $FS::CurrentUser::CurrentUser;
1434 if ( $self->payby eq 'COMP'
1435 && $self->payby ne $old->payby
1436 && ! $curuser->access_right('Complimentary customer')
1439 return "You are not permitted to create complimentary accounts.";
1442 local($ignore_expired_card) = 1
1443 if $old->payby =~ /^(CARD|DCRD)$/
1444 && $self->payby =~ /^(CARD|DCRD)$/
1445 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1447 local($ignore_banned_card) = 1
1448 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1449 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1450 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1452 return "Invoicing locale is required"
1455 && $conf->exists('cust_main-require_locale');
1457 local $SIG{HUP} = 'IGNORE';
1458 local $SIG{INT} = 'IGNORE';
1459 local $SIG{QUIT} = 'IGNORE';
1460 local $SIG{TERM} = 'IGNORE';
1461 local $SIG{TSTP} = 'IGNORE';
1462 local $SIG{PIPE} = 'IGNORE';
1464 my $oldAutoCommit = $FS::UID::AutoCommit;
1465 local $FS::UID::AutoCommit = 0;
1468 for my $l (qw(bill_location ship_location)) {
1469 my $old_loc = $old->$l;
1470 my $new_loc = $self->$l;
1472 # find the existing location if there is one
1473 $new_loc->set('custnum' => $self->custnum);
1474 my $error = $new_loc->find_or_insert;
1476 $dbh->rollback if $oldAutoCommit;
1479 $self->set($l.'num', $new_loc->locationnum);
1482 # replace the customer record
1483 my $error = $self->SUPER::replace($old);
1486 $dbh->rollback if $oldAutoCommit;
1490 # now move packages to the new service location
1491 $self->set('ship_location', ''); #flush cache
1492 if ( $old->ship_locationnum and # should only be null during upgrade...
1493 $old->ship_locationnum != $self->ship_locationnum ) {
1494 $error = $old->ship_location->move_to($self->ship_location);
1496 $dbh->rollback if $oldAutoCommit;
1500 # don't move packages based on the billing location, but
1501 # disable it if it's no longer in use
1502 if ( $old->bill_locationnum and
1503 $old->bill_locationnum != $self->bill_locationnum ) {
1504 $error = $old->bill_location->disable_if_unused;
1506 $dbh->rollback if $oldAutoCommit;
1511 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1512 my $invoicing_list = shift @param;
1513 $error = $self->check_invoicing_list( $invoicing_list );
1515 $dbh->rollback if $oldAutoCommit;
1518 $self->invoicing_list( $invoicing_list );
1521 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1523 #this could be more efficient than deleting and re-inserting, if it matters
1524 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1525 my $error = $cust_tag->delete;
1527 $dbh->rollback if $oldAutoCommit;
1531 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1532 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1533 'custnum' => $self->custnum };
1534 my $error = $cust_tag->insert;
1536 $dbh->rollback if $oldAutoCommit;
1543 my %options = @param;
1545 my $tax_exemption = delete $options{'tax_exemption'};
1546 if ( $tax_exemption ) {
1548 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1549 if ref($tax_exemption) eq 'ARRAY';
1551 my %cust_main_exemption =
1552 map { $_->taxname => $_ }
1553 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1555 foreach my $taxname ( keys %$tax_exemption ) {
1557 if ( $cust_main_exemption{$taxname} &&
1558 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1561 delete $cust_main_exemption{$taxname};
1565 my $cust_main_exemption = new FS::cust_main_exemption {
1566 'custnum' => $self->custnum,
1567 'taxname' => $taxname,
1568 'exempt_number' => $tax_exemption->{$taxname},
1570 my $error = $cust_main_exemption->insert;
1572 $dbh->rollback if $oldAutoCommit;
1573 return "inserting cust_main_exemption (transaction rolled back): $error";
1577 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1578 my $error = $cust_main_exemption->delete;
1580 $dbh->rollback if $oldAutoCommit;
1581 return "deleting cust_main_exemption (transaction rolled back): $error";
1587 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1588 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1589 && $self->get('payinfo') !~ /^99\d{14}$/
1591 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1596 # card/check/lec info has changed, want to retry realtime_ invoice events
1597 my $error = $self->retry_realtime;
1599 $dbh->rollback if $oldAutoCommit;
1604 unless ( $import || $skip_fuzzyfiles ) {
1605 $error = $self->queue_fuzzyfiles_update;
1607 $dbh->rollback if $oldAutoCommit;
1608 return "updating fuzzy search cache: $error";
1612 # tax district update in cust_location
1614 # cust_main exports!
1616 my $export_args = $options{'export_args'} || [];
1619 map qsearch( 'part_export', {exportnum=>$_} ),
1620 $conf->config('cust_main-exports'); #, $agentnum
1622 foreach my $part_export ( @part_export ) {
1623 my $error = $part_export->export_replace( $self, $old, @$export_args);
1625 $dbh->rollback if $oldAutoCommit;
1626 return "exporting to ". $part_export->exporttype.
1627 " (transaction rolled back): $error";
1631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1636 =item queue_fuzzyfiles_update
1638 Used by insert & replace to update the fuzzy search cache
1642 use FS::cust_main::Search;
1643 sub queue_fuzzyfiles_update {
1646 local $SIG{HUP} = 'IGNORE';
1647 local $SIG{INT} = 'IGNORE';
1648 local $SIG{QUIT} = 'IGNORE';
1649 local $SIG{TERM} = 'IGNORE';
1650 local $SIG{TSTP} = 'IGNORE';
1651 local $SIG{PIPE} = 'IGNORE';
1653 my $oldAutoCommit = $FS::UID::AutoCommit;
1654 local $FS::UID::AutoCommit = 0;
1657 my @locations = $self->bill_location;
1658 push @locations, $self->ship_location if $self->has_ship_address;
1659 foreach my $location (@locations) {
1660 my $queue = new FS::queue {
1661 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1663 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1664 my $error = $queue->insert( @args );
1666 $dbh->rollback if $oldAutoCommit;
1667 return "queueing job (transaction rolled back): $error";
1671 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1678 Checks all fields to make sure this is a valid customer record. If there is
1679 an error, returns the error, otherwise returns false. Called by the insert
1680 and replace methods.
1687 warn "$me check BEFORE: \n". $self->_dump
1691 $self->ut_numbern('custnum')
1692 || $self->ut_number('agentnum')
1693 || $self->ut_textn('agent_custid')
1694 || $self->ut_number('refnum')
1695 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1696 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1697 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1698 || $self->ut_textn('custbatch')
1699 || $self->ut_name('last')
1700 || $self->ut_name('first')
1701 || $self->ut_snumbern('signupdate')
1702 || $self->ut_snumbern('birthdate')
1703 || $self->ut_snumbern('spouse_birthdate')
1704 || $self->ut_snumbern('anniversary_date')
1705 || $self->ut_textn('company')
1706 || $self->ut_anything('comments')
1707 || $self->ut_numbern('referral_custnum')
1708 || $self->ut_textn('stateid')
1709 || $self->ut_textn('stateid_state')
1710 || $self->ut_textn('invoice_terms')
1711 || $self->ut_floatn('cdr_termination_percentage')
1712 || $self->ut_floatn('credit_limit')
1713 || $self->ut_numbern('billday')
1714 || $self->ut_numbern('prorate_day')
1715 || $self->ut_flag('edit_subject')
1716 || $self->ut_flag('calling_list_exempt')
1717 || $self->ut_flag('invoice_noemail')
1718 || $self->ut_flag('message_noemail')
1719 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1720 || $self->ut_currencyn('currency')
1723 my $company = $self->company;
1724 $company =~ s/^\s+//;
1725 $company =~ s/\s+$//;
1726 $company =~ s/\s+/ /g;
1727 $self->company($company);
1729 #barf. need message catalogs. i18n. etc.
1730 $error .= "Please select an advertising source."
1731 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1732 return $error if $error;
1734 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1735 or return "Unknown agent";
1737 if ( $self->currency ) {
1738 my $agent_currency = qsearchs( 'agent_currency', {
1739 'agentnum' => $agent->agentnum,
1740 'currency' => $self->currency,
1742 or return "Agent ". $agent->agent.
1743 " not permitted to offer ". $self->currency. " invoicing";
1746 return "Unknown refnum"
1747 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1749 return "Unknown referring custnum: ". $self->referral_custnum
1750 unless ! $self->referral_custnum
1751 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1753 if ( $self->ss eq '' ) {
1758 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1759 or return "Illegal social security number: ". $self->ss;
1760 $self->ss("$1-$2-$3");
1763 # cust_main_county verification now handled by cust_location check
1766 $self->ut_phonen('daytime', $self->country)
1767 || $self->ut_phonen('night', $self->country)
1768 || $self->ut_phonen('fax', $self->country)
1769 || $self->ut_phonen('mobile', $self->country)
1771 return $error if $error;
1773 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1775 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1778 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1780 : FS::Msgcat::_gettext('daytime');
1781 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1783 : FS::Msgcat::_gettext('night');
1785 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1787 : FS::Msgcat::_gettext('mobile');
1789 return "$daytime_label, $night_label or $mobile_label is required"
1793 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1794 # or return "Illegal payby: ". $self->payby;
1796 FS::payby->can_payby($self->table, $self->payby)
1797 or return "Illegal payby: ". $self->payby;
1799 $error = $self->ut_numbern('paystart_month')
1800 || $self->ut_numbern('paystart_year')
1801 || $self->ut_numbern('payissue')
1802 || $self->ut_textn('paytype')
1804 return $error if $error;
1806 if ( $self->payip eq '' ) {
1809 $error = $self->ut_ip('payip');
1810 return $error if $error;
1813 # If it is encrypted and the private key is not availaible then we can't
1814 # check the credit card.
1815 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1817 # Need some kind of global flag to accept invalid cards, for testing
1819 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1821 my $payinfo = $self->payinfo;
1822 $payinfo =~ s/\D//g;
1823 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1824 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1826 $self->payinfo($payinfo);
1828 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1830 return gettext('unknown_card_type')
1831 if $self->payinfo !~ /^99\d{14}$/ #token
1832 && cardtype($self->payinfo) eq "Unknown";
1834 unless ( $ignore_banned_card ) {
1835 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1837 if ( $ban->bantype eq 'warn' ) {
1838 #or others depending on value of $ban->reason ?
1839 return '_duplicate_card'.
1840 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1841 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1842 ' (ban# '. $ban->bannum. ')'
1843 unless $self->override_ban_warn;
1845 return 'Banned credit card: banned on '.
1846 time2str('%a %h %o at %r', $ban->_date).
1847 ' by '. $ban->otaker.
1848 ' (ban# '. $ban->bannum. ')';
1853 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1854 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1855 $self->paycvv =~ /^(\d{4})$/
1856 or return "CVV2 (CID) for American Express cards is four digits.";
1859 $self->paycvv =~ /^(\d{3})$/
1860 or return "CVV2 (CVC2/CID) is three digits.";
1867 my $cardtype = cardtype($payinfo);
1868 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1870 return "Start date or issue number is required for $cardtype cards"
1871 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1873 return "Start month must be between 1 and 12"
1874 if $self->paystart_month
1875 and $self->paystart_month < 1 || $self->paystart_month > 12;
1877 return "Start year must be 1990 or later"
1878 if $self->paystart_year
1879 and $self->paystart_year < 1990;
1881 return "Issue number must be beween 1 and 99"
1883 and $self->payissue < 1 || $self->payissue > 99;
1886 $self->paystart_month('');
1887 $self->paystart_year('');
1888 $self->payissue('');
1891 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1893 my $payinfo = $self->payinfo;
1894 $payinfo =~ s/[^\d\@\.]//g;
1895 if ( $conf->config('echeck-country') eq 'CA' ) {
1896 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1897 or return 'invalid echeck account@branch.bank';
1898 $payinfo = "$1\@$2.$3";
1899 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1900 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1901 $payinfo = "$1\@$2";
1903 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1904 $payinfo = "$1\@$2";
1906 $self->payinfo($payinfo);
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_ach' unless $self->override_ban_warn;
1916 return 'Banned ACH account: banned on '.
1917 time2str('%a %h %o at %r', $ban->_date).
1918 ' by '. $ban->otaker.
1919 ' (ban# '. $ban->bannum. ')';
1924 } elsif ( $self->payby eq 'LECB' ) {
1926 my $payinfo = $self->payinfo;
1927 $payinfo =~ s/\D//g;
1928 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1930 $self->payinfo($payinfo);
1933 } elsif ( $self->payby eq 'BILL' ) {
1935 $error = $self->ut_textn('payinfo');
1936 return "Illegal P.O. number: ". $self->payinfo if $error;
1939 } elsif ( $self->payby eq 'COMP' ) {
1941 my $curuser = $FS::CurrentUser::CurrentUser;
1942 if ( ! $self->custnum
1943 && ! $curuser->access_right('Complimentary customer')
1946 return "You are not permitted to create complimentary accounts."
1949 $error = $self->ut_textn('payinfo');
1950 return "Illegal comp account issuer: ". $self->payinfo if $error;
1953 } elsif ( $self->payby eq 'PREPAY' ) {
1955 my $payinfo = $self->payinfo;
1956 $payinfo =~ s/\W//g; #anything else would just confuse things
1957 $self->payinfo($payinfo);
1958 $error = $self->ut_alpha('payinfo');
1959 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1960 return "Unknown prepayment identifier"
1961 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1966 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1967 return "Expiration date required"
1968 # shouldn't payinfo_check do this?
1969 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
1973 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1974 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1975 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1976 ( $m, $y ) = ( $2, "19$1" );
1977 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1978 ( $m, $y ) = ( $3, "20$2" );
1980 return "Illegal expiration date: ". $self->paydate;
1982 $m = sprintf('%02d',$m);
1983 $self->paydate("$y-$m-01");
1984 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1985 return gettext('expired_card')
1987 && !$ignore_expired_card
1988 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1991 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1992 ( ! $conf->exists('require_cardname')
1993 || $self->payby !~ /^(CARD|DCRD)$/ )
1995 $self->payname( $self->first. " ". $self->getfield('last') );
1997 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1998 or return gettext('illegal_name'). " payname: ". $self->payname;
2002 return "Please select an invoicing locale"
2005 && $conf->exists('cust_main-require_locale');
2007 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2008 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2012 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2014 warn "$me check AFTER: \n". $self->_dump
2017 $self->SUPER::check;
2022 Returns a list of fields which have ship_ duplicates.
2027 qw( last first company
2028 address1 address2 city county state zip country
2030 daytime night fax mobile
2034 =item has_ship_address
2036 Returns true if this customer record has a separate shipping address.
2040 sub has_ship_address {
2042 $self->bill_locationnum != $self->ship_locationnum;
2047 Returns a list of key/value pairs, with the following keys: address1,
2048 adddress2, city, county, state, zip, country, district, and geocode. The
2049 shipping address is used if present.
2055 $self->ship_location->location_hash;
2060 Returns all locations (see L<FS::cust_location>) for this customer.
2066 qsearch('cust_location', { 'custnum' => $self->custnum,
2067 'prospectnum' => '' } );
2072 Returns all contacts (see L<FS::contact>) for this customer.
2076 #already used :/ sub contact {
2079 qsearch('contact', { 'custnum' => $self->custnum } );
2084 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2085 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2086 on success or a list of errors.
2092 grep { $_->unsuspend } $self->suspended_pkgs;
2097 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2099 Returns a list: an empty list on success or a list of errors.
2105 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2108 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2110 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2111 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2112 of a list of pkgparts; the hashref has the following keys:
2116 =item pkgparts - listref of pkgparts
2118 =item (other options are passed to the suspend method)
2123 Returns a list: an empty list on success or a list of errors.
2127 sub suspend_if_pkgpart {
2129 my (@pkgparts, %opt);
2130 if (ref($_[0]) eq 'HASH'){
2131 @pkgparts = @{$_[0]{pkgparts}};
2136 grep { $_->suspend(%opt) }
2137 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2138 $self->unsuspended_pkgs;
2141 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2143 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2144 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2145 instead of a list of pkgparts; the hashref has the following keys:
2149 =item pkgparts - listref of pkgparts
2151 =item (other options are passed to the suspend method)
2155 Returns a list: an empty list on success or a list of errors.
2159 sub suspend_unless_pkgpart {
2161 my (@pkgparts, %opt);
2162 if (ref($_[0]) eq 'HASH'){
2163 @pkgparts = @{$_[0]{pkgparts}};
2168 grep { $_->suspend(%opt) }
2169 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2170 $self->unsuspended_pkgs;
2173 =item cancel [ OPTION => VALUE ... ]
2175 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2177 Available options are:
2181 =item quiet - can be set true to supress email cancellation notices.
2183 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2185 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2187 =item nobill - can be set true to skip billing if it might otherwise be done.
2191 Always returns a list: an empty list on success or a list of errors.
2195 # nb that dates are not specified as valid options to this method
2198 my( $self, %opt ) = @_;
2200 warn "$me cancel called on customer ". $self->custnum. " with options ".
2201 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2204 return ( 'access denied' )
2205 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2207 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2209 #should try decryption (we might have the private key)
2210 # and if not maybe queue a job for the server that does?
2211 return ( "Can't (yet) ban encrypted credit cards" )
2212 if $self->is_encrypted($self->payinfo);
2214 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2215 my $error = $ban->insert;
2216 return ( $error ) if $error;
2220 my @pkgs = $self->ncancelled_pkgs;
2222 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2224 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2225 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2229 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2230 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2233 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2236 sub _banned_pay_hashref {
2247 'payby' => $payby2ban{$self->payby},
2248 'payinfo' => $self->payinfo,
2249 #don't ever *search* on reason! #'reason' =>
2253 sub _new_banned_pay_hashref {
2255 my $hr = $self->_banned_pay_hashref;
2256 $hr->{payinfo} = md5_base64($hr->{payinfo});
2262 Returns all notes (see L<FS::cust_main_note>) for this customer.
2267 my($self,$orderby_classnum) = (shift,shift);
2268 my $orderby = "_DATE DESC";
2269 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2270 qsearch( 'cust_main_note',
2271 { 'custnum' => $self->custnum },
2273 "ORDER BY $orderby",
2279 Returns the agent (see L<FS::agent>) for this customer.
2285 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2290 Returns the agent name (see L<FS::agent>) for this customer.
2296 $self->agent->agent;
2301 Returns any tags associated with this customer, as FS::cust_tag objects,
2302 or an empty list if there are no tags.
2308 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2313 Returns any tags associated with this customer, as FS::part_tag objects,
2314 or an empty list if there are no tags.
2320 map $_->part_tag, $self->cust_tag;
2326 Returns the customer class, as an FS::cust_class object, or the empty string
2327 if there is no customer class.
2333 if ( $self->classnum ) {
2334 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2342 Returns the customer category name, or the empty string if there is no customer
2349 my $cust_class = $self->cust_class;
2351 ? $cust_class->categoryname
2357 Returns the customer class name, or the empty string if there is no customer
2364 my $cust_class = $self->cust_class;
2366 ? $cust_class->classname
2370 =item BILLING METHODS
2372 Documentation on billing methods has been moved to
2373 L<FS::cust_main::Billing>.
2375 =item REALTIME BILLING METHODS
2377 Documentation on realtime billing methods has been moved to
2378 L<FS::cust_main::Billing_Realtime>.
2382 Removes the I<paycvv> field from the database directly.
2384 If there is an error, returns the error, otherwise returns false.
2390 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2391 or return dbh->errstr;
2392 $sth->execute($self->custnum)
2393 or return $sth->errstr;
2398 =item batch_card OPTION => VALUE...
2400 Adds a payment for this invoice to the pending credit card batch (see
2401 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2402 runs the payment using a realtime gateway.
2404 Options may include:
2406 B<amount>: the amount to be paid; defaults to the customer's balance minus
2407 any payments in transit.
2409 B<payby>: the payment method; defaults to cust_main.payby
2411 B<realtime>: runs this as a realtime payment instead of adding it to a
2414 B<invnum>: sets cust_pay_batch.invnum.
2416 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2417 the billing address for the payment; defaults to the customer's billing
2420 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2421 date, and name; defaults to those fields in cust_main.
2426 my ($self, %options) = @_;
2429 if (exists($options{amount})) {
2430 $amount = $options{amount};
2432 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2434 return '' unless $amount > 0;
2436 my $invnum = delete $options{invnum};
2437 my $payby = $options{payby} || $self->payby; #still dubious
2439 if ($options{'realtime'}) {
2440 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2446 my $oldAutoCommit = $FS::UID::AutoCommit;
2447 local $FS::UID::AutoCommit = 0;
2450 #this needs to handle mysql as well as Pg, like svc_acct.pm
2451 #(make it into a common function if folks need to do batching with mysql)
2452 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2453 or return "Cannot lock pay_batch: " . $dbh->errstr;
2457 'payby' => FS::payby->payby2payment($payby),
2459 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2461 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2463 unless ( $pay_batch ) {
2464 $pay_batch = new FS::pay_batch \%pay_batch;
2465 my $error = $pay_batch->insert;
2467 $dbh->rollback if $oldAutoCommit;
2468 die "error creating new batch: $error\n";
2472 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2473 'batchnum' => $pay_batch->batchnum,
2474 'custnum' => $self->custnum,
2477 foreach (qw( address1 address2 city state zip country latitude longitude
2478 payby payinfo paydate payname ))
2480 $options{$_} = '' unless exists($options{$_});
2483 my $loc = $self->bill_location;
2485 my $cust_pay_batch = new FS::cust_pay_batch ( {
2486 'batchnum' => $pay_batch->batchnum,
2487 'invnum' => $invnum || 0, # is there a better value?
2488 # this field should be
2490 # cust_bill_pay_batch now
2491 'custnum' => $self->custnum,
2492 'last' => $self->getfield('last'),
2493 'first' => $self->getfield('first'),
2494 'address1' => $options{address1} || $loc->address1,
2495 'address2' => $options{address2} || $loc->address2,
2496 'city' => $options{city} || $loc->city,
2497 'state' => $options{state} || $loc->state,
2498 'zip' => $options{zip} || $loc->zip,
2499 'country' => $options{country} || $loc->country,
2500 'payby' => $options{payby} || $self->payby,
2501 'payinfo' => $options{payinfo} || $self->payinfo,
2502 'exp' => $options{paydate} || $self->paydate,
2503 'payname' => $options{payname} || $self->payname,
2504 'amount' => $amount, # consolidating
2507 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2508 if $old_cust_pay_batch;
2511 if ($old_cust_pay_batch) {
2512 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2514 $error = $cust_pay_batch->insert;
2518 $dbh->rollback if $oldAutoCommit;
2522 my $unapplied = $self->total_unapplied_credits
2523 + $self->total_unapplied_payments
2524 + $self->in_transit_payments;
2525 foreach my $cust_bill ($self->open_cust_bill) {
2526 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2527 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2528 'invnum' => $cust_bill->invnum,
2529 'paybatchnum' => $cust_pay_batch->paybatchnum,
2530 'amount' => $cust_bill->owed,
2533 if ($unapplied >= $cust_bill_pay_batch->amount){
2534 $unapplied -= $cust_bill_pay_batch->amount;
2537 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2538 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2540 $error = $cust_bill_pay_batch->insert;
2542 $dbh->rollback if $oldAutoCommit;
2547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2553 Returns the total owed for this customer on all invoices
2554 (see L<FS::cust_bill/owed>).
2560 $self->total_owed_date(2145859200); #12/31/2037
2563 =item total_owed_date TIME
2565 Returns the total owed for this customer on all invoices with date earlier than
2566 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2567 see L<Time::Local> and L<Date::Parse> for conversion functions.
2571 sub total_owed_date {
2575 my $custnum = $self->custnum;
2577 my $owed_sql = FS::cust_bill->owed_sql;
2580 SELECT SUM($owed_sql) FROM cust_bill
2581 WHERE custnum = $custnum
2585 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2589 =item total_owed_pkgnum PKGNUM
2591 Returns the total owed on all invoices for this customer's specific package
2592 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2596 sub total_owed_pkgnum {
2597 my( $self, $pkgnum ) = @_;
2598 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2601 =item total_owed_date_pkgnum TIME PKGNUM
2603 Returns the total owed for this customer's specific package when using
2604 experimental package balances on all invoices with date earlier than
2605 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2606 see L<Time::Local> and L<Date::Parse> for conversion functions.
2610 sub total_owed_date_pkgnum {
2611 my( $self, $time, $pkgnum ) = @_;
2614 foreach my $cust_bill (
2615 grep { $_->_date <= $time }
2616 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2618 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2620 sprintf( "%.2f", $total_bill );
2626 Returns the total amount of all payments.
2633 $total += $_->paid foreach $self->cust_pay;
2634 sprintf( "%.2f", $total );
2637 =item total_unapplied_credits
2639 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2640 customer. See L<FS::cust_credit/credited>.
2642 =item total_credited
2644 Old name for total_unapplied_credits. Don't use.
2648 sub total_credited {
2649 #carp "total_credited deprecated, use total_unapplied_credits";
2650 shift->total_unapplied_credits(@_);
2653 sub total_unapplied_credits {
2656 my $custnum = $self->custnum;
2658 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2661 SELECT SUM($unapplied_sql) FROM cust_credit
2662 WHERE custnum = $custnum
2665 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2669 =item total_unapplied_credits_pkgnum PKGNUM
2671 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2672 customer. See L<FS::cust_credit/credited>.
2676 sub total_unapplied_credits_pkgnum {
2677 my( $self, $pkgnum ) = @_;
2678 my $total_credit = 0;
2679 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2680 sprintf( "%.2f", $total_credit );
2684 =item total_unapplied_payments
2686 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2687 See L<FS::cust_pay/unapplied>.
2691 sub total_unapplied_payments {
2694 my $custnum = $self->custnum;
2696 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2699 SELECT SUM($unapplied_sql) FROM cust_pay
2700 WHERE custnum = $custnum
2703 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2707 =item total_unapplied_payments_pkgnum PKGNUM
2709 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2710 specific package when using experimental package balances. See
2711 L<FS::cust_pay/unapplied>.
2715 sub total_unapplied_payments_pkgnum {
2716 my( $self, $pkgnum ) = @_;
2717 my $total_unapplied = 0;
2718 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2719 sprintf( "%.2f", $total_unapplied );
2723 =item total_unapplied_refunds
2725 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2726 customer. See L<FS::cust_refund/unapplied>.
2730 sub total_unapplied_refunds {
2732 my $custnum = $self->custnum;
2734 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2737 SELECT SUM($unapplied_sql) FROM cust_refund
2738 WHERE custnum = $custnum
2741 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2747 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2748 total_unapplied_credits minus total_unapplied_payments).
2754 $self->balance_date_range;
2757 =item balance_date TIME
2759 Returns the balance for this customer, only considering invoices with date
2760 earlier than TIME (total_owed_date minus total_credited minus
2761 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2762 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2769 $self->balance_date_range(shift);
2772 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2774 Returns the balance for this customer, optionally considering invoices with
2775 date earlier than START_TIME, and not later than END_TIME
2776 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2778 Times are specified as SQL fragments or numeric
2779 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2780 L<Date::Parse> for conversion functions. The empty string can be passed
2781 to disable that time constraint completely.
2783 Available options are:
2787 =item unapplied_date
2789 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)
2795 sub balance_date_range {
2797 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2798 ') FROM cust_main WHERE custnum='. $self->custnum;
2799 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2802 =item balance_pkgnum PKGNUM
2804 Returns the balance for this customer's specific package when using
2805 experimental package balances (total_owed plus total_unrefunded, minus
2806 total_unapplied_credits minus total_unapplied_payments)
2810 sub balance_pkgnum {
2811 my( $self, $pkgnum ) = @_;
2814 $self->total_owed_pkgnum($pkgnum)
2815 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2816 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2817 - $self->total_unapplied_credits_pkgnum($pkgnum)
2818 - $self->total_unapplied_payments_pkgnum($pkgnum)
2822 =item in_transit_payments
2824 Returns the total of requests for payments for this customer pending in
2825 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2829 sub in_transit_payments {
2831 my $in_transit_payments = 0;
2832 foreach my $pay_batch ( qsearch('pay_batch', {
2835 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2836 'batchnum' => $pay_batch->batchnum,
2837 'custnum' => $self->custnum,
2839 $in_transit_payments += $cust_pay_batch->amount;
2842 sprintf( "%.2f", $in_transit_payments );
2847 Returns a hash of useful information for making a payment.
2857 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2858 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2859 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2863 For credit card transactions:
2875 For electronic check transactions:
2890 $return{balance} = $self->balance;
2892 $return{payname} = $self->payname
2893 || ( $self->first. ' '. $self->get('last') );
2895 $return{$_} = $self->bill_location->$_
2896 for qw(address1 address2 city state zip);
2898 $return{payby} = $self->payby;
2899 $return{stateid_state} = $self->stateid_state;
2901 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2902 $return{card_type} = cardtype($self->payinfo);
2903 $return{payinfo} = $self->paymask;
2905 @return{'month', 'year'} = $self->paydate_monthyear;
2909 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2910 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2911 $return{payinfo1} = $payinfo1;
2912 $return{payinfo2} = $payinfo2;
2913 $return{paytype} = $self->paytype;
2914 $return{paystate} = $self->paystate;
2918 #doubleclick protection
2920 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2926 =item paydate_monthyear
2928 Returns a two-element list consisting of the month and year of this customer's
2929 paydate (credit card expiration date for CARD customers)
2933 sub paydate_monthyear {
2935 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2937 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2946 Returns the exact time in seconds corresponding to the payment method
2947 expiration date. For CARD/DCRD customers this is the end of the month;
2948 for others (COMP is the only other payby that uses paydate) it's the start.
2949 Returns 0 if the paydate is empty or set to the far future.
2955 my ($month, $year) = $self->paydate_monthyear;
2956 return 0 if !$year or $year >= 2037;
2957 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2959 if ( $month == 13 ) {
2963 return timelocal(0,0,0,1,$month-1,$year) - 1;
2966 return timelocal(0,0,0,1,$month-1,$year);
2970 =item paydate_epoch_sql
2972 Class method. Returns an SQL expression to obtain the payment expiration date
2973 as a number of seconds.
2977 # Special expiration date behavior for non-CARD/DCRD customers has been
2978 # carefully preserved. Do we really use that?
2979 sub paydate_epoch_sql {
2981 my $table = shift || 'cust_main';
2982 my ($case1, $case2);
2983 if ( driver_name eq 'Pg' ) {
2984 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
2985 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
2987 elsif ( lc(driver_name) eq 'mysql' ) {
2988 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
2989 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
2992 return "CASE WHEN $table.payby IN('CARD','DCRD')
2998 =item tax_exemption TAXNAME
3003 my( $self, $taxname ) = @_;
3005 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3006 'taxname' => $taxname,
3011 =item cust_main_exemption
3015 sub cust_main_exemption {
3017 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3020 =item invoicing_list [ ARRAYREF ]
3022 If an arguement is given, sets these email addresses as invoice recipients
3023 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3024 (except as warnings), so use check_invoicing_list first.
3026 Returns a list of email addresses (with svcnum entries expanded).
3028 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3029 check it without disturbing anything by passing nothing.
3031 This interface may change in the future.
3035 sub invoicing_list {
3036 my( $self, $arrayref ) = @_;
3039 my @cust_main_invoice;
3040 if ( $self->custnum ) {
3041 @cust_main_invoice =
3042 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3044 @cust_main_invoice = ();
3046 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3047 #warn $cust_main_invoice->destnum;
3048 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3049 #warn $cust_main_invoice->destnum;
3050 my $error = $cust_main_invoice->delete;
3051 warn $error if $error;
3054 if ( $self->custnum ) {
3055 @cust_main_invoice =
3056 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3058 @cust_main_invoice = ();
3060 my %seen = map { $_->address => 1 } @cust_main_invoice;
3061 foreach my $address ( @{$arrayref} ) {
3062 next if exists $seen{$address} && $seen{$address};
3063 $seen{$address} = 1;
3064 my $cust_main_invoice = new FS::cust_main_invoice ( {
3065 'custnum' => $self->custnum,
3068 my $error = $cust_main_invoice->insert;
3069 warn $error if $error;
3073 if ( $self->custnum ) {
3075 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3082 =item check_invoicing_list ARRAYREF
3084 Checks these arguements as valid input for the invoicing_list method. If there
3085 is an error, returns the error, otherwise returns false.
3089 sub check_invoicing_list {
3090 my( $self, $arrayref ) = @_;
3092 foreach my $address ( @$arrayref ) {
3094 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3095 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3098 my $cust_main_invoice = new FS::cust_main_invoice ( {
3099 'custnum' => $self->custnum,
3102 my $error = $self->custnum
3103 ? $cust_main_invoice->check
3104 : $cust_main_invoice->checkdest
3106 return $error if $error;
3110 return "Email address required"
3111 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3112 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3117 =item set_default_invoicing_list
3119 Sets the invoicing list to all accounts associated with this customer,
3120 overwriting any previous invoicing list.
3124 sub set_default_invoicing_list {
3126 $self->invoicing_list($self->all_emails);
3131 Returns the email addresses of all accounts provisioned for this customer.
3138 foreach my $cust_pkg ( $self->all_pkgs ) {
3139 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3141 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3142 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3144 $list{$_}=1 foreach map { $_->email } @svc_acct;
3149 =item invoicing_list_addpost
3151 Adds postal invoicing to this customer. If this customer is already configured
3152 to receive postal invoices, does nothing.
3156 sub invoicing_list_addpost {
3158 return if grep { $_ eq 'POST' } $self->invoicing_list;
3159 my @invoicing_list = $self->invoicing_list;
3160 push @invoicing_list, 'POST';
3161 $self->invoicing_list(\@invoicing_list);
3164 =item invoicing_list_emailonly
3166 Returns the list of email invoice recipients (invoicing_list without non-email
3167 destinations such as POST and FAX).
3171 sub invoicing_list_emailonly {
3173 warn "$me invoicing_list_emailonly called"
3175 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3178 =item invoicing_list_emailonly_scalar
3180 Returns the list of email invoice recipients (invoicing_list without non-email
3181 destinations such as POST and FAX) as a comma-separated scalar.
3185 sub invoicing_list_emailonly_scalar {
3187 warn "$me invoicing_list_emailonly_scalar called"
3189 join(', ', $self->invoicing_list_emailonly);
3192 =item referral_custnum_cust_main
3194 Returns the customer who referred this customer (or the empty string, if
3195 this customer was not referred).
3197 Note the difference with referral_cust_main method: This method,
3198 referral_custnum_cust_main returns the single customer (if any) who referred
3199 this customer, while referral_cust_main returns an array of customers referred
3204 sub referral_custnum_cust_main {
3206 return '' unless $self->referral_custnum;
3207 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3210 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3212 Returns an array of customers referred by this customer (referral_custnum set
3213 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3214 customers referred by customers referred by this customer and so on, inclusive.
3215 The default behavior is DEPTH 1 (no recursion).
3217 Note the difference with referral_custnum_cust_main method: This method,
3218 referral_cust_main, returns an array of customers referred BY this customer,
3219 while referral_custnum_cust_main returns the single customer (if any) who
3220 referred this customer.
3224 sub referral_cust_main {
3226 my $depth = @_ ? shift : 1;
3227 my $exclude = @_ ? shift : {};
3230 map { $exclude->{$_->custnum}++; $_; }
3231 grep { ! $exclude->{ $_->custnum } }
3232 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3236 map { $_->referral_cust_main($depth-1, $exclude) }
3243 =item referral_cust_main_ncancelled
3245 Same as referral_cust_main, except only returns customers with uncancelled
3250 sub referral_cust_main_ncancelled {
3252 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3255 =item referral_cust_pkg [ DEPTH ]
3257 Like referral_cust_main, except returns a flat list of all unsuspended (and
3258 uncancelled) packages for each customer. The number of items in this list may
3259 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3263 sub referral_cust_pkg {
3265 my $depth = @_ ? shift : 1;
3267 map { $_->unsuspended_pkgs }
3268 grep { $_->unsuspended_pkgs }
3269 $self->referral_cust_main($depth);
3272 =item referring_cust_main
3274 Returns the single cust_main record for the customer who referred this customer
3275 (referral_custnum), or false.
3279 sub referring_cust_main {
3281 return '' unless $self->referral_custnum;
3282 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3285 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3287 Applies a credit to this customer. If there is an error, returns the error,
3288 otherwise returns false.
3290 REASON can be a text string, an FS::reason object, or a scalar reference to
3291 a reasonnum. If a text string, it will be automatically inserted as a new
3292 reason, and a 'reason_type' option must be passed to indicate the
3293 FS::reason_type for the new reason.
3295 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3297 Any other options are passed to FS::cust_credit::insert.
3302 my( $self, $amount, $reason, %options ) = @_;
3304 my $cust_credit = new FS::cust_credit {
3305 'custnum' => $self->custnum,
3306 'amount' => $amount,
3309 if ( ref($reason) ) {
3311 if ( ref($reason) eq 'SCALAR' ) {
3312 $cust_credit->reasonnum( $$reason );
3314 $cust_credit->reasonnum( $reason->reasonnum );
3318 $cust_credit->set('reason', $reason)
3321 for (qw( addlinfo eventnum )) {
3322 $cust_credit->$_( delete $options{$_} )
3323 if exists($options{$_});
3326 $cust_credit->insert(%options);
3330 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3332 Creates a one-time charge for this customer. If there is an error, returns
3333 the error, otherwise returns false.
3335 New-style, with a hashref of options:
3337 my $error = $cust_main->charge(
3341 'start_date' => str2time('7/4/2009'),
3342 'pkg' => 'Description',
3343 'comment' => 'Comment',
3344 'additional' => [], #extra invoice detail
3345 'classnum' => 1, #pkg_class
3347 'setuptax' => '', # or 'Y' for tax exempt
3349 'locationnum'=> 1234, # optional
3352 'taxclass' => 'Tax class',
3355 'taxproduct' => 2, #part_pkg_taxproduct
3356 'override' => {}, #XXX describe
3358 #will be filled in with the new object
3359 'cust_pkg_ref' => \$cust_pkg,
3361 #generate an invoice immediately
3363 'invoice_terms' => '', #with these terms
3369 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3375 my ( $amount, $quantity, $start_date, $classnum );
3376 my ( $pkg, $comment, $additional );
3377 my ( $setuptax, $taxclass ); #internal taxes
3378 my ( $taxproduct, $override ); #vendor (CCH) taxes
3380 my $cust_pkg_ref = '';
3381 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3383 if ( ref( $_[0] ) ) {
3384 $amount = $_[0]->{amount};
3385 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3386 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3387 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3388 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3389 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3390 : '$'. sprintf("%.2f",$amount);
3391 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3392 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3393 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3394 $additional = $_[0]->{additional} || [];
3395 $taxproduct = $_[0]->{taxproductnum};
3396 $override = { '' => $_[0]->{tax_override} };
3397 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3398 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3399 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3400 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3405 $pkg = @_ ? shift : 'One-time charge';
3406 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3408 $taxclass = @_ ? shift : '';
3412 local $SIG{HUP} = 'IGNORE';
3413 local $SIG{INT} = 'IGNORE';
3414 local $SIG{QUIT} = 'IGNORE';
3415 local $SIG{TERM} = 'IGNORE';
3416 local $SIG{TSTP} = 'IGNORE';
3417 local $SIG{PIPE} = 'IGNORE';
3419 my $oldAutoCommit = $FS::UID::AutoCommit;
3420 local $FS::UID::AutoCommit = 0;
3423 my $part_pkg = new FS::part_pkg ( {
3425 'comment' => $comment,
3429 'classnum' => ( $classnum ? $classnum : '' ),
3430 'setuptax' => $setuptax,
3431 'taxclass' => $taxclass,
3432 'taxproductnum' => $taxproduct,
3435 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3436 ( 0 .. @$additional - 1 )
3438 'additional_count' => scalar(@$additional),
3439 'setup_fee' => $amount,
3442 my $error = $part_pkg->insert( options => \%options,
3443 tax_overrides => $override,
3446 $dbh->rollback if $oldAutoCommit;
3450 my $pkgpart = $part_pkg->pkgpart;
3451 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3452 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3453 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3454 $error = $type_pkgs->insert;
3456 $dbh->rollback if $oldAutoCommit;
3461 my $cust_pkg = new FS::cust_pkg ( {
3462 'custnum' => $self->custnum,
3463 'pkgpart' => $pkgpart,
3464 'quantity' => $quantity,
3465 'start_date' => $start_date,
3466 'no_auto' => $no_auto,
3467 'locationnum'=> $locationnum,
3470 $error = $cust_pkg->insert;
3472 $dbh->rollback if $oldAutoCommit;
3474 } elsif ( $cust_pkg_ref ) {
3475 ${$cust_pkg_ref} = $cust_pkg;
3479 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3480 'pkg_list' => [ $cust_pkg ],
3483 $dbh->rollback if $oldAutoCommit;
3488 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3493 #=item charge_postal_fee
3495 #Applies a one time charge this customer. If there is an error,
3496 #returns the error, returns the cust_pkg charge object or false
3497 #if there was no charge.
3501 # This should be a customer event. For that to work requires that bill
3502 # also be a customer event.
3504 sub charge_postal_fee {
3507 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3508 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3510 my $cust_pkg = new FS::cust_pkg ( {
3511 'custnum' => $self->custnum,
3512 'pkgpart' => $pkgpart,
3516 my $error = $cust_pkg->insert;
3517 $error ? $error : $cust_pkg;
3520 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3522 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3524 Optionally, a list or hashref of additional arguments to the qsearch call can
3531 my $opt = ref($_[0]) ? shift : { @_ };
3533 #return $self->num_cust_bill unless wantarray || keys %$opt;
3535 $opt->{'table'} = 'cust_bill';
3536 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3537 $opt->{'hashref'}{'custnum'} = $self->custnum;
3538 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3540 map { $_ } #behavior of sort undefined in scalar context
3541 sort { $a->_date <=> $b->_date }
3545 =item open_cust_bill
3547 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3552 sub open_cust_bill {
3556 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3562 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3564 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3568 sub legacy_cust_bill {
3571 #return $self->num_legacy_cust_bill unless wantarray;
3573 map { $_ } #behavior of sort undefined in scalar context
3574 sort { $a->_date <=> $b->_date }
3575 qsearch({ 'table' => 'legacy_cust_bill',
3576 'hashref' => { 'custnum' => $self->custnum, },
3577 'order_by' => 'ORDER BY _date ASC',
3581 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3583 Returns all the statements (see L<FS::cust_statement>) for this customer.
3585 Optionally, a list or hashref of additional arguments to the qsearch call can
3590 =item cust_bill_void
3592 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3596 sub cust_bill_void {
3599 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3600 sort { $a->_date <=> $b->_date }
3601 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3604 sub cust_statement {
3606 my $opt = ref($_[0]) ? shift : { @_ };
3608 #return $self->num_cust_statement unless wantarray || keys %$opt;
3610 $opt->{'table'} = 'cust_statement';
3611 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3612 $opt->{'hashref'}{'custnum'} = $self->custnum;
3613 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3615 map { $_ } #behavior of sort undefined in scalar context
3616 sort { $a->_date <=> $b->_date }
3620 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3622 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3624 Optionally, a list or hashref of additional arguments to the qsearch call can
3625 be passed following the SVCDB.
3632 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3633 warn "$me svc_x requires a svcdb";
3636 my $opt = ref($_[0]) ? shift : { @_ };
3638 $opt->{'table'} = $svcdb;
3639 $opt->{'addl_from'} =
3640 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3641 ($opt->{'addl_from'} || '');
3643 my $custnum = $self->custnum;
3644 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3645 my $where = "cust_pkg.custnum = $custnum";
3647 my $extra_sql = $opt->{'extra_sql'} || '';
3648 if ( keys %{ $opt->{'hashref'} } ) {
3649 $extra_sql = " AND $where $extra_sql";
3652 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3653 $extra_sql = "WHERE $where AND $1";
3656 $extra_sql = "WHERE $where $extra_sql";
3659 $opt->{'extra_sql'} = $extra_sql;
3664 # required for use as an eventtable;
3667 $self->svc_x('svc_acct', @_);
3672 Returns all the credits (see L<FS::cust_credit>) for this customer.
3678 map { $_ } #return $self->num_cust_credit unless wantarray;
3679 sort { $a->_date <=> $b->_date }
3680 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3683 =item cust_credit_pkgnum
3685 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3686 package when using experimental package balances.
3690 sub cust_credit_pkgnum {
3691 my( $self, $pkgnum ) = @_;
3692 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3693 sort { $a->_date <=> $b->_date }
3694 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3695 'pkgnum' => $pkgnum,
3702 Returns all the payments (see L<FS::cust_pay>) for this customer.
3708 return $self->num_cust_pay unless wantarray;
3709 sort { $a->_date <=> $b->_date }
3710 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3715 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3716 called automatically when the cust_pay method is used in a scalar context.
3722 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3723 my $sth = dbh->prepare($sql) or die dbh->errstr;
3724 $sth->execute($self->custnum) or die $sth->errstr;
3725 $sth->fetchrow_arrayref->[0];
3728 =item cust_pay_pkgnum
3730 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3731 package when using experimental package balances.
3735 sub cust_pay_pkgnum {
3736 my( $self, $pkgnum ) = @_;
3737 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3738 sort { $a->_date <=> $b->_date }
3739 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3740 'pkgnum' => $pkgnum,
3747 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3753 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3754 sort { $a->_date <=> $b->_date }
3755 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3758 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3760 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3762 Optionally, a list or hashref of additional arguments to the qsearch call can
3767 sub cust_pay_batch {
3769 my $opt = ref($_[0]) ? shift : { @_ };
3771 #return $self->num_cust_statement unless wantarray || keys %$opt;
3773 $opt->{'table'} = 'cust_pay_batch';
3774 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3775 $opt->{'hashref'}{'custnum'} = $self->custnum;
3776 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3778 map { $_ } #behavior of sort undefined in scalar context
3779 sort { $a->paybatchnum <=> $b->paybatchnum }
3783 =item cust_pay_pending
3785 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3786 (without status "done").
3790 sub cust_pay_pending {
3792 return $self->num_cust_pay_pending unless wantarray;
3793 sort { $a->_date <=> $b->_date }
3794 qsearch( 'cust_pay_pending', {
3795 'custnum' => $self->custnum,
3796 'status' => { op=>'!=', value=>'done' },
3801 =item cust_pay_pending_attempt
3803 Returns all payment attempts / declined payments for this customer, as pending
3804 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3805 a corresponding payment (see L<FS::cust_pay>).
3809 sub cust_pay_pending_attempt {
3811 return $self->num_cust_pay_pending_attempt unless wantarray;
3812 sort { $a->_date <=> $b->_date }
3813 qsearch( 'cust_pay_pending', {
3814 'custnum' => $self->custnum,
3821 =item num_cust_pay_pending
3823 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3824 customer (without status "done"). Also called automatically when the
3825 cust_pay_pending method is used in a scalar context.
3829 sub num_cust_pay_pending {
3832 " SELECT COUNT(*) FROM cust_pay_pending ".
3833 " WHERE custnum = ? AND status != 'done' ",
3838 =item num_cust_pay_pending_attempt
3840 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3841 customer, with status "done" but without a corresp. Also called automatically when the
3842 cust_pay_pending method is used in a scalar context.
3846 sub num_cust_pay_pending_attempt {
3849 " SELECT COUNT(*) FROM cust_pay_pending ".
3850 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3857 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3863 map { $_ } #return $self->num_cust_refund unless wantarray;
3864 sort { $a->_date <=> $b->_date }
3865 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3868 =item display_custnum
3870 Returns the displayed customer number for this customer: agent_custid if
3871 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3875 sub display_custnum {
3878 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3879 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3880 if ( $special eq 'CoStAg' ) {
3881 $prefix = uc( join('',
3883 ($self->state =~ /^(..)/),
3884 $prefix || ($self->agent->agent =~ /^(..)/)
3887 elsif ( $special eq 'CoStCl' ) {
3888 $prefix = uc( join('',
3890 ($self->state =~ /^(..)/),
3891 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3894 # add any others here if needed
3897 my $length = $conf->config('cust_main-custnum-display_length');
3898 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3899 return $self->agent_custid;
3900 } elsif ( $prefix ) {
3901 $length = 8 if !defined($length);
3903 sprintf('%0'.$length.'d', $self->custnum)
3904 } elsif ( $length ) {
3905 return sprintf('%0'.$length.'d', $self->custnum);
3907 return $self->custnum;
3913 Returns a name string for this customer, either "Company (Last, First)" or
3920 my $name = $self->contact;
3921 $name = $self->company. " ($name)" if $self->company;
3925 =item service_contact
3927 Returns the L<FS::contact> object for this customer that has the 'Service'
3928 contact class, or undef if there is no such contact. Deprecated; don't use
3933 sub service_contact {
3935 if ( !exists($self->{service_contact}) ) {
3936 my $classnum = $self->scalar_sql(
3937 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3938 ) || 0; #if it's zero, qsearchs will return nothing
3939 $self->{service_contact} = qsearchs('contact', {
3940 'classnum' => $classnum, 'custnum' => $self->custnum
3943 $self->{service_contact};
3948 Returns a name string for this (service/shipping) contact, either
3949 "Company (Last, First)" or "Last, First".
3956 my $name = $self->ship_contact;
3957 $name = $self->company. " ($name)" if $self->company;
3963 Returns a name string for this customer, either "Company" or "First Last".
3969 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3972 =item ship_name_short
3974 Returns a name string for this (service/shipping) contact, either "Company"
3979 sub ship_name_short {
3981 $self->service_contact
3982 ? $self->ship_contact_firstlast
3988 Returns this customer's full (billing) contact name only, "Last, First"
3994 $self->get('last'). ', '. $self->first;
3999 Returns this customer's full (shipping) contact name only, "Last, First"
4005 my $contact = $self->service_contact || $self;
4006 $contact->get('last') . ', ' . $contact->get('first');
4009 =item contact_firstlast
4011 Returns this customers full (billing) contact name only, "First Last".
4015 sub contact_firstlast {
4017 $self->first. ' '. $self->get('last');
4020 =item ship_contact_firstlast
4022 Returns this customer's full (shipping) contact name only, "First Last".
4026 sub ship_contact_firstlast {
4028 my $contact = $self->service_contact || $self;
4029 $contact->get('first') . ' '. $contact->get('last');
4032 #XXX this doesn't work in 3.x+
4035 #Returns this customer's full country name
4041 # code2country($self->country);
4044 =item county_state_county [ PREFIX ]
4046 Returns a string consisting of just the county, state and country.
4050 sub county_state_country {
4053 if ( @_ && $_[0] && $self->has_ship_address ) {
4054 $locationnum = $self->ship_locationnum;
4056 $locationnum = $self->bill_locationnum;
4058 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4059 $cust_location->county_state_country;
4062 =item geocode DATA_VENDOR
4064 Returns a value for the customer location as encoded by DATA_VENDOR.
4065 Currently this only makes sense for "CCH" as DATA_VENDOR.
4073 Returns a status string for this customer, currently:
4077 =item prospect - No packages have ever been ordered
4079 =item ordered - Recurring packages all are new (not yet billed).
4081 =item active - One or more recurring packages is active
4083 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4085 =item suspended - All non-cancelled recurring packages are suspended
4087 =item cancelled - All recurring packages are cancelled
4091 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4092 cust_main-status_module configuration option.
4096 sub status { shift->cust_status(@_); }
4100 for my $status ( FS::cust_main->statuses() ) {
4101 my $method = $status.'_sql';
4102 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4103 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4104 $sth->execute( ($self->custnum) x $numnum )
4105 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4106 return $status if $sth->fetchrow_arrayref->[0];
4110 =item ucfirst_cust_status
4112 =item ucfirst_status
4114 Returns the status with the first character capitalized.
4118 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4120 sub ucfirst_cust_status {
4122 ucfirst($self->cust_status);
4127 Returns a hex triplet color string for this customer's status.
4131 sub statuscolor { shift->cust_statuscolor(@_); }
4133 sub cust_statuscolor {
4135 __PACKAGE__->statuscolors->{$self->cust_status};
4140 Returns an array of hashes representing the customer's RT tickets.
4147 my $num = $conf->config('cust_main-max_tickets') || 10;
4150 if ( $conf->config('ticket_system') ) {
4151 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4153 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4157 foreach my $priority (
4158 $conf->config('ticket_system-custom_priority_field-values'), ''
4160 last if scalar(@tickets) >= $num;
4162 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4163 $num - scalar(@tickets),
4173 # Return services representing svc_accts in customer support packages
4174 sub support_services {
4176 my %packages = map { $_ => 1 } $conf->config('support_packages');
4178 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4179 grep { $_->part_svc->svcdb eq 'svc_acct' }
4180 map { $_->cust_svc }
4181 grep { exists $packages{ $_->pkgpart } }
4182 $self->ncancelled_pkgs;
4186 # Return a list of latitude/longitude for one of the services (if any)
4187 sub service_coordinates {
4191 grep { $_->latitude && $_->longitude }
4193 map { $_->cust_svc }
4194 $self->ncancelled_pkgs;
4196 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4201 Returns a masked version of the named field
4206 my ($self,$field) = @_;
4210 'x'x(length($self->getfield($field))-4).
4211 substr($self->getfield($field), (length($self->getfield($field))-4));
4217 =head1 CLASS METHODS
4223 Class method that returns the list of possible status strings for customers
4224 (see L<the status method|/status>). For example:
4226 @statuses = FS::cust_main->statuses();
4232 keys %{ $self->statuscolors };
4235 =item cust_status_sql
4237 Returns an SQL fragment to determine the status of a cust_main record, as a
4242 sub cust_status_sql {
4244 for my $status ( FS::cust_main->statuses() ) {
4245 my $method = $status.'_sql';
4246 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4255 Returns an SQL expression identifying prospective cust_main records (customers
4256 with no packages ever ordered)
4260 use vars qw($select_count_pkgs);
4261 $select_count_pkgs =
4262 "SELECT COUNT(*) FROM cust_pkg
4263 WHERE cust_pkg.custnum = cust_main.custnum";
4265 sub select_count_pkgs_sql {
4270 " 0 = ( $select_count_pkgs ) ";
4275 Returns an SQL expression identifying ordered cust_main records (customers with
4276 no active packages, but recurring packages not yet setup or one time charges
4282 FS::cust_main->none_active_sql.
4283 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4288 Returns an SQL expression identifying active cust_main records (customers with
4289 active recurring packages).
4294 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4297 =item none_active_sql
4299 Returns an SQL expression identifying cust_main records with no active
4300 recurring packages. This includes customers of status prospect, ordered,
4301 inactive, and suspended.
4305 sub none_active_sql {
4306 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4311 Returns an SQL expression identifying inactive cust_main records (customers with
4312 no active recurring packages, but otherwise unsuspended/uncancelled).
4317 FS::cust_main->none_active_sql.
4318 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4324 Returns an SQL expression identifying suspended cust_main records.
4329 sub suspended_sql { susp_sql(@_); }
4331 FS::cust_main->none_active_sql.
4332 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4338 Returns an SQL expression identifying cancelled cust_main records.
4342 sub cancel_sql { shift->cancelled_sql(@_); }
4345 =item uncancelled_sql
4347 Returns an SQL expression identifying un-cancelled cust_main records.
4351 sub uncancelled_sql { uncancel_sql(@_); }
4352 sub uncancel_sql { "
4353 ( 0 < ( $select_count_pkgs
4354 AND ( cust_pkg.cancel IS NULL
4355 OR cust_pkg.cancel = 0
4358 OR 0 = ( $select_count_pkgs )
4364 Returns an SQL fragment to retreive the balance.
4369 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4370 WHERE cust_bill.custnum = cust_main.custnum )
4371 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4372 WHERE cust_pay.custnum = cust_main.custnum )
4373 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4374 WHERE cust_credit.custnum = cust_main.custnum )
4375 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4376 WHERE cust_refund.custnum = cust_main.custnum )
4379 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4381 Returns an SQL fragment to retreive the balance for this customer, optionally
4382 considering invoices with date earlier than START_TIME, and not
4383 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4384 total_unapplied_payments).
4386 Times are specified as SQL fragments or numeric
4387 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4388 L<Date::Parse> for conversion functions. The empty string can be passed
4389 to disable that time constraint completely.
4391 Available options are:
4395 =item unapplied_date
4397 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)
4402 set to true to remove all customer comparison clauses, for totals
4407 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4412 JOIN clause (typically used with the total option)
4416 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4417 time will be ignored. Note that START_TIME and END_TIME only limit the date
4418 range for invoices and I<unapplied> payments, credits, and refunds.
4424 sub balance_date_sql {
4425 my( $class, $start, $end, %opt ) = @_;
4427 my $cutoff = $opt{'cutoff'};
4429 my $owed = FS::cust_bill->owed_sql($cutoff);
4430 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4431 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4432 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4434 my $j = $opt{'join'} || '';
4436 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4437 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4438 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4439 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4441 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4442 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4443 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4444 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4449 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4451 Returns an SQL fragment to retreive the total unapplied payments for this
4452 customer, only considering payments with date earlier than START_TIME, and
4453 optionally not later than END_TIME.
4455 Times are specified as SQL fragments or numeric
4456 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4457 L<Date::Parse> for conversion functions. The empty string can be passed
4458 to disable that time constraint completely.
4460 Available options are:
4464 sub unapplied_payments_date_sql {
4465 my( $class, $start, $end, %opt ) = @_;
4467 my $cutoff = $opt{'cutoff'};
4469 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4471 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4472 'unapplied_date'=>1 );
4474 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4477 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4479 Helper method for balance_date_sql; name (and usage) subject to change
4480 (suggestions welcome).
4482 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4483 cust_refund, cust_credit or cust_pay).
4485 If TABLE is "cust_bill" or the unapplied_date option is true, only
4486 considers records with date earlier than START_TIME, and optionally not
4487 later than END_TIME .
4491 sub _money_table_where {
4492 my( $class, $table, $start, $end, %opt ) = @_;
4495 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4496 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4497 push @where, "$table._date <= $start" if defined($start) && length($start);
4498 push @where, "$table._date > $end" if defined($end) && length($end);
4500 push @where, @{$opt{'where'}} if $opt{'where'};
4501 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4507 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4508 use FS::cust_main::Search;
4511 FS::cust_main::Search->search(@_);
4526 #warn join('-',keys %$param);
4527 my $fh = $param->{filehandle};
4528 my $agentnum = $param->{agentnum};
4529 my $format = $param->{format};
4531 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4534 if ( $format eq 'simple' ) {
4535 @fields = qw( custnum agent_custid amount pkg );
4537 die "unknown format $format";
4540 eval "use Text::CSV_XS;";
4543 my $csv = new Text::CSV_XS;
4550 local $SIG{HUP} = 'IGNORE';
4551 local $SIG{INT} = 'IGNORE';
4552 local $SIG{QUIT} = 'IGNORE';
4553 local $SIG{TERM} = 'IGNORE';
4554 local $SIG{TSTP} = 'IGNORE';
4555 local $SIG{PIPE} = 'IGNORE';
4557 my $oldAutoCommit = $FS::UID::AutoCommit;
4558 local $FS::UID::AutoCommit = 0;
4561 #while ( $columns = $csv->getline($fh) ) {
4563 while ( defined($line=<$fh>) ) {
4565 $csv->parse($line) or do {
4566 $dbh->rollback if $oldAutoCommit;
4567 return "can't parse: ". $csv->error_input();
4570 my @columns = $csv->fields();
4571 #warn join('-',@columns);
4574 foreach my $field ( @fields ) {
4575 $row{$field} = shift @columns;
4578 if ( $row{custnum} && $row{agent_custid} ) {
4579 dbh->rollback if $oldAutoCommit;
4580 return "can't specify custnum with agent_custid $row{agent_custid}";
4584 if ( $row{agent_custid} && $agentnum ) {
4585 %hash = ( 'agent_custid' => $row{agent_custid},
4586 'agentnum' => $agentnum,
4590 if ( $row{custnum} ) {
4591 %hash = ( 'custnum' => $row{custnum} );
4594 unless ( scalar(keys %hash) ) {
4595 $dbh->rollback if $oldAutoCommit;
4596 return "can't find customer without custnum or agent_custid and agentnum";
4599 my $cust_main = qsearchs('cust_main', { %hash } );
4600 unless ( $cust_main ) {
4601 $dbh->rollback if $oldAutoCommit;
4602 my $custnum = $row{custnum} || $row{agent_custid};
4603 return "unknown custnum $custnum";
4606 if ( $row{'amount'} > 0 ) {
4607 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4609 $dbh->rollback if $oldAutoCommit;
4613 } elsif ( $row{'amount'} < 0 ) {
4614 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4617 $dbh->rollback if $oldAutoCommit;
4627 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4629 return "Empty file!" unless $imported;
4635 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4637 Deprecated. Use event notification and message templates
4638 (L<FS::msg_template>) instead.
4640 Sends a templated email notification to the customer (see L<Text::Template>).
4642 OPTIONS is a hash and may include
4644 I<from> - the email sender (default is invoice_from)
4646 I<to> - comma-separated scalar or arrayref of recipients
4647 (default is invoicing_list)
4649 I<subject> - The subject line of the sent email notification
4650 (default is "Notice from company_name")
4652 I<extra_fields> - a hashref of name/value pairs which will be substituted
4655 The following variables are vavailable in the template.
4657 I<$first> - the customer first name
4658 I<$last> - the customer last name
4659 I<$company> - the customer company
4660 I<$payby> - a description of the method of payment for the customer
4661 # would be nice to use FS::payby::shortname
4662 I<$payinfo> - the account information used to collect for this customer
4663 I<$expdate> - the expiration of the customer payment in seconds from epoch
4668 my ($self, $template, %options) = @_;
4670 return unless $conf->exists($template);
4672 my $from = $conf->config('invoice_from', $self->agentnum)
4673 if $conf->exists('invoice_from', $self->agentnum);
4674 $from = $options{from} if exists($options{from});
4676 my $to = join(',', $self->invoicing_list_emailonly);
4677 $to = $options{to} if exists($options{to});
4679 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4680 if $conf->exists('company_name', $self->agentnum);
4681 $subject = $options{subject} if exists($options{subject});
4683 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4684 SOURCE => [ map "$_\n",
4685 $conf->config($template)]
4687 or die "can't create new Text::Template object: Text::Template::ERROR";
4688 $notify_template->compile()
4689 or die "can't compile template: Text::Template::ERROR";
4691 $FS::notify_template::_template::company_name =
4692 $conf->config('company_name', $self->agentnum);
4693 $FS::notify_template::_template::company_address =
4694 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4696 my $paydate = $self->paydate || '2037-12-31';
4697 $FS::notify_template::_template::first = $self->first;
4698 $FS::notify_template::_template::last = $self->last;
4699 $FS::notify_template::_template::company = $self->company;
4700 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4701 my $payby = $self->payby;
4702 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4703 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4705 #credit cards expire at the end of the month/year of their exp date
4706 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4707 $FS::notify_template::_template::payby = 'credit card';
4708 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4709 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4711 }elsif ($payby eq 'COMP') {
4712 $FS::notify_template::_template::payby = 'complimentary account';
4714 $FS::notify_template::_template::payby = 'current method';
4716 $FS::notify_template::_template::expdate = $expire_time;
4718 for (keys %{$options{extra_fields}}){
4720 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4723 send_email(from => $from,
4725 subject => $subject,
4726 body => $notify_template->fill_in( PACKAGE =>
4727 'FS::notify_template::_template' ),
4732 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4734 Generates a templated notification to the customer (see L<Text::Template>).
4736 OPTIONS is a hash and may include
4738 I<extra_fields> - a hashref of name/value pairs which will be substituted
4739 into the template. These values may override values mentioned below
4740 and those from the customer record.
4742 The following variables are available in the template instead of or in addition
4743 to the fields of the customer record.
4745 I<$payby> - a description of the method of payment for the customer
4746 # would be nice to use FS::payby::shortname
4747 I<$payinfo> - the masked account information used to collect for this customer
4748 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4749 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4753 # a lot like cust_bill::print_latex
4754 sub generate_letter {
4755 my ($self, $template, %options) = @_;
4757 return unless $conf->exists($template);
4759 my $letter_template = new Text::Template
4761 SOURCE => [ map "$_\n", $conf->config($template)],
4762 DELIMITERS => [ '[@--', '--@]' ],
4764 or die "can't create new Text::Template object: Text::Template::ERROR";
4766 $letter_template->compile()
4767 or die "can't compile template: Text::Template::ERROR";
4769 my %letter_data = map { $_ => $self->$_ } $self->fields;
4770 $letter_data{payinfo} = $self->mask_payinfo;
4772 #my $paydate = $self->paydate || '2037-12-31';
4773 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4775 my $payby = $self->payby;
4776 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4777 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4779 #credit cards expire at the end of the month/year of their exp date
4780 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4781 $letter_data{payby} = 'credit card';
4782 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4783 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4785 }elsif ($payby eq 'COMP') {
4786 $letter_data{payby} = 'complimentary account';
4788 $letter_data{payby} = 'current method';
4790 $letter_data{expdate} = $expire_time;
4792 for (keys %{$options{extra_fields}}){
4793 $letter_data{$_} = $options{extra_fields}->{$_};
4796 unless(exists($letter_data{returnaddress})){
4797 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4798 $self->agent_template)
4800 if ( length($retadd) ) {
4801 $letter_data{returnaddress} = $retadd;
4802 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4803 $letter_data{returnaddress} =
4804 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4808 ( $conf->config('company_name', $self->agentnum),
4809 $conf->config('company_address', $self->agentnum),
4813 $letter_data{returnaddress} = '~';
4817 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4819 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4821 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4823 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4827 ) or die "can't open temp file: $!\n";
4828 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4829 or die "can't write temp file: $!\n";
4831 $letter_data{'logo_file'} = $lh->filename;
4833 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4837 ) or die "can't open temp file: $!\n";
4839 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4841 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4842 return ($1, $letter_data{'logo_file'});
4846 =item print_ps TEMPLATE
4848 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4854 my($file, $lfile) = $self->generate_letter(@_);
4855 my $ps = FS::Misc::generate_ps($file);
4856 unlink($file.'.tex');
4862 =item print TEMPLATE
4864 Prints the filled in template.
4866 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4870 sub queueable_print {
4873 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4874 or die "invalid customer number: " . $opt{custvnum};
4876 my $error = $self->print( $opt{template} );
4877 die $error if $error;
4881 my ($self, $template) = (shift, shift);
4883 [ $self->print_ps($template) ],
4884 'agentnum' => $self->agentnum,
4888 #these three subs should just go away once agent stuff is all config overrides
4890 sub agent_template {
4892 $self->_agent_plandata('agent_templatename');
4895 sub agent_invoice_from {
4897 $self->_agent_plandata('agent_invoice_from');
4900 sub _agent_plandata {
4901 my( $self, $option ) = @_;
4903 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4904 #agent-specific Conf
4906 use FS::part_event::Condition;
4908 my $agentnum = $self->agentnum;
4910 my $regexp = regexp_sql();
4912 my $part_event_option =
4914 'select' => 'part_event_option.*',
4915 'table' => 'part_event_option',
4917 LEFT JOIN part_event USING ( eventpart )
4918 LEFT JOIN part_event_option AS peo_agentnum
4919 ON ( part_event.eventpart = peo_agentnum.eventpart
4920 AND peo_agentnum.optionname = 'agentnum'
4921 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4923 LEFT JOIN part_event_condition
4924 ON ( part_event.eventpart = part_event_condition.eventpart
4925 AND part_event_condition.conditionname = 'cust_bill_age'
4927 LEFT JOIN part_event_condition_option
4928 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4929 AND part_event_condition_option.optionname = 'age'
4932 #'hashref' => { 'optionname' => $option },
4933 #'hashref' => { 'part_event_option.optionname' => $option },
4935 " WHERE part_event_option.optionname = ". dbh->quote($option).
4936 " AND action = 'cust_bill_send_agent' ".
4937 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4938 " AND peo_agentnum.optionname = 'agentnum' ".
4939 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4941 CASE WHEN part_event_condition_option.optionname IS NULL
4943 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4945 , part_event.weight".
4949 unless ( $part_event_option ) {
4950 return $self->agent->invoice_template || ''
4951 if $option eq 'agent_templatename';
4955 $part_event_option->optionvalue;
4959 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4961 Subroutine (not a method), designed to be called from the queue.
4963 Takes a list of options and values.
4965 Pulls up the customer record via the custnum option and calls bill_and_collect.
4970 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4972 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4973 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4975 $cust_main->bill_and_collect( %args );
4978 sub process_bill_and_collect {
4980 my $param = thaw(decode_base64(shift));
4981 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4982 or die "custnum '$param->{custnum}' not found!\n";
4983 $param->{'job'} = $job;
4984 $param->{'fatal'} = 1; # runs from job queue, will be caught
4985 $param->{'retry'} = 1;
4987 $cust_main->bill_and_collect( %$param );
4990 #starting to take quite a while for big dbs
4991 # (JRNL: journaled so it only happens once per database)
4992 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
4993 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
4994 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
4995 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
4996 # JRNL leading/trailing spaces in first, last, company
4997 # - otaker upgrade? journal and call it good? (double check to make sure
4998 # we're not still setting otaker here)
5000 #only going to get worse with new location stuff...
5002 sub _upgrade_data { #class method
5003 my ($class, %opts) = @_;
5006 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5009 #this seems to be the only expensive one.. why does it take so long?
5010 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5012 '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';
5013 FS::upgrade_journal->set_done('cust_main__signupdate');
5016 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5018 # fix yyyy-m-dd formatted paydates
5019 if ( driver_name =~ /^mysql/i ) {
5021 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5022 } else { # the SQL standard
5024 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5026 FS::upgrade_journal->set_done('cust_main__paydate');
5029 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5031 push @statements, #fix the weird BILL with a cc# in payinfo problem
5033 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5035 FS::upgrade_journal->set_done('cust_main__payinfo');
5040 foreach my $sql ( @statements ) {
5041 my $sth = dbh->prepare($sql) or die dbh->errstr;
5042 $sth->execute or die $sth->errstr;
5043 #warn ( (time - $t). " seconds\n" );
5047 local($ignore_expired_card) = 1;
5048 local($ignore_banned_card) = 1;
5049 local($skip_fuzzyfiles) = 1;
5050 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5052 FS::cust_main::Location->_upgrade_data(%opts);
5054 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5056 foreach my $cust_main ( qsearch({
5057 'table' => 'cust_main',
5059 'extra_sql' => 'WHERE '.
5061 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5062 qw( first last company )
5065 my $error = $cust_main->replace;
5066 die $error if $error;
5069 FS::upgrade_journal->set_done('cust_main__trimspaces');
5073 $class->_upgrade_otaker(%opts);
5083 The delete method should possibly take an FS::cust_main object reference
5084 instead of a scalar customer number.
5086 Bill and collect options should probably be passed as references instead of a
5089 There should probably be a configuration file with a list of allowed credit
5092 No multiple currency support (probably a larger project than just this module).
5094 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5096 Birthdates rely on negative epoch values.
5098 The payby for card/check batches is broken. With mixed batching, bad
5101 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5105 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5106 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5107 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.