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::Billing_ThirdParty
10 FS::cust_main::Location
11 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
12 FS::geocode_Mixin FS::Quotable_Mixin
16 use vars qw( $DEBUG $me $conf
19 $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
24 use Scalar::Util qw( blessed );
25 use Time::Local qw(timelocal);
26 use Storable qw(thaw);
30 use Digest::MD5 qw(md5_base64);
33 use File::Temp; #qw( tempfile );
34 use Business::CreditCard 0.28;
36 use FS::UID qw( getotaker dbh driver_name );
37 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
38 use FS::Misc qw( generate_email send_email generate_ps do_print );
39 use FS::Msgcat qw(gettext);
46 use FS::cust_bill_void;
47 use FS::legacy_cust_bill;
49 use FS::cust_pay_pending;
50 use FS::cust_pay_void;
51 use FS::cust_pay_batch;
54 use FS::part_referral;
55 use FS::cust_main_county;
56 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
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,
978 This method is deprecated. See the I<depend_jobnum> option to the insert and
979 order_pkgs methods for a better way to defer provisioning.
981 Re-schedules all exports by calling the B<reexport> method of all associated
982 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
983 otherwise returns false.
990 carp "WARNING: FS::cust_main::reexport is deprectated; ".
991 "use the depend_jobnum option to insert or order_pkgs to delay export";
993 local $SIG{HUP} = 'IGNORE';
994 local $SIG{INT} = 'IGNORE';
995 local $SIG{QUIT} = 'IGNORE';
996 local $SIG{TERM} = 'IGNORE';
997 local $SIG{TSTP} = 'IGNORE';
998 local $SIG{PIPE} = 'IGNORE';
1000 my $oldAutoCommit = $FS::UID::AutoCommit;
1001 local $FS::UID::AutoCommit = 0;
1004 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1005 my $error = $cust_pkg->reexport;
1007 $dbh->rollback if $oldAutoCommit;
1012 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1017 =item delete [ OPTION => VALUE ... ]
1019 This deletes the customer. If there is an error, returns the error, otherwise
1022 This will completely remove all traces of the customer record. This is not
1023 what you want when a customer cancels service; for that, cancel all of the
1024 customer's packages (see L</cancel>).
1026 If the customer has any uncancelled packages, you need to pass a new (valid)
1027 customer number for those packages to be transferred to, as the "new_customer"
1028 option. Cancelled packages will be deleted. Did I mention that this is NOT
1029 what you want when a customer cancels service and that you really should be
1030 looking at L<FS::cust_pkg/cancel>?
1032 You can't delete a customer with invoices (see L<FS::cust_bill>),
1033 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1034 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1035 set the "delete_financials" option to a true value.
1040 my( $self, %opt ) = @_;
1042 local $SIG{HUP} = 'IGNORE';
1043 local $SIG{INT} = 'IGNORE';
1044 local $SIG{QUIT} = 'IGNORE';
1045 local $SIG{TERM} = 'IGNORE';
1046 local $SIG{TSTP} = 'IGNORE';
1047 local $SIG{PIPE} = 'IGNORE';
1049 my $oldAutoCommit = $FS::UID::AutoCommit;
1050 local $FS::UID::AutoCommit = 0;
1053 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1054 $dbh->rollback if $oldAutoCommit;
1055 return "Can't delete a master agent customer";
1058 #use FS::access_user
1059 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1060 $dbh->rollback if $oldAutoCommit;
1061 return "Can't delete a master employee customer";
1064 tie my %financial_tables, 'Tie::IxHash',
1065 'cust_bill' => 'invoices',
1066 'cust_statement' => 'statements',
1067 'cust_credit' => 'credits',
1068 'cust_pay' => 'payments',
1069 'cust_refund' => 'refunds',
1072 foreach my $table ( keys %financial_tables ) {
1074 my @records = $self->$table();
1076 if ( @records && ! $opt{'delete_financials'} ) {
1077 $dbh->rollback if $oldAutoCommit;
1078 return "Can't delete a customer with ". $financial_tables{$table};
1081 foreach my $record ( @records ) {
1082 my $error = $record->delete;
1084 $dbh->rollback if $oldAutoCommit;
1085 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1091 my @cust_pkg = $self->ncancelled_pkgs;
1093 my $new_custnum = $opt{'new_custnum'};
1094 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1095 $dbh->rollback if $oldAutoCommit;
1096 return "Invalid new customer number: $new_custnum";
1098 foreach my $cust_pkg ( @cust_pkg ) {
1099 my %hash = $cust_pkg->hash;
1100 $hash{'custnum'} = $new_custnum;
1101 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1102 my $error = $new_cust_pkg->replace($cust_pkg,
1103 options => { $cust_pkg->options },
1106 $dbh->rollback if $oldAutoCommit;
1111 my @cancelled_cust_pkg = $self->all_pkgs;
1112 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1113 my $error = $cust_pkg->delete;
1115 $dbh->rollback if $oldAutoCommit;
1120 #cust_tax_adjustment in financials?
1121 #cust_pay_pending? ouch
1123 foreach my $table (qw(
1124 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1125 cust_location cust_main_note cust_tax_adjustment
1126 cust_pay_void cust_pay_batch queue cust_tax_exempt
1128 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1129 my $error = $record->delete;
1131 $dbh->rollback if $oldAutoCommit;
1137 my $sth = $dbh->prepare(
1138 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1140 my $errstr = $dbh->errstr;
1141 $dbh->rollback if $oldAutoCommit;
1144 $sth->execute($self->custnum) or do {
1145 my $errstr = $sth->errstr;
1146 $dbh->rollback if $oldAutoCommit;
1152 my $ticket_dbh = '';
1153 if ($conf->config('ticket_system') eq 'RT_Internal') {
1155 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1156 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1157 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1158 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1161 if ( $ticket_dbh ) {
1163 my $ticket_sth = $ticket_dbh->prepare(
1164 'DELETE FROM Links WHERE Target = ?'
1166 my $errstr = $ticket_dbh->errstr;
1167 $dbh->rollback if $oldAutoCommit;
1170 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1172 my $errstr = $ticket_sth->errstr;
1173 $dbh->rollback if $oldAutoCommit;
1177 #check and see if the customer is the only link on the ticket, and
1178 #if so, set the ticket to deleted status in RT?
1179 #maybe someday, for now this will at least fix tickets not displaying
1183 #delete the customer record
1185 my $error = $self->SUPER::delete;
1187 $dbh->rollback if $oldAutoCommit;
1191 # cust_main exports!
1193 #my $export_args = $options{'export_args'} || [];
1196 map qsearch( 'part_export', {exportnum=>$_} ),
1197 $conf->config('cust_main-exports'); #, $agentnum
1199 foreach my $part_export ( @part_export ) {
1200 my $error = $part_export->export_delete( $self ); #, @$export_args);
1202 $dbh->rollback if $oldAutoCommit;
1203 return "exporting to ". $part_export->exporttype.
1204 " (transaction rolled back): $error";
1208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1213 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1215 This merges this customer into the provided new custnum, and then deletes the
1216 customer. If there is an error, returns the error, otherwise returns false.
1218 The source customer's name, company name, phone numbers, agent,
1219 referring customer, customer class, advertising source, order taker, and
1220 billing information (except balance) are discarded.
1222 All packages are moved to the target customer. Packages with package locations
1223 are preserved. Packages without package locations are moved to a new package
1224 location with the source customer's service/shipping address.
1226 All invoices, statements, payments, credits and refunds are moved to the target
1227 customer. The source customer's balance is added to the target customer.
1229 All notes, attachments, tickets and customer tags are moved to the target
1232 Change history is not currently moved.
1237 my( $self, $new_custnum, %opt ) = @_;
1239 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1241 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1242 or return "Invalid new customer number: $new_custnum";
1244 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1245 if $self->agentnum != $new_cust_main->agentnum
1246 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1248 local $SIG{HUP} = 'IGNORE';
1249 local $SIG{INT} = 'IGNORE';
1250 local $SIG{QUIT} = 'IGNORE';
1251 local $SIG{TERM} = 'IGNORE';
1252 local $SIG{TSTP} = 'IGNORE';
1253 local $SIG{PIPE} = 'IGNORE';
1255 my $oldAutoCommit = $FS::UID::AutoCommit;
1256 local $FS::UID::AutoCommit = 0;
1259 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1260 $dbh->rollback if $oldAutoCommit;
1261 return "Can't merge a master agent customer";
1264 #use FS::access_user
1265 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1266 $dbh->rollback if $oldAutoCommit;
1267 return "Can't merge a master employee customer";
1270 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1271 'status' => { op=>'!=', value=>'done' },
1275 $dbh->rollback if $oldAutoCommit;
1276 return "Can't merge a customer with pending payments";
1279 tie my %financial_tables, 'Tie::IxHash',
1280 'cust_bill' => 'invoices',
1281 'cust_bill_void' => 'voided invoices',
1282 'cust_statement' => 'statements',
1283 'cust_credit' => 'credits',
1284 'cust_pay' => 'payments',
1285 'cust_pay_void' => 'voided payments',
1286 'cust_refund' => 'refunds',
1289 foreach my $table ( keys %financial_tables ) {
1291 my @records = $self->$table();
1293 foreach my $record ( @records ) {
1294 $record->custnum($new_custnum);
1295 my $error = $record->replace;
1297 $dbh->rollback if $oldAutoCommit;
1298 return "Error merging ". $financial_tables{$table}. ": $error\n";
1304 my $name = $self->ship_name; #?
1306 my $locationnum = '';
1307 foreach my $cust_pkg ( $self->all_pkgs ) {
1308 $cust_pkg->custnum($new_custnum);
1310 unless ( $cust_pkg->locationnum ) {
1311 unless ( $locationnum ) {
1312 my $cust_location = new FS::cust_location {
1313 $self->location_hash,
1314 'custnum' => $new_custnum,
1316 my $error = $cust_location->insert;
1318 $dbh->rollback if $oldAutoCommit;
1321 $locationnum = $cust_location->locationnum;
1323 $cust_pkg->locationnum($locationnum);
1326 my $error = $cust_pkg->replace;
1328 $dbh->rollback if $oldAutoCommit;
1332 # add customer (ship) name to svc_phone.phone_name if blank
1333 my @cust_svc = $cust_pkg->cust_svc;
1334 foreach my $cust_svc (@cust_svc) {
1335 my($label, $value, $svcdb) = $cust_svc->label;
1336 next unless $svcdb eq 'svc_phone';
1337 my $svc_phone = $cust_svc->svc_x;
1338 next if $svc_phone->phone_name;
1339 $svc_phone->phone_name($name);
1340 my $error = $svc_phone->replace;
1342 $dbh->rollback if $oldAutoCommit;
1350 # cust_tax_exempt (texas tax exemptions)
1351 # cust_recon (some sort of not-well understood thing for OnPac)
1353 #these are moved over
1354 foreach my $table (qw(
1355 cust_tag cust_location contact cust_attachment cust_main_note
1356 cust_tax_adjustment cust_pay_batch queue
1358 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1359 $record->custnum($new_custnum);
1360 my $error = $record->replace;
1362 $dbh->rollback if $oldAutoCommit;
1368 #these aren't preserved
1369 foreach my $table (qw(
1370 cust_main_exemption cust_main_invoice
1372 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1373 my $error = $record->delete;
1375 $dbh->rollback if $oldAutoCommit;
1382 my $sth = $dbh->prepare(
1383 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1385 my $errstr = $dbh->errstr;
1386 $dbh->rollback if $oldAutoCommit;
1389 $sth->execute($new_custnum, $self->custnum) or do {
1390 my $errstr = $sth->errstr;
1391 $dbh->rollback if $oldAutoCommit;
1397 my $ticket_dbh = '';
1398 if ($conf->config('ticket_system') eq 'RT_Internal') {
1400 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1401 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1402 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1403 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1406 if ( $ticket_dbh ) {
1408 my $ticket_sth = $ticket_dbh->prepare(
1409 'UPDATE Links SET Target = ? WHERE Target = ?'
1411 my $errstr = $ticket_dbh->errstr;
1412 $dbh->rollback if $oldAutoCommit;
1415 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1416 'freeside://freeside/cust_main/'.$self->custnum)
1418 my $errstr = $ticket_sth->errstr;
1419 $dbh->rollback if $oldAutoCommit;
1425 #delete the customer record
1427 my $error = $self->delete;
1429 $dbh->rollback if $oldAutoCommit;
1433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1438 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1440 Replaces the OLD_RECORD with this one in the database. If there is an error,
1441 returns the error, otherwise returns false.
1443 To change the customer's address, set the pseudo-fields C<bill_location> and
1444 C<ship_location>. The address will still only change if at least one of the
1445 address fields differs from the existing values.
1447 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1448 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1449 expected and rollback the entire transaction; it is not necessary to call
1450 check_invoicing_list first. Here's an example:
1452 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1454 Currently available options are: I<tax_exemption>.
1456 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1457 of tax names and exemption numbers. FS::cust_main_exemption records will be
1458 deleted and inserted as appropriate.
1465 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1467 : $self->replace_old;
1471 warn "$me replace called\n"
1474 my $curuser = $FS::CurrentUser::CurrentUser;
1475 if ( $self->payby eq 'COMP'
1476 && $self->payby ne $old->payby
1477 && ! $curuser->access_right('Complimentary customer')
1480 return "You are not permitted to create complimentary accounts.";
1483 local($ignore_expired_card) = 1
1484 if $old->payby =~ /^(CARD|DCRD)$/
1485 && $self->payby =~ /^(CARD|DCRD)$/
1486 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1488 local($ignore_banned_card) = 1
1489 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1490 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1491 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1493 return "Invoicing locale is required"
1496 && $conf->exists('cust_main-require_locale');
1498 local $SIG{HUP} = 'IGNORE';
1499 local $SIG{INT} = 'IGNORE';
1500 local $SIG{QUIT} = 'IGNORE';
1501 local $SIG{TERM} = 'IGNORE';
1502 local $SIG{TSTP} = 'IGNORE';
1503 local $SIG{PIPE} = 'IGNORE';
1505 my $oldAutoCommit = $FS::UID::AutoCommit;
1506 local $FS::UID::AutoCommit = 0;
1509 for my $l (qw(bill_location ship_location)) {
1510 my $old_loc = $old->$l;
1511 my $new_loc = $self->$l;
1513 # find the existing location if there is one
1514 $new_loc->set('custnum' => $self->custnum);
1515 my $error = $new_loc->find_or_insert;
1517 $dbh->rollback if $oldAutoCommit;
1520 $self->set($l.'num', $new_loc->locationnum);
1523 # replace the customer record
1524 my $error = $self->SUPER::replace($old);
1527 $dbh->rollback if $oldAutoCommit;
1531 # now move packages to the new service location
1532 $self->set('ship_location', ''); #flush cache
1533 if ( $old->ship_locationnum and # should only be null during upgrade...
1534 $old->ship_locationnum != $self->ship_locationnum ) {
1535 $error = $old->ship_location->move_to($self->ship_location);
1537 $dbh->rollback if $oldAutoCommit;
1541 # don't move packages based on the billing location, but
1542 # disable it if it's no longer in use
1543 if ( $old->bill_locationnum and
1544 $old->bill_locationnum != $self->bill_locationnum ) {
1545 $error = $old->bill_location->disable_if_unused;
1547 $dbh->rollback if $oldAutoCommit;
1552 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1553 my $invoicing_list = shift @param;
1554 $error = $self->check_invoicing_list( $invoicing_list );
1556 $dbh->rollback if $oldAutoCommit;
1559 $self->invoicing_list( $invoicing_list );
1562 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1564 #this could be more efficient than deleting and re-inserting, if it matters
1565 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1566 my $error = $cust_tag->delete;
1568 $dbh->rollback if $oldAutoCommit;
1572 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1573 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1574 'custnum' => $self->custnum };
1575 my $error = $cust_tag->insert;
1577 $dbh->rollback if $oldAutoCommit;
1584 my %options = @param;
1586 my $tax_exemption = delete $options{'tax_exemption'};
1587 if ( $tax_exemption ) {
1589 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1590 if ref($tax_exemption) eq 'ARRAY';
1592 my %cust_main_exemption =
1593 map { $_->taxname => $_ }
1594 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1596 foreach my $taxname ( keys %$tax_exemption ) {
1598 if ( $cust_main_exemption{$taxname} &&
1599 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1602 delete $cust_main_exemption{$taxname};
1606 my $cust_main_exemption = new FS::cust_main_exemption {
1607 'custnum' => $self->custnum,
1608 'taxname' => $taxname,
1609 'exempt_number' => $tax_exemption->{$taxname},
1611 my $error = $cust_main_exemption->insert;
1613 $dbh->rollback if $oldAutoCommit;
1614 return "inserting cust_main_exemption (transaction rolled back): $error";
1618 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1619 my $error = $cust_main_exemption->delete;
1621 $dbh->rollback if $oldAutoCommit;
1622 return "deleting cust_main_exemption (transaction rolled back): $error";
1628 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1629 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1630 && $self->get('payinfo') !~ /^99\d{14}$/
1632 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1637 # card/check/lec info has changed, want to retry realtime_ invoice events
1638 my $error = $self->retry_realtime;
1640 $dbh->rollback if $oldAutoCommit;
1645 unless ( $import || $skip_fuzzyfiles ) {
1646 $error = $self->queue_fuzzyfiles_update;
1648 $dbh->rollback if $oldAutoCommit;
1649 return "updating fuzzy search cache: $error";
1653 # tax district update in cust_location
1655 # cust_main exports!
1657 my $export_args = $options{'export_args'} || [];
1660 map qsearch( 'part_export', {exportnum=>$_} ),
1661 $conf->config('cust_main-exports'); #, $agentnum
1663 foreach my $part_export ( @part_export ) {
1664 my $error = $part_export->export_replace( $self, $old, @$export_args);
1666 $dbh->rollback if $oldAutoCommit;
1667 return "exporting to ". $part_export->exporttype.
1668 " (transaction rolled back): $error";
1672 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1677 =item queue_fuzzyfiles_update
1679 Used by insert & replace to update the fuzzy search cache
1683 use FS::cust_main::Search;
1684 sub queue_fuzzyfiles_update {
1687 local $SIG{HUP} = 'IGNORE';
1688 local $SIG{INT} = 'IGNORE';
1689 local $SIG{QUIT} = 'IGNORE';
1690 local $SIG{TERM} = 'IGNORE';
1691 local $SIG{TSTP} = 'IGNORE';
1692 local $SIG{PIPE} = 'IGNORE';
1694 my $oldAutoCommit = $FS::UID::AutoCommit;
1695 local $FS::UID::AutoCommit = 0;
1698 my @locations = $self->bill_location;
1699 push @locations, $self->ship_location if $self->has_ship_address;
1700 foreach my $location (@locations) {
1701 my $queue = new FS::queue {
1702 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1704 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1705 my $error = $queue->insert( @args );
1707 $dbh->rollback if $oldAutoCommit;
1708 return "queueing job (transaction rolled back): $error";
1712 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1719 Checks all fields to make sure this is a valid customer record. If there is
1720 an error, returns the error, otherwise returns false. Called by the insert
1721 and replace methods.
1728 warn "$me check BEFORE: \n". $self->_dump
1732 $self->ut_numbern('custnum')
1733 || $self->ut_number('agentnum')
1734 || $self->ut_textn('agent_custid')
1735 || $self->ut_number('refnum')
1736 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1737 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1738 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1739 || $self->ut_textn('custbatch')
1740 || $self->ut_name('last')
1741 || $self->ut_name('first')
1742 || $self->ut_snumbern('signupdate')
1743 || $self->ut_snumbern('birthdate')
1744 || $self->ut_snumbern('spouse_birthdate')
1745 || $self->ut_snumbern('anniversary_date')
1746 || $self->ut_textn('company')
1747 || $self->ut_anything('comments')
1748 || $self->ut_numbern('referral_custnum')
1749 || $self->ut_textn('stateid')
1750 || $self->ut_textn('stateid_state')
1751 || $self->ut_textn('invoice_terms')
1752 || $self->ut_floatn('cdr_termination_percentage')
1753 || $self->ut_floatn('credit_limit')
1754 || $self->ut_numbern('billday')
1755 || $self->ut_numbern('prorate_day')
1756 || $self->ut_flag('edit_subject')
1757 || $self->ut_flag('calling_list_exempt')
1758 || $self->ut_flag('invoice_noemail')
1759 || $self->ut_flag('message_noemail')
1760 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1763 my $company = $self->company;
1764 $company =~ s/^\s+//;
1765 $company =~ s/\s+$//;
1766 $company =~ s/\s+/ /g;
1767 $self->company($company);
1769 #barf. need message catalogs. i18n. etc.
1770 $error .= "Please select an advertising source."
1771 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1772 return $error if $error;
1774 return "Unknown agent"
1775 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1777 return "Unknown refnum"
1778 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1780 return "Unknown referring custnum: ". $self->referral_custnum
1781 unless ! $self->referral_custnum
1782 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1784 if ( $self->ss eq '' ) {
1789 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1790 or return "Illegal social security number: ". $self->ss;
1791 $self->ss("$1-$2-$3");
1794 # cust_main_county verification now handled by cust_location check
1797 $self->ut_phonen('daytime', $self->country)
1798 || $self->ut_phonen('night', $self->country)
1799 || $self->ut_phonen('fax', $self->country)
1800 || $self->ut_phonen('mobile', $self->country)
1802 return $error if $error;
1804 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1806 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1809 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1811 : FS::Msgcat::_gettext('daytime');
1812 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1814 : FS::Msgcat::_gettext('night');
1816 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1818 : FS::Msgcat::_gettext('mobile');
1820 return "$daytime_label, $night_label or $mobile_label is required"
1824 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1825 # or return "Illegal payby: ". $self->payby;
1827 FS::payby->can_payby($self->table, $self->payby)
1828 or return "Illegal payby: ". $self->payby;
1830 $error = $self->ut_numbern('paystart_month')
1831 || $self->ut_numbern('paystart_year')
1832 || $self->ut_numbern('payissue')
1833 || $self->ut_textn('paytype')
1835 return $error if $error;
1837 if ( $self->payip eq '' ) {
1840 $error = $self->ut_ip('payip');
1841 return $error if $error;
1844 # If it is encrypted and the private key is not availaible then we can't
1845 # check the credit card.
1846 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1848 # Need some kind of global flag to accept invalid cards, for testing
1850 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1852 my $payinfo = $self->payinfo;
1853 $payinfo =~ s/\D//g;
1854 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1855 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1857 $self->payinfo($payinfo);
1859 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1861 return gettext('unknown_card_type')
1862 if $self->payinfo !~ /^99\d{14}$/ #token
1863 && cardtype($self->payinfo) eq "Unknown";
1865 unless ( $ignore_banned_card ) {
1866 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1868 if ( $ban->bantype eq 'warn' ) {
1869 #or others depending on value of $ban->reason ?
1870 return '_duplicate_card'.
1871 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1872 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1873 ' (ban# '. $ban->bannum. ')'
1874 unless $self->override_ban_warn;
1876 return 'Banned credit card: banned on '.
1877 time2str('%a %h %o at %r', $ban->_date).
1878 ' by '. $ban->otaker.
1879 ' (ban# '. $ban->bannum. ')';
1884 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1885 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1886 $self->paycvv =~ /^(\d{4})$/
1887 or return "CVV2 (CID) for American Express cards is four digits.";
1890 $self->paycvv =~ /^(\d{3})$/
1891 or return "CVV2 (CVC2/CID) is three digits.";
1898 my $cardtype = cardtype($payinfo);
1899 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1901 return "Start date or issue number is required for $cardtype cards"
1902 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1904 return "Start month must be between 1 and 12"
1905 if $self->paystart_month
1906 and $self->paystart_month < 1 || $self->paystart_month > 12;
1908 return "Start year must be 1990 or later"
1909 if $self->paystart_year
1910 and $self->paystart_year < 1990;
1912 return "Issue number must be beween 1 and 99"
1914 and $self->payissue < 1 || $self->payissue > 99;
1917 $self->paystart_month('');
1918 $self->paystart_year('');
1919 $self->payissue('');
1922 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1924 my $payinfo = $self->payinfo;
1925 $payinfo =~ s/[^\d\@\.]//g;
1926 if ( $conf->config('echeck-country') eq 'CA' ) {
1927 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1928 or return 'invalid echeck account@branch.bank';
1929 $payinfo = "$1\@$2.$3";
1930 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1931 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1932 $payinfo = "$1\@$2";
1934 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1935 $payinfo = "$1\@$2";
1937 $self->payinfo($payinfo);
1940 unless ( $ignore_banned_card ) {
1941 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1943 if ( $ban->bantype eq 'warn' ) {
1944 #or others depending on value of $ban->reason ?
1945 return '_duplicate_ach' unless $self->override_ban_warn;
1947 return 'Banned ACH account: banned on '.
1948 time2str('%a %h %o at %r', $ban->_date).
1949 ' by '. $ban->otaker.
1950 ' (ban# '. $ban->bannum. ')';
1955 } elsif ( $self->payby eq 'LECB' ) {
1957 my $payinfo = $self->payinfo;
1958 $payinfo =~ s/\D//g;
1959 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1961 $self->payinfo($payinfo);
1964 } elsif ( $self->payby eq 'BILL' ) {
1966 $error = $self->ut_textn('payinfo');
1967 return "Illegal P.O. number: ". $self->payinfo if $error;
1970 } elsif ( $self->payby eq 'COMP' ) {
1972 my $curuser = $FS::CurrentUser::CurrentUser;
1973 if ( ! $self->custnum
1974 && ! $curuser->access_right('Complimentary customer')
1977 return "You are not permitted to create complimentary accounts."
1980 $error = $self->ut_textn('payinfo');
1981 return "Illegal comp account issuer: ". $self->payinfo if $error;
1984 } elsif ( $self->payby eq 'PREPAY' ) {
1986 my $payinfo = $self->payinfo;
1987 $payinfo =~ s/\W//g; #anything else would just confuse things
1988 $self->payinfo($payinfo);
1989 $error = $self->ut_alpha('payinfo');
1990 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1991 return "Unknown prepayment identifier"
1992 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1997 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1998 return "Expiration date required"
1999 # shouldn't payinfo_check do this?
2000 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2004 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2005 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2006 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2007 ( $m, $y ) = ( $2, "19$1" );
2008 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2009 ( $m, $y ) = ( $3, "20$2" );
2011 return "Illegal expiration date: ". $self->paydate;
2013 $m = sprintf('%02d',$m);
2014 $self->paydate("$y-$m-01");
2015 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2016 return gettext('expired_card')
2018 && !$ignore_expired_card
2019 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2022 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2023 ( ! $conf->exists('require_cardname')
2024 || $self->payby !~ /^(CARD|DCRD)$/ )
2026 $self->payname( $self->first. " ". $self->getfield('last') );
2028 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2029 or return gettext('illegal_name'). " payname: ". $self->payname;
2033 return "Please select an invoicing locale"
2036 && $conf->exists('cust_main-require_locale');
2038 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2039 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2043 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2045 warn "$me check AFTER: \n". $self->_dump
2048 $self->SUPER::check;
2053 Returns a list of fields which have ship_ duplicates.
2058 qw( last first company
2059 address1 address2 city county state zip country
2061 daytime night fax mobile
2065 =item has_ship_address
2067 Returns true if this customer record has a separate shipping address.
2071 sub has_ship_address {
2073 $self->bill_locationnum != $self->ship_locationnum;
2078 Returns a list of key/value pairs, with the following keys: address1,
2079 adddress2, city, county, state, zip, country, district, and geocode. The
2080 shipping address is used if present.
2086 $self->ship_location->location_hash;
2091 Returns all locations (see L<FS::cust_location>) for this customer.
2097 qsearch('cust_location', { 'custnum' => $self->custnum,
2098 'prospectnum' => '' } );
2103 Returns all contacts (see L<FS::contact>) for this customer.
2107 #already used :/ sub contact {
2110 qsearch('contact', { 'custnum' => $self->custnum } );
2115 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2116 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2117 on success or a list of errors.
2123 grep { $_->unsuspend } $self->suspended_pkgs;
2128 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2130 Returns a list: an empty list on success or a list of errors.
2136 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2139 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2141 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2142 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2143 of a list of pkgparts; the hashref has the following keys:
2147 =item pkgparts - listref of pkgparts
2149 =item (other options are passed to the suspend method)
2154 Returns a list: an empty list on success or a list of errors.
2158 sub suspend_if_pkgpart {
2160 my (@pkgparts, %opt);
2161 if (ref($_[0]) eq 'HASH'){
2162 @pkgparts = @{$_[0]{pkgparts}};
2167 grep { $_->suspend(%opt) }
2168 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2169 $self->unsuspended_pkgs;
2172 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2174 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2175 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2176 instead of a list of pkgparts; the hashref has the following keys:
2180 =item pkgparts - listref of pkgparts
2182 =item (other options are passed to the suspend method)
2186 Returns a list: an empty list on success or a list of errors.
2190 sub suspend_unless_pkgpart {
2192 my (@pkgparts, %opt);
2193 if (ref($_[0]) eq 'HASH'){
2194 @pkgparts = @{$_[0]{pkgparts}};
2199 grep { $_->suspend(%opt) }
2200 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2201 $self->unsuspended_pkgs;
2204 =item cancel [ OPTION => VALUE ... ]
2206 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2208 Available options are:
2212 =item quiet - can be set true to supress email cancellation notices.
2214 =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.
2216 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2218 =item nobill - can be set true to skip billing if it might otherwise be done.
2222 Always returns a list: an empty list on success or a list of errors.
2226 # nb that dates are not specified as valid options to this method
2229 my( $self, %opt ) = @_;
2231 warn "$me cancel called on customer ". $self->custnum. " with options ".
2232 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2235 return ( 'access denied' )
2236 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2238 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2240 #should try decryption (we might have the private key)
2241 # and if not maybe queue a job for the server that does?
2242 return ( "Can't (yet) ban encrypted credit cards" )
2243 if $self->is_encrypted($self->payinfo);
2245 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2246 my $error = $ban->insert;
2247 return ( $error ) if $error;
2251 my @pkgs = $self->ncancelled_pkgs;
2253 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2255 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2256 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2260 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2261 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2264 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2267 sub _banned_pay_hashref {
2278 'payby' => $payby2ban{$self->payby},
2279 'payinfo' => $self->payinfo,
2280 #don't ever *search* on reason! #'reason' =>
2284 sub _new_banned_pay_hashref {
2286 my $hr = $self->_banned_pay_hashref;
2287 $hr->{payinfo} = md5_base64($hr->{payinfo});
2293 Returns all notes (see L<FS::cust_main_note>) for this customer.
2298 my($self,$orderby_classnum) = (shift,shift);
2299 my $orderby = "_DATE DESC";
2300 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2301 qsearch( 'cust_main_note',
2302 { 'custnum' => $self->custnum },
2304 "ORDER BY $orderby",
2310 Returns the agent (see L<FS::agent>) for this customer.
2316 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2321 Returns the agent name (see L<FS::agent>) for this customer.
2327 $self->agent->agent;
2332 Returns any tags associated with this customer, as FS::cust_tag objects,
2333 or an empty list if there are no tags.
2339 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2344 Returns any tags associated with this customer, as FS::part_tag objects,
2345 or an empty list if there are no tags.
2351 map $_->part_tag, $self->cust_tag;
2357 Returns the customer class, as an FS::cust_class object, or the empty string
2358 if there is no customer class.
2364 if ( $self->classnum ) {
2365 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2373 Returns the customer category name, or the empty string if there is no customer
2380 my $cust_class = $self->cust_class;
2382 ? $cust_class->categoryname
2388 Returns the customer class name, or the empty string if there is no customer
2395 my $cust_class = $self->cust_class;
2397 ? $cust_class->classname
2401 =item BILLING METHODS
2403 Documentation on billing methods has been moved to
2404 L<FS::cust_main::Billing>.
2406 =item REALTIME BILLING METHODS
2408 Documentation on realtime billing methods has been moved to
2409 L<FS::cust_main::Billing_Realtime>.
2413 Removes the I<paycvv> field from the database directly.
2415 If there is an error, returns the error, otherwise returns false.
2421 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2422 or return dbh->errstr;
2423 $sth->execute($self->custnum)
2424 or return $sth->errstr;
2429 =item batch_card OPTION => VALUE...
2431 Adds a payment for this invoice to the pending credit card batch (see
2432 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2433 runs the payment using a realtime gateway.
2435 Options may include:
2437 B<amount>: the amount to be paid; defaults to the customer's balance minus
2438 any payments in transit.
2440 B<payby>: the payment method; defaults to cust_main.payby
2442 B<realtime>: runs this as a realtime payment instead of adding it to a
2445 B<invnum>: sets cust_pay_batch.invnum.
2447 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2448 the billing address for the payment; defaults to the customer's billing
2451 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2452 date, and name; defaults to those fields in cust_main.
2457 my ($self, %options) = @_;
2460 if (exists($options{amount})) {
2461 $amount = $options{amount};
2463 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2465 return '' unless $amount > 0;
2467 my $invnum = delete $options{invnum};
2468 my $payby = $options{payby} || $self->payby; #still dubious
2470 if ($options{'realtime'}) {
2471 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2477 my $oldAutoCommit = $FS::UID::AutoCommit;
2478 local $FS::UID::AutoCommit = 0;
2481 #this needs to handle mysql as well as Pg, like svc_acct.pm
2482 #(make it into a common function if folks need to do batching with mysql)
2483 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2484 or return "Cannot lock pay_batch: " . $dbh->errstr;
2488 'payby' => FS::payby->payby2payment($payby),
2490 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2492 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2494 unless ( $pay_batch ) {
2495 $pay_batch = new FS::pay_batch \%pay_batch;
2496 my $error = $pay_batch->insert;
2498 $dbh->rollback if $oldAutoCommit;
2499 die "error creating new batch: $error\n";
2503 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2504 'batchnum' => $pay_batch->batchnum,
2505 'custnum' => $self->custnum,
2508 foreach (qw( address1 address2 city state zip country latitude longitude
2509 payby payinfo paydate payname ))
2511 $options{$_} = '' unless exists($options{$_});
2514 my $loc = $self->bill_location;
2516 my $cust_pay_batch = new FS::cust_pay_batch ( {
2517 'batchnum' => $pay_batch->batchnum,
2518 'invnum' => $invnum || 0, # is there a better value?
2519 # this field should be
2521 # cust_bill_pay_batch now
2522 'custnum' => $self->custnum,
2523 'last' => $self->getfield('last'),
2524 'first' => $self->getfield('first'),
2525 'address1' => $options{address1} || $loc->address1,
2526 'address2' => $options{address2} || $loc->address2,
2527 'city' => $options{city} || $loc->city,
2528 'state' => $options{state} || $loc->state,
2529 'zip' => $options{zip} || $loc->zip,
2530 'country' => $options{country} || $loc->country,
2531 'payby' => $options{payby} || $self->payby,
2532 'payinfo' => $options{payinfo} || $self->payinfo,
2533 'exp' => $options{paydate} || $self->paydate,
2534 'payname' => $options{payname} || $self->payname,
2535 'amount' => $amount, # consolidating
2538 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2539 if $old_cust_pay_batch;
2542 if ($old_cust_pay_batch) {
2543 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2545 $error = $cust_pay_batch->insert;
2549 $dbh->rollback if $oldAutoCommit;
2553 my $unapplied = $self->total_unapplied_credits
2554 + $self->total_unapplied_payments
2555 + $self->in_transit_payments;
2556 foreach my $cust_bill ($self->open_cust_bill) {
2557 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2558 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2559 'invnum' => $cust_bill->invnum,
2560 'paybatchnum' => $cust_pay_batch->paybatchnum,
2561 'amount' => $cust_bill->owed,
2564 if ($unapplied >= $cust_bill_pay_batch->amount){
2565 $unapplied -= $cust_bill_pay_batch->amount;
2568 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2569 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2571 $error = $cust_bill_pay_batch->insert;
2573 $dbh->rollback if $oldAutoCommit;
2578 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2584 Returns the total owed for this customer on all invoices
2585 (see L<FS::cust_bill/owed>).
2591 $self->total_owed_date(2145859200); #12/31/2037
2594 =item total_owed_date TIME
2596 Returns the total owed for this customer on all invoices with date earlier than
2597 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2598 see L<Time::Local> and L<Date::Parse> for conversion functions.
2602 sub total_owed_date {
2606 my $custnum = $self->custnum;
2608 my $owed_sql = FS::cust_bill->owed_sql;
2611 SELECT SUM($owed_sql) FROM cust_bill
2612 WHERE custnum = $custnum
2616 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2620 =item total_owed_pkgnum PKGNUM
2622 Returns the total owed on all invoices for this customer's specific package
2623 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2627 sub total_owed_pkgnum {
2628 my( $self, $pkgnum ) = @_;
2629 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2632 =item total_owed_date_pkgnum TIME PKGNUM
2634 Returns the total owed for this customer's specific package when using
2635 experimental package balances on all invoices with date earlier than
2636 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2637 see L<Time::Local> and L<Date::Parse> for conversion functions.
2641 sub total_owed_date_pkgnum {
2642 my( $self, $time, $pkgnum ) = @_;
2645 foreach my $cust_bill (
2646 grep { $_->_date <= $time }
2647 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2649 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2651 sprintf( "%.2f", $total_bill );
2657 Returns the total amount of all payments.
2664 $total += $_->paid foreach $self->cust_pay;
2665 sprintf( "%.2f", $total );
2668 =item total_unapplied_credits
2670 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2671 customer. See L<FS::cust_credit/credited>.
2673 =item total_credited
2675 Old name for total_unapplied_credits. Don't use.
2679 sub total_credited {
2680 #carp "total_credited deprecated, use total_unapplied_credits";
2681 shift->total_unapplied_credits(@_);
2684 sub total_unapplied_credits {
2687 my $custnum = $self->custnum;
2689 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2692 SELECT SUM($unapplied_sql) FROM cust_credit
2693 WHERE custnum = $custnum
2696 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2700 =item total_unapplied_credits_pkgnum PKGNUM
2702 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2703 customer. See L<FS::cust_credit/credited>.
2707 sub total_unapplied_credits_pkgnum {
2708 my( $self, $pkgnum ) = @_;
2709 my $total_credit = 0;
2710 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2711 sprintf( "%.2f", $total_credit );
2715 =item total_unapplied_payments
2717 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2718 See L<FS::cust_pay/unapplied>.
2722 sub total_unapplied_payments {
2725 my $custnum = $self->custnum;
2727 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2730 SELECT SUM($unapplied_sql) FROM cust_pay
2731 WHERE custnum = $custnum
2734 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2738 =item total_unapplied_payments_pkgnum PKGNUM
2740 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2741 specific package when using experimental package balances. See
2742 L<FS::cust_pay/unapplied>.
2746 sub total_unapplied_payments_pkgnum {
2747 my( $self, $pkgnum ) = @_;
2748 my $total_unapplied = 0;
2749 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2750 sprintf( "%.2f", $total_unapplied );
2754 =item total_unapplied_refunds
2756 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2757 customer. See L<FS::cust_refund/unapplied>.
2761 sub total_unapplied_refunds {
2763 my $custnum = $self->custnum;
2765 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2768 SELECT SUM($unapplied_sql) FROM cust_refund
2769 WHERE custnum = $custnum
2772 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2778 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2779 total_unapplied_credits minus total_unapplied_payments).
2785 $self->balance_date_range;
2788 =item balance_date TIME
2790 Returns the balance for this customer, only considering invoices with date
2791 earlier than TIME (total_owed_date minus total_credited minus
2792 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2793 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2800 $self->balance_date_range(shift);
2803 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2805 Returns the balance for this customer, optionally considering invoices with
2806 date earlier than START_TIME, and not later than END_TIME
2807 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2809 Times are specified as SQL fragments or numeric
2810 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2811 L<Date::Parse> for conversion functions. The empty string can be passed
2812 to disable that time constraint completely.
2814 Available options are:
2818 =item unapplied_date
2820 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)
2826 sub balance_date_range {
2828 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2829 ') FROM cust_main WHERE custnum='. $self->custnum;
2830 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2833 =item balance_pkgnum PKGNUM
2835 Returns the balance for this customer's specific package when using
2836 experimental package balances (total_owed plus total_unrefunded, minus
2837 total_unapplied_credits minus total_unapplied_payments)
2841 sub balance_pkgnum {
2842 my( $self, $pkgnum ) = @_;
2845 $self->total_owed_pkgnum($pkgnum)
2846 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2847 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2848 - $self->total_unapplied_credits_pkgnum($pkgnum)
2849 - $self->total_unapplied_payments_pkgnum($pkgnum)
2853 =item in_transit_payments
2855 Returns the total of requests for payments for this customer pending in
2856 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2860 sub in_transit_payments {
2862 my $in_transit_payments = 0;
2863 foreach my $pay_batch ( qsearch('pay_batch', {
2866 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2867 'batchnum' => $pay_batch->batchnum,
2868 'custnum' => $self->custnum,
2870 $in_transit_payments += $cust_pay_batch->amount;
2873 sprintf( "%.2f", $in_transit_payments );
2878 Returns a hash of useful information for making a payment.
2888 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2889 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2890 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2894 For credit card transactions:
2906 For electronic check transactions:
2921 $return{balance} = $self->balance;
2923 $return{payname} = $self->payname
2924 || ( $self->first. ' '. $self->get('last') );
2926 $return{$_} = $self->bill_location->$_
2927 for qw(address1 address2 city state zip);
2929 $return{payby} = $self->payby;
2930 $return{stateid_state} = $self->stateid_state;
2932 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2933 $return{card_type} = cardtype($self->payinfo);
2934 $return{payinfo} = $self->paymask;
2936 @return{'month', 'year'} = $self->paydate_monthyear;
2940 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2941 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2942 $return{payinfo1} = $payinfo1;
2943 $return{payinfo2} = $payinfo2;
2944 $return{paytype} = $self->paytype;
2945 $return{paystate} = $self->paystate;
2949 #doubleclick protection
2951 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2957 =item paydate_monthyear
2959 Returns a two-element list consisting of the month and year of this customer's
2960 paydate (credit card expiration date for CARD customers)
2964 sub paydate_monthyear {
2966 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2968 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2977 Returns the exact time in seconds corresponding to the payment method
2978 expiration date. For CARD/DCRD customers this is the end of the month;
2979 for others (COMP is the only other payby that uses paydate) it's the start.
2980 Returns 0 if the paydate is empty or set to the far future.
2986 my ($month, $year) = $self->paydate_monthyear;
2987 return 0 if !$year or $year >= 2037;
2988 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2990 if ( $month == 13 ) {
2994 return timelocal(0,0,0,1,$month-1,$year) - 1;
2997 return timelocal(0,0,0,1,$month-1,$year);
3001 =item paydate_epoch_sql
3003 Class method. Returns an SQL expression to obtain the payment expiration date
3004 as a number of seconds.
3008 # Special expiration date behavior for non-CARD/DCRD customers has been
3009 # carefully preserved. Do we really use that?
3010 sub paydate_epoch_sql {
3012 my $table = shift || 'cust_main';
3013 my ($case1, $case2);
3014 if ( driver_name eq 'Pg' ) {
3015 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3016 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3018 elsif ( lc(driver_name) eq 'mysql' ) {
3019 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3020 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3023 return "CASE WHEN $table.payby IN('CARD','DCRD')
3029 =item tax_exemption TAXNAME
3034 my( $self, $taxname ) = @_;
3036 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3037 'taxname' => $taxname,
3042 =item cust_main_exemption
3046 sub cust_main_exemption {
3048 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3051 =item invoicing_list [ ARRAYREF ]
3053 If an arguement is given, sets these email addresses as invoice recipients
3054 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3055 (except as warnings), so use check_invoicing_list first.
3057 Returns a list of email addresses (with svcnum entries expanded).
3059 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3060 check it without disturbing anything by passing nothing.
3062 This interface may change in the future.
3066 sub invoicing_list {
3067 my( $self, $arrayref ) = @_;
3070 my @cust_main_invoice;
3071 if ( $self->custnum ) {
3072 @cust_main_invoice =
3073 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3075 @cust_main_invoice = ();
3077 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3078 #warn $cust_main_invoice->destnum;
3079 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3080 #warn $cust_main_invoice->destnum;
3081 my $error = $cust_main_invoice->delete;
3082 warn $error if $error;
3085 if ( $self->custnum ) {
3086 @cust_main_invoice =
3087 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3089 @cust_main_invoice = ();
3091 my %seen = map { $_->address => 1 } @cust_main_invoice;
3092 foreach my $address ( @{$arrayref} ) {
3093 next if exists $seen{$address} && $seen{$address};
3094 $seen{$address} = 1;
3095 my $cust_main_invoice = new FS::cust_main_invoice ( {
3096 'custnum' => $self->custnum,
3099 my $error = $cust_main_invoice->insert;
3100 warn $error if $error;
3104 if ( $self->custnum ) {
3106 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3113 =item check_invoicing_list ARRAYREF
3115 Checks these arguements as valid input for the invoicing_list method. If there
3116 is an error, returns the error, otherwise returns false.
3120 sub check_invoicing_list {
3121 my( $self, $arrayref ) = @_;
3123 foreach my $address ( @$arrayref ) {
3125 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3126 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3129 my $cust_main_invoice = new FS::cust_main_invoice ( {
3130 'custnum' => $self->custnum,
3133 my $error = $self->custnum
3134 ? $cust_main_invoice->check
3135 : $cust_main_invoice->checkdest
3137 return $error if $error;
3141 return "Email address required"
3142 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3143 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3148 =item set_default_invoicing_list
3150 Sets the invoicing list to all accounts associated with this customer,
3151 overwriting any previous invoicing list.
3155 sub set_default_invoicing_list {
3157 $self->invoicing_list($self->all_emails);
3162 Returns the email addresses of all accounts provisioned for this customer.
3169 foreach my $cust_pkg ( $self->all_pkgs ) {
3170 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3172 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3173 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3175 $list{$_}=1 foreach map { $_->email } @svc_acct;
3180 =item invoicing_list_addpost
3182 Adds postal invoicing to this customer. If this customer is already configured
3183 to receive postal invoices, does nothing.
3187 sub invoicing_list_addpost {
3189 return if grep { $_ eq 'POST' } $self->invoicing_list;
3190 my @invoicing_list = $self->invoicing_list;
3191 push @invoicing_list, 'POST';
3192 $self->invoicing_list(\@invoicing_list);
3195 =item invoicing_list_emailonly
3197 Returns the list of email invoice recipients (invoicing_list without non-email
3198 destinations such as POST and FAX).
3202 sub invoicing_list_emailonly {
3204 warn "$me invoicing_list_emailonly called"
3206 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3209 =item invoicing_list_emailonly_scalar
3211 Returns the list of email invoice recipients (invoicing_list without non-email
3212 destinations such as POST and FAX) as a comma-separated scalar.
3216 sub invoicing_list_emailonly_scalar {
3218 warn "$me invoicing_list_emailonly_scalar called"
3220 join(', ', $self->invoicing_list_emailonly);
3223 =item referral_custnum_cust_main
3225 Returns the customer who referred this customer (or the empty string, if
3226 this customer was not referred).
3228 Note the difference with referral_cust_main method: This method,
3229 referral_custnum_cust_main returns the single customer (if any) who referred
3230 this customer, while referral_cust_main returns an array of customers referred
3235 sub referral_custnum_cust_main {
3237 return '' unless $self->referral_custnum;
3238 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3241 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3243 Returns an array of customers referred by this customer (referral_custnum set
3244 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3245 customers referred by customers referred by this customer and so on, inclusive.
3246 The default behavior is DEPTH 1 (no recursion).
3248 Note the difference with referral_custnum_cust_main method: This method,
3249 referral_cust_main, returns an array of customers referred BY this customer,
3250 while referral_custnum_cust_main returns the single customer (if any) who
3251 referred this customer.
3255 sub referral_cust_main {
3257 my $depth = @_ ? shift : 1;
3258 my $exclude = @_ ? shift : {};
3261 map { $exclude->{$_->custnum}++; $_; }
3262 grep { ! $exclude->{ $_->custnum } }
3263 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3267 map { $_->referral_cust_main($depth-1, $exclude) }
3274 =item referral_cust_main_ncancelled
3276 Same as referral_cust_main, except only returns customers with uncancelled
3281 sub referral_cust_main_ncancelled {
3283 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3286 =item referral_cust_pkg [ DEPTH ]
3288 Like referral_cust_main, except returns a flat list of all unsuspended (and
3289 uncancelled) packages for each customer. The number of items in this list may
3290 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3294 sub referral_cust_pkg {
3296 my $depth = @_ ? shift : 1;
3298 map { $_->unsuspended_pkgs }
3299 grep { $_->unsuspended_pkgs }
3300 $self->referral_cust_main($depth);
3303 =item referring_cust_main
3305 Returns the single cust_main record for the customer who referred this customer
3306 (referral_custnum), or false.
3310 sub referring_cust_main {
3312 return '' unless $self->referral_custnum;
3313 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3316 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3318 Applies a credit to this customer. If there is an error, returns the error,
3319 otherwise returns false.
3321 REASON can be a text string, an FS::reason object, or a scalar reference to
3322 a reasonnum. If a text string, it will be automatically inserted as a new
3323 reason, and a 'reason_type' option must be passed to indicate the
3324 FS::reason_type for the new reason.
3326 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3328 Any other options are passed to FS::cust_credit::insert.
3333 my( $self, $amount, $reason, %options ) = @_;
3335 my $cust_credit = new FS::cust_credit {
3336 'custnum' => $self->custnum,
3337 'amount' => $amount,
3340 if ( ref($reason) ) {
3342 if ( ref($reason) eq 'SCALAR' ) {
3343 $cust_credit->reasonnum( $$reason );
3345 $cust_credit->reasonnum( $reason->reasonnum );
3349 $cust_credit->set('reason', $reason)
3352 for (qw( addlinfo eventnum )) {
3353 $cust_credit->$_( delete $options{$_} )
3354 if exists($options{$_});
3357 $cust_credit->insert(%options);
3361 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3363 Creates a one-time charge for this customer. If there is an error, returns
3364 the error, otherwise returns false.
3366 New-style, with a hashref of options:
3368 my $error = $cust_main->charge(
3372 'start_date' => str2time('7/4/2009'),
3373 'pkg' => 'Description',
3374 'comment' => 'Comment',
3375 'additional' => [], #extra invoice detail
3376 'classnum' => 1, #pkg_class
3378 'setuptax' => '', # or 'Y' for tax exempt
3380 'locationnum'=> 1234, # optional
3383 'taxclass' => 'Tax class',
3386 'taxproduct' => 2, #part_pkg_taxproduct
3387 'override' => {}, #XXX describe
3389 #will be filled in with the new object
3390 'cust_pkg_ref' => \$cust_pkg,
3392 #generate an invoice immediately
3394 'invoice_terms' => '', #with these terms
3400 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3406 my ( $amount, $quantity, $start_date, $classnum );
3407 my ( $pkg, $comment, $additional );
3408 my ( $setuptax, $taxclass ); #internal taxes
3409 my ( $taxproduct, $override ); #vendor (CCH) taxes
3411 my $cust_pkg_ref = '';
3412 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3414 if ( ref( $_[0] ) ) {
3415 $amount = $_[0]->{amount};
3416 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3417 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3418 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3419 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3420 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3421 : '$'. sprintf("%.2f",$amount);
3422 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3423 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3424 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3425 $additional = $_[0]->{additional} || [];
3426 $taxproduct = $_[0]->{taxproductnum};
3427 $override = { '' => $_[0]->{tax_override} };
3428 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3429 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3430 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3431 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3436 $pkg = @_ ? shift : 'One-time charge';
3437 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3439 $taxclass = @_ ? shift : '';
3443 local $SIG{HUP} = 'IGNORE';
3444 local $SIG{INT} = 'IGNORE';
3445 local $SIG{QUIT} = 'IGNORE';
3446 local $SIG{TERM} = 'IGNORE';
3447 local $SIG{TSTP} = 'IGNORE';
3448 local $SIG{PIPE} = 'IGNORE';
3450 my $oldAutoCommit = $FS::UID::AutoCommit;
3451 local $FS::UID::AutoCommit = 0;
3454 my $part_pkg = new FS::part_pkg ( {
3456 'comment' => $comment,
3460 'classnum' => ( $classnum ? $classnum : '' ),
3461 'setuptax' => $setuptax,
3462 'taxclass' => $taxclass,
3463 'taxproductnum' => $taxproduct,
3466 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3467 ( 0 .. @$additional - 1 )
3469 'additional_count' => scalar(@$additional),
3470 'setup_fee' => $amount,
3473 my $error = $part_pkg->insert( options => \%options,
3474 tax_overrides => $override,
3477 $dbh->rollback if $oldAutoCommit;
3481 my $pkgpart = $part_pkg->pkgpart;
3482 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3483 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3484 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3485 $error = $type_pkgs->insert;
3487 $dbh->rollback if $oldAutoCommit;
3492 my $cust_pkg = new FS::cust_pkg ( {
3493 'custnum' => $self->custnum,
3494 'pkgpart' => $pkgpart,
3495 'quantity' => $quantity,
3496 'start_date' => $start_date,
3497 'no_auto' => $no_auto,
3498 'locationnum'=> $locationnum,
3501 $error = $cust_pkg->insert;
3503 $dbh->rollback if $oldAutoCommit;
3505 } elsif ( $cust_pkg_ref ) {
3506 ${$cust_pkg_ref} = $cust_pkg;
3510 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3511 'pkg_list' => [ $cust_pkg ],
3514 $dbh->rollback if $oldAutoCommit;
3519 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3524 #=item charge_postal_fee
3526 #Applies a one time charge this customer. If there is an error,
3527 #returns the error, returns the cust_pkg charge object or false
3528 #if there was no charge.
3532 # This should be a customer event. For that to work requires that bill
3533 # also be a customer event.
3535 sub charge_postal_fee {
3538 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3539 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3541 my $cust_pkg = new FS::cust_pkg ( {
3542 'custnum' => $self->custnum,
3543 'pkgpart' => $pkgpart,
3547 my $error = $cust_pkg->insert;
3548 $error ? $error : $cust_pkg;
3551 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3553 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3555 Optionally, a list or hashref of additional arguments to the qsearch call can
3562 my $opt = ref($_[0]) ? shift : { @_ };
3564 #return $self->num_cust_bill unless wantarray || keys %$opt;
3566 $opt->{'table'} = 'cust_bill';
3567 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3568 $opt->{'hashref'}{'custnum'} = $self->custnum;
3569 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3571 map { $_ } #behavior of sort undefined in scalar context
3572 sort { $a->_date <=> $b->_date }
3576 =item open_cust_bill
3578 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3583 sub open_cust_bill {
3587 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3593 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3595 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3599 sub legacy_cust_bill {
3602 #return $self->num_legacy_cust_bill unless wantarray;
3604 map { $_ } #behavior of sort undefined in scalar context
3605 sort { $a->_date <=> $b->_date }
3606 qsearch({ 'table' => 'legacy_cust_bill',
3607 'hashref' => { 'custnum' => $self->custnum, },
3608 'order_by' => 'ORDER BY _date ASC',
3612 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3614 Returns all the statements (see L<FS::cust_statement>) for this customer.
3616 Optionally, a list or hashref of additional arguments to the qsearch call can
3621 =item cust_bill_void
3623 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3627 sub cust_bill_void {
3630 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3631 sort { $a->_date <=> $b->_date }
3632 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3635 sub cust_statement {
3637 my $opt = ref($_[0]) ? shift : { @_ };
3639 #return $self->num_cust_statement unless wantarray || keys %$opt;
3641 $opt->{'table'} = 'cust_statement';
3642 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3643 $opt->{'hashref'}{'custnum'} = $self->custnum;
3644 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3646 map { $_ } #behavior of sort undefined in scalar context
3647 sort { $a->_date <=> $b->_date }
3651 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3653 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3655 Optionally, a list or hashref of additional arguments to the qsearch call can
3656 be passed following the SVCDB.
3663 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3664 warn "$me svc_x requires a svcdb";
3667 my $opt = ref($_[0]) ? shift : { @_ };
3669 $opt->{'table'} = $svcdb;
3670 $opt->{'addl_from'} =
3671 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3672 ($opt->{'addl_from'} || '');
3674 my $custnum = $self->custnum;
3675 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3676 my $where = "cust_pkg.custnum = $custnum";
3678 my $extra_sql = $opt->{'extra_sql'} || '';
3679 if ( keys %{ $opt->{'hashref'} } ) {
3680 $extra_sql = " AND $where $extra_sql";
3683 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3684 $extra_sql = "WHERE $where AND $1";
3687 $extra_sql = "WHERE $where $extra_sql";
3690 $opt->{'extra_sql'} = $extra_sql;
3695 # required for use as an eventtable;
3698 $self->svc_x('svc_acct', @_);
3703 Returns all the credits (see L<FS::cust_credit>) for this customer.
3709 map { $_ } #return $self->num_cust_credit unless wantarray;
3710 sort { $a->_date <=> $b->_date }
3711 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3714 =item cust_credit_pkgnum
3716 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3717 package when using experimental package balances.
3721 sub cust_credit_pkgnum {
3722 my( $self, $pkgnum ) = @_;
3723 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3724 sort { $a->_date <=> $b->_date }
3725 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3726 'pkgnum' => $pkgnum,
3733 Returns all the payments (see L<FS::cust_pay>) for this customer.
3739 return $self->num_cust_pay unless wantarray;
3740 sort { $a->_date <=> $b->_date }
3741 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3746 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3747 called automatically when the cust_pay method is used in a scalar context.
3753 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3754 my $sth = dbh->prepare($sql) or die dbh->errstr;
3755 $sth->execute($self->custnum) or die $sth->errstr;
3756 $sth->fetchrow_arrayref->[0];
3759 =item cust_pay_pkgnum
3761 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3762 package when using experimental package balances.
3766 sub cust_pay_pkgnum {
3767 my( $self, $pkgnum ) = @_;
3768 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3769 sort { $a->_date <=> $b->_date }
3770 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3771 'pkgnum' => $pkgnum,
3778 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3784 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3785 sort { $a->_date <=> $b->_date }
3786 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3789 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3791 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3793 Optionally, a list or hashref of additional arguments to the qsearch call can
3798 sub cust_pay_batch {
3800 my $opt = ref($_[0]) ? shift : { @_ };
3802 #return $self->num_cust_statement unless wantarray || keys %$opt;
3804 $opt->{'table'} = 'cust_pay_batch';
3805 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3806 $opt->{'hashref'}{'custnum'} = $self->custnum;
3807 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3809 map { $_ } #behavior of sort undefined in scalar context
3810 sort { $a->paybatchnum <=> $b->paybatchnum }
3814 =item cust_pay_pending
3816 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3817 (without status "done").
3821 sub cust_pay_pending {
3823 return $self->num_cust_pay_pending unless wantarray;
3824 sort { $a->_date <=> $b->_date }
3825 qsearch( 'cust_pay_pending', {
3826 'custnum' => $self->custnum,
3827 'status' => { op=>'!=', value=>'done' },
3832 =item cust_pay_pending_attempt
3834 Returns all payment attempts / declined payments for this customer, as pending
3835 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3836 a corresponding payment (see L<FS::cust_pay>).
3840 sub cust_pay_pending_attempt {
3842 return $self->num_cust_pay_pending_attempt unless wantarray;
3843 sort { $a->_date <=> $b->_date }
3844 qsearch( 'cust_pay_pending', {
3845 'custnum' => $self->custnum,
3852 =item num_cust_pay_pending
3854 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3855 customer (without status "done"). Also called automatically when the
3856 cust_pay_pending method is used in a scalar context.
3860 sub num_cust_pay_pending {
3863 " SELECT COUNT(*) FROM cust_pay_pending ".
3864 " WHERE custnum = ? AND status != 'done' ",
3869 =item num_cust_pay_pending_attempt
3871 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3872 customer, with status "done" but without a corresp. Also called automatically when the
3873 cust_pay_pending method is used in a scalar context.
3877 sub num_cust_pay_pending_attempt {
3880 " SELECT COUNT(*) FROM cust_pay_pending ".
3881 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3888 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3894 map { $_ } #return $self->num_cust_refund unless wantarray;
3895 sort { $a->_date <=> $b->_date }
3896 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3899 =item display_custnum
3901 Returns the displayed customer number for this customer: agent_custid if
3902 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3906 sub display_custnum {
3909 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3910 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3911 if ( $special eq 'CoStAg' ) {
3912 $prefix = uc( join('',
3914 ($self->state =~ /^(..)/),
3915 $prefix || ($self->agent->agent =~ /^(..)/)
3918 elsif ( $special eq 'CoStCl' ) {
3919 $prefix = uc( join('',
3921 ($self->state =~ /^(..)/),
3922 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3925 # add any others here if needed
3928 my $length = $conf->config('cust_main-custnum-display_length');
3929 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3930 return $self->agent_custid;
3931 } elsif ( $prefix ) {
3932 $length = 8 if !defined($length);
3934 sprintf('%0'.$length.'d', $self->custnum)
3935 } elsif ( $length ) {
3936 return sprintf('%0'.$length.'d', $self->custnum);
3938 return $self->custnum;
3944 Returns a name string for this customer, either "Company (Last, First)" or
3951 my $name = $self->contact;
3952 $name = $self->company. " ($name)" if $self->company;
3956 =item service_contact
3958 Returns the L<FS::contact> object for this customer that has the 'Service'
3959 contact class, or undef if there is no such contact. Deprecated; don't use
3964 sub service_contact {
3966 if ( !exists($self->{service_contact}) ) {
3967 my $classnum = $self->scalar_sql(
3968 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3969 ) || 0; #if it's zero, qsearchs will return nothing
3970 $self->{service_contact} = qsearchs('contact', {
3971 'classnum' => $classnum, 'custnum' => $self->custnum
3974 $self->{service_contact};
3979 Returns a name string for this (service/shipping) contact, either
3980 "Company (Last, First)" or "Last, First".
3987 my $name = $self->ship_contact;
3988 $name = $self->company. " ($name)" if $self->company;
3994 Returns a name string for this customer, either "Company" or "First Last".
4000 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4003 =item ship_name_short
4005 Returns a name string for this (service/shipping) contact, either "Company"
4010 sub ship_name_short {
4012 $self->service_contact
4013 ? $self->ship_contact_firstlast
4019 Returns this customer's full (billing) contact name only, "Last, First"
4025 $self->get('last'). ', '. $self->first;
4030 Returns this customer's full (shipping) contact name only, "Last, First"
4036 my $contact = $self->service_contact || $self;
4037 $contact->get('last') . ', ' . $contact->get('first');
4040 =item contact_firstlast
4042 Returns this customers full (billing) contact name only, "First Last".
4046 sub contact_firstlast {
4048 $self->first. ' '. $self->get('last');
4051 =item ship_contact_firstlast
4053 Returns this customer's full (shipping) contact name only, "First Last".
4057 sub ship_contact_firstlast {
4059 my $contact = $self->service_contact || $self;
4060 $contact->get('first') . ' '. $contact->get('last');
4063 #XXX this doesn't work in 3.x+
4066 #Returns this customer's full country name
4072 # code2country($self->country);
4075 =item county_state_county [ PREFIX ]
4077 Returns a string consisting of just the county, state and country.
4081 sub county_state_country {
4084 if ( @_ && $_[0] && $self->has_ship_address ) {
4085 $locationnum = $self->ship_locationnum;
4087 $locationnum = $self->bill_locationnum;
4089 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4090 $cust_location->county_state_country;
4093 =item geocode DATA_VENDOR
4095 Returns a value for the customer location as encoded by DATA_VENDOR.
4096 Currently this only makes sense for "CCH" as DATA_VENDOR.
4104 Returns a status string for this customer, currently:
4108 =item prospect - No packages have ever been ordered
4110 =item ordered - Recurring packages all are new (not yet billed).
4112 =item active - One or more recurring packages is active
4114 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4116 =item suspended - All non-cancelled recurring packages are suspended
4118 =item cancelled - All recurring packages are cancelled
4122 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4123 cust_main-status_module configuration option.
4127 sub status { shift->cust_status(@_); }
4131 for my $status ( FS::cust_main->statuses() ) {
4132 my $method = $status.'_sql';
4133 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4134 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4135 $sth->execute( ($self->custnum) x $numnum )
4136 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4137 return $status if $sth->fetchrow_arrayref->[0];
4141 =item ucfirst_cust_status
4143 =item ucfirst_status
4145 Returns the status with the first character capitalized.
4149 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4151 sub ucfirst_cust_status {
4153 ucfirst($self->cust_status);
4158 Returns a hex triplet color string for this customer's status.
4162 sub statuscolor { shift->cust_statuscolor(@_); }
4164 sub cust_statuscolor {
4166 __PACKAGE__->statuscolors->{$self->cust_status};
4171 Returns an array of hashes representing the customer's RT tickets.
4178 my $num = $conf->config('cust_main-max_tickets') || 10;
4181 if ( $conf->config('ticket_system') ) {
4182 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4184 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4188 foreach my $priority (
4189 $conf->config('ticket_system-custom_priority_field-values'), ''
4191 last if scalar(@tickets) >= $num;
4193 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4194 $num - scalar(@tickets),
4204 # Return services representing svc_accts in customer support packages
4205 sub support_services {
4207 my %packages = map { $_ => 1 } $conf->config('support_packages');
4209 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4210 grep { $_->part_svc->svcdb eq 'svc_acct' }
4211 map { $_->cust_svc }
4212 grep { exists $packages{ $_->pkgpart } }
4213 $self->ncancelled_pkgs;
4217 # Return a list of latitude/longitude for one of the services (if any)
4218 sub service_coordinates {
4222 grep { $_->latitude && $_->longitude }
4224 map { $_->cust_svc }
4225 $self->ncancelled_pkgs;
4227 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4232 Returns a masked version of the named field
4237 my ($self,$field) = @_;
4241 'x'x(length($self->getfield($field))-4).
4242 substr($self->getfield($field), (length($self->getfield($field))-4));
4248 =head1 CLASS METHODS
4254 Class method that returns the list of possible status strings for customers
4255 (see L<the status method|/status>). For example:
4257 @statuses = FS::cust_main->statuses();
4263 keys %{ $self->statuscolors };
4266 =item cust_status_sql
4268 Returns an SQL fragment to determine the status of a cust_main record, as a
4273 sub cust_status_sql {
4275 for my $status ( FS::cust_main->statuses() ) {
4276 my $method = $status.'_sql';
4277 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4286 Returns an SQL expression identifying prospective cust_main records (customers
4287 with no packages ever ordered)
4291 use vars qw($select_count_pkgs);
4292 $select_count_pkgs =
4293 "SELECT COUNT(*) FROM cust_pkg
4294 WHERE cust_pkg.custnum = cust_main.custnum";
4296 sub select_count_pkgs_sql {
4301 " 0 = ( $select_count_pkgs ) ";
4306 Returns an SQL expression identifying ordered cust_main records (customers with
4307 no active packages, but recurring packages not yet setup or one time charges
4313 FS::cust_main->none_active_sql.
4314 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4319 Returns an SQL expression identifying active cust_main records (customers with
4320 active recurring packages).
4325 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4328 =item none_active_sql
4330 Returns an SQL expression identifying cust_main records with no active
4331 recurring packages. This includes customers of status prospect, ordered,
4332 inactive, and suspended.
4336 sub none_active_sql {
4337 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4342 Returns an SQL expression identifying inactive cust_main records (customers with
4343 no active recurring packages, but otherwise unsuspended/uncancelled).
4348 FS::cust_main->none_active_sql.
4349 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4355 Returns an SQL expression identifying suspended cust_main records.
4360 sub suspended_sql { susp_sql(@_); }
4362 FS::cust_main->none_active_sql.
4363 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4369 Returns an SQL expression identifying cancelled cust_main records.
4373 sub cancel_sql { shift->cancelled_sql(@_); }
4376 =item uncancelled_sql
4378 Returns an SQL expression identifying un-cancelled cust_main records.
4382 sub uncancelled_sql { uncancel_sql(@_); }
4383 sub uncancel_sql { "
4384 ( 0 < ( $select_count_pkgs
4385 AND ( cust_pkg.cancel IS NULL
4386 OR cust_pkg.cancel = 0
4389 OR 0 = ( $select_count_pkgs )
4395 Returns an SQL fragment to retreive the balance.
4400 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4401 WHERE cust_bill.custnum = cust_main.custnum )
4402 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4403 WHERE cust_pay.custnum = cust_main.custnum )
4404 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4405 WHERE cust_credit.custnum = cust_main.custnum )
4406 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4407 WHERE cust_refund.custnum = cust_main.custnum )
4410 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4412 Returns an SQL fragment to retreive the balance for this customer, optionally
4413 considering invoices with date earlier than START_TIME, and not
4414 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4415 total_unapplied_payments).
4417 Times are specified as SQL fragments or numeric
4418 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4419 L<Date::Parse> for conversion functions. The empty string can be passed
4420 to disable that time constraint completely.
4422 Available options are:
4426 =item unapplied_date
4428 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)
4433 set to true to remove all customer comparison clauses, for totals
4438 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4443 JOIN clause (typically used with the total option)
4447 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4448 time will be ignored. Note that START_TIME and END_TIME only limit the date
4449 range for invoices and I<unapplied> payments, credits, and refunds.
4455 sub balance_date_sql {
4456 my( $class, $start, $end, %opt ) = @_;
4458 my $cutoff = $opt{'cutoff'};
4460 my $owed = FS::cust_bill->owed_sql($cutoff);
4461 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4462 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4463 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4465 my $j = $opt{'join'} || '';
4467 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4468 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4469 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4470 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4472 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4473 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4474 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4475 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4480 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4482 Returns an SQL fragment to retreive the total unapplied payments for this
4483 customer, only considering payments with date earlier than START_TIME, and
4484 optionally not later than END_TIME.
4486 Times are specified as SQL fragments or numeric
4487 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4488 L<Date::Parse> for conversion functions. The empty string can be passed
4489 to disable that time constraint completely.
4491 Available options are:
4495 sub unapplied_payments_date_sql {
4496 my( $class, $start, $end, %opt ) = @_;
4498 my $cutoff = $opt{'cutoff'};
4500 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4502 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4503 'unapplied_date'=>1 );
4505 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4508 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4510 Helper method for balance_date_sql; name (and usage) subject to change
4511 (suggestions welcome).
4513 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4514 cust_refund, cust_credit or cust_pay).
4516 If TABLE is "cust_bill" or the unapplied_date option is true, only
4517 considers records with date earlier than START_TIME, and optionally not
4518 later than END_TIME .
4522 sub _money_table_where {
4523 my( $class, $table, $start, $end, %opt ) = @_;
4526 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4527 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4528 push @where, "$table._date <= $start" if defined($start) && length($start);
4529 push @where, "$table._date > $end" if defined($end) && length($end);
4531 push @where, @{$opt{'where'}} if $opt{'where'};
4532 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4538 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4539 use FS::cust_main::Search;
4542 FS::cust_main::Search->search(@_);
4557 #warn join('-',keys %$param);
4558 my $fh = $param->{filehandle};
4559 my $agentnum = $param->{agentnum};
4560 my $format = $param->{format};
4562 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4565 if ( $format eq 'simple' ) {
4566 @fields = qw( custnum agent_custid amount pkg );
4568 die "unknown format $format";
4571 eval "use Text::CSV_XS;";
4574 my $csv = new Text::CSV_XS;
4581 local $SIG{HUP} = 'IGNORE';
4582 local $SIG{INT} = 'IGNORE';
4583 local $SIG{QUIT} = 'IGNORE';
4584 local $SIG{TERM} = 'IGNORE';
4585 local $SIG{TSTP} = 'IGNORE';
4586 local $SIG{PIPE} = 'IGNORE';
4588 my $oldAutoCommit = $FS::UID::AutoCommit;
4589 local $FS::UID::AutoCommit = 0;
4592 #while ( $columns = $csv->getline($fh) ) {
4594 while ( defined($line=<$fh>) ) {
4596 $csv->parse($line) or do {
4597 $dbh->rollback if $oldAutoCommit;
4598 return "can't parse: ". $csv->error_input();
4601 my @columns = $csv->fields();
4602 #warn join('-',@columns);
4605 foreach my $field ( @fields ) {
4606 $row{$field} = shift @columns;
4609 if ( $row{custnum} && $row{agent_custid} ) {
4610 dbh->rollback if $oldAutoCommit;
4611 return "can't specify custnum with agent_custid $row{agent_custid}";
4615 if ( $row{agent_custid} && $agentnum ) {
4616 %hash = ( 'agent_custid' => $row{agent_custid},
4617 'agentnum' => $agentnum,
4621 if ( $row{custnum} ) {
4622 %hash = ( 'custnum' => $row{custnum} );
4625 unless ( scalar(keys %hash) ) {
4626 $dbh->rollback if $oldAutoCommit;
4627 return "can't find customer without custnum or agent_custid and agentnum";
4630 my $cust_main = qsearchs('cust_main', { %hash } );
4631 unless ( $cust_main ) {
4632 $dbh->rollback if $oldAutoCommit;
4633 my $custnum = $row{custnum} || $row{agent_custid};
4634 return "unknown custnum $custnum";
4637 if ( $row{'amount'} > 0 ) {
4638 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4640 $dbh->rollback if $oldAutoCommit;
4644 } elsif ( $row{'amount'} < 0 ) {
4645 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4648 $dbh->rollback if $oldAutoCommit;
4658 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4660 return "Empty file!" unless $imported;
4666 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4668 Deprecated. Use event notification and message templates
4669 (L<FS::msg_template>) instead.
4671 Sends a templated email notification to the customer (see L<Text::Template>).
4673 OPTIONS is a hash and may include
4675 I<from> - the email sender (default is invoice_from)
4677 I<to> - comma-separated scalar or arrayref of recipients
4678 (default is invoicing_list)
4680 I<subject> - The subject line of the sent email notification
4681 (default is "Notice from company_name")
4683 I<extra_fields> - a hashref of name/value pairs which will be substituted
4686 The following variables are vavailable in the template.
4688 I<$first> - the customer first name
4689 I<$last> - the customer last name
4690 I<$company> - the customer company
4691 I<$payby> - a description of the method of payment for the customer
4692 # would be nice to use FS::payby::shortname
4693 I<$payinfo> - the account information used to collect for this customer
4694 I<$expdate> - the expiration of the customer payment in seconds from epoch
4699 my ($self, $template, %options) = @_;
4701 return unless $conf->exists($template);
4703 my $from = $conf->config('invoice_from', $self->agentnum)
4704 if $conf->exists('invoice_from', $self->agentnum);
4705 $from = $options{from} if exists($options{from});
4707 my $to = join(',', $self->invoicing_list_emailonly);
4708 $to = $options{to} if exists($options{to});
4710 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4711 if $conf->exists('company_name', $self->agentnum);
4712 $subject = $options{subject} if exists($options{subject});
4714 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4715 SOURCE => [ map "$_\n",
4716 $conf->config($template)]
4718 or die "can't create new Text::Template object: Text::Template::ERROR";
4719 $notify_template->compile()
4720 or die "can't compile template: Text::Template::ERROR";
4722 $FS::notify_template::_template::company_name =
4723 $conf->config('company_name', $self->agentnum);
4724 $FS::notify_template::_template::company_address =
4725 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4727 my $paydate = $self->paydate || '2037-12-31';
4728 $FS::notify_template::_template::first = $self->first;
4729 $FS::notify_template::_template::last = $self->last;
4730 $FS::notify_template::_template::company = $self->company;
4731 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4732 my $payby = $self->payby;
4733 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4734 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4736 #credit cards expire at the end of the month/year of their exp date
4737 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4738 $FS::notify_template::_template::payby = 'credit card';
4739 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4740 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4742 }elsif ($payby eq 'COMP') {
4743 $FS::notify_template::_template::payby = 'complimentary account';
4745 $FS::notify_template::_template::payby = 'current method';
4747 $FS::notify_template::_template::expdate = $expire_time;
4749 for (keys %{$options{extra_fields}}){
4751 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4754 send_email(from => $from,
4756 subject => $subject,
4757 body => $notify_template->fill_in( PACKAGE =>
4758 'FS::notify_template::_template' ),
4763 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4765 Generates a templated notification to the customer (see L<Text::Template>).
4767 OPTIONS is a hash and may include
4769 I<extra_fields> - a hashref of name/value pairs which will be substituted
4770 into the template. These values may override values mentioned below
4771 and those from the customer record.
4773 The following variables are available in the template instead of or in addition
4774 to the fields of the customer record.
4776 I<$payby> - a description of the method of payment for the customer
4777 # would be nice to use FS::payby::shortname
4778 I<$payinfo> - the masked account information used to collect for this customer
4779 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4780 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4784 # a lot like cust_bill::print_latex
4785 sub generate_letter {
4786 my ($self, $template, %options) = @_;
4788 return unless $conf->exists($template);
4790 my $letter_template = new Text::Template
4792 SOURCE => [ map "$_\n", $conf->config($template)],
4793 DELIMITERS => [ '[@--', '--@]' ],
4795 or die "can't create new Text::Template object: Text::Template::ERROR";
4797 $letter_template->compile()
4798 or die "can't compile template: Text::Template::ERROR";
4800 my %letter_data = map { $_ => $self->$_ } $self->fields;
4801 $letter_data{payinfo} = $self->mask_payinfo;
4803 #my $paydate = $self->paydate || '2037-12-31';
4804 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4806 my $payby = $self->payby;
4807 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4808 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4810 #credit cards expire at the end of the month/year of their exp date
4811 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4812 $letter_data{payby} = 'credit card';
4813 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4814 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4816 }elsif ($payby eq 'COMP') {
4817 $letter_data{payby} = 'complimentary account';
4819 $letter_data{payby} = 'current method';
4821 $letter_data{expdate} = $expire_time;
4823 for (keys %{$options{extra_fields}}){
4824 $letter_data{$_} = $options{extra_fields}->{$_};
4827 unless(exists($letter_data{returnaddress})){
4828 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4829 $self->agent_template)
4831 if ( length($retadd) ) {
4832 $letter_data{returnaddress} = $retadd;
4833 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4834 $letter_data{returnaddress} =
4835 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4839 ( $conf->config('company_name', $self->agentnum),
4840 $conf->config('company_address', $self->agentnum),
4844 $letter_data{returnaddress} = '~';
4848 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4850 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4852 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4854 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4858 ) or die "can't open temp file: $!\n";
4859 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4860 or die "can't write temp file: $!\n";
4862 $letter_data{'logo_file'} = $lh->filename;
4864 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4868 ) or die "can't open temp file: $!\n";
4870 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4872 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4873 return ($1, $letter_data{'logo_file'});
4877 =item print_ps TEMPLATE
4879 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4885 my($file, $lfile) = $self->generate_letter(@_);
4886 my $ps = FS::Misc::generate_ps($file);
4887 unlink($file.'.tex');
4893 =item print TEMPLATE
4895 Prints the filled in template.
4897 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4901 sub queueable_print {
4904 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4905 or die "invalid customer number: " . $opt{custvnum};
4907 my $error = $self->print( $opt{template} );
4908 die $error if $error;
4912 my ($self, $template) = (shift, shift);
4914 [ $self->print_ps($template) ],
4915 'agentnum' => $self->agentnum,
4919 #these three subs should just go away once agent stuff is all config overrides
4921 sub agent_template {
4923 $self->_agent_plandata('agent_templatename');
4926 sub agent_invoice_from {
4928 $self->_agent_plandata('agent_invoice_from');
4931 sub _agent_plandata {
4932 my( $self, $option ) = @_;
4934 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4935 #agent-specific Conf
4937 use FS::part_event::Condition;
4939 my $agentnum = $self->agentnum;
4941 my $regexp = regexp_sql();
4943 my $part_event_option =
4945 'select' => 'part_event_option.*',
4946 'table' => 'part_event_option',
4948 LEFT JOIN part_event USING ( eventpart )
4949 LEFT JOIN part_event_option AS peo_agentnum
4950 ON ( part_event.eventpart = peo_agentnum.eventpart
4951 AND peo_agentnum.optionname = 'agentnum'
4952 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4954 LEFT JOIN part_event_condition
4955 ON ( part_event.eventpart = part_event_condition.eventpart
4956 AND part_event_condition.conditionname = 'cust_bill_age'
4958 LEFT JOIN part_event_condition_option
4959 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4960 AND part_event_condition_option.optionname = 'age'
4963 #'hashref' => { 'optionname' => $option },
4964 #'hashref' => { 'part_event_option.optionname' => $option },
4966 " WHERE part_event_option.optionname = ". dbh->quote($option).
4967 " AND action = 'cust_bill_send_agent' ".
4968 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4969 " AND peo_agentnum.optionname = 'agentnum' ".
4970 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4972 CASE WHEN part_event_condition_option.optionname IS NULL
4974 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4976 , part_event.weight".
4980 unless ( $part_event_option ) {
4981 return $self->agent->invoice_template || ''
4982 if $option eq 'agent_templatename';
4986 $part_event_option->optionvalue;
4990 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4992 Subroutine (not a method), designed to be called from the queue.
4994 Takes a list of options and values.
4996 Pulls up the customer record via the custnum option and calls bill_and_collect.
5001 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5003 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5004 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5006 $cust_main->bill_and_collect( %args );
5009 sub process_bill_and_collect {
5011 my $param = thaw(decode_base64(shift));
5012 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5013 or die "custnum '$param->{custnum}' not found!\n";
5014 $param->{'job'} = $job;
5015 $param->{'fatal'} = 1; # runs from job queue, will be caught
5016 $param->{'retry'} = 1;
5018 $cust_main->bill_and_collect( %$param );
5021 #starting to take quite a while for big dbs
5022 # (JRNL: journaled so it only happens once per database)
5023 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5024 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5025 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5026 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5027 # JRNL leading/trailing spaces in first, last, company
5028 # - otaker upgrade? journal and call it good? (double check to make sure
5029 # we're not still setting otaker here)
5031 #only going to get worse with new location stuff...
5033 sub _upgrade_data { #class method
5034 my ($class, %opts) = @_;
5037 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5040 #this seems to be the only expensive one.. why does it take so long?
5041 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5043 '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';
5044 FS::upgrade_journal->set_done('cust_main__signupdate');
5047 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5049 # fix yyyy-m-dd formatted paydates
5050 if ( driver_name =~ /^mysql/i ) {
5052 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5053 } else { # the SQL standard
5055 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5057 FS::upgrade_journal->set_done('cust_main__paydate');
5060 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5062 push @statements, #fix the weird BILL with a cc# in payinfo problem
5064 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5066 FS::upgrade_journal->set_done('cust_main__payinfo');
5071 foreach my $sql ( @statements ) {
5072 my $sth = dbh->prepare($sql) or die dbh->errstr;
5073 $sth->execute or die $sth->errstr;
5074 #warn ( (time - $t). " seconds\n" );
5078 local($ignore_expired_card) = 1;
5079 local($ignore_banned_card) = 1;
5080 local($skip_fuzzyfiles) = 1;
5081 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5083 FS::cust_main::Location->_upgrade_data(%opts);
5085 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5087 foreach my $cust_main ( qsearch({
5088 'table' => 'cust_main',
5090 'extra_sql' => 'WHERE '.
5092 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5093 qw( first last company )
5096 my $error = $cust_main->replace;
5097 die $error if $error;
5100 FS::upgrade_journal->set_done('cust_main__trimspaces');
5104 $class->_upgrade_otaker(%opts);
5114 The delete method should possibly take an FS::cust_main object reference
5115 instead of a scalar customer number.
5117 Bill and collect options should probably be passed as references instead of a
5120 There should probably be a configuration file with a list of allowed credit
5123 No multiple currency support (probably a larger project than just this module).
5125 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5127 Birthdates rely on negative epoch values.
5129 The payby for card/check batches is broken. With mixed batching, bad
5132 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5136 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5137 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5138 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.