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 FS::Sales_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_credit_void' => 'voided credits',
1285 'cust_pay' => 'payments',
1286 'cust_pay_void' => 'voided payments',
1287 'cust_refund' => 'refunds',
1290 foreach my $table ( keys %financial_tables ) {
1292 my @records = $self->$table();
1294 foreach my $record ( @records ) {
1295 $record->custnum($new_custnum);
1296 my $error = $record->replace;
1298 $dbh->rollback if $oldAutoCommit;
1299 return "Error merging ". $financial_tables{$table}. ": $error\n";
1305 my $name = $self->ship_name; #?
1307 my $locationnum = '';
1308 foreach my $cust_pkg ( $self->all_pkgs ) {
1309 $cust_pkg->custnum($new_custnum);
1311 unless ( $cust_pkg->locationnum ) {
1312 unless ( $locationnum ) {
1313 my $cust_location = new FS::cust_location {
1314 $self->location_hash,
1315 'custnum' => $new_custnum,
1317 my $error = $cust_location->insert;
1319 $dbh->rollback if $oldAutoCommit;
1322 $locationnum = $cust_location->locationnum;
1324 $cust_pkg->locationnum($locationnum);
1327 my $error = $cust_pkg->replace;
1329 $dbh->rollback if $oldAutoCommit;
1333 # add customer (ship) name to svc_phone.phone_name if blank
1334 my @cust_svc = $cust_pkg->cust_svc;
1335 foreach my $cust_svc (@cust_svc) {
1336 my($label, $value, $svcdb) = $cust_svc->label;
1337 next unless $svcdb eq 'svc_phone';
1338 my $svc_phone = $cust_svc->svc_x;
1339 next if $svc_phone->phone_name;
1340 $svc_phone->phone_name($name);
1341 my $error = $svc_phone->replace;
1343 $dbh->rollback if $oldAutoCommit;
1351 # cust_tax_exempt (texas tax exemptions)
1352 # cust_recon (some sort of not-well understood thing for OnPac)
1354 #these are moved over
1355 foreach my $table (qw(
1356 cust_tag cust_location contact cust_attachment cust_main_note
1357 cust_tax_adjustment cust_pay_batch queue
1359 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1360 $record->custnum($new_custnum);
1361 my $error = $record->replace;
1363 $dbh->rollback if $oldAutoCommit;
1369 #these aren't preserved
1370 foreach my $table (qw(
1371 cust_main_exemption cust_main_invoice
1373 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1374 my $error = $record->delete;
1376 $dbh->rollback if $oldAutoCommit;
1383 my $sth = $dbh->prepare(
1384 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1386 my $errstr = $dbh->errstr;
1387 $dbh->rollback if $oldAutoCommit;
1390 $sth->execute($new_custnum, $self->custnum) or do {
1391 my $errstr = $sth->errstr;
1392 $dbh->rollback if $oldAutoCommit;
1398 my $ticket_dbh = '';
1399 if ($conf->config('ticket_system') eq 'RT_Internal') {
1401 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1402 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1403 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1404 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1407 if ( $ticket_dbh ) {
1409 my $ticket_sth = $ticket_dbh->prepare(
1410 'UPDATE Links SET Target = ? WHERE Target = ?'
1412 my $errstr = $ticket_dbh->errstr;
1413 $dbh->rollback if $oldAutoCommit;
1416 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1417 'freeside://freeside/cust_main/'.$self->custnum)
1419 my $errstr = $ticket_sth->errstr;
1420 $dbh->rollback if $oldAutoCommit;
1426 #delete the customer record
1428 my $error = $self->delete;
1430 $dbh->rollback if $oldAutoCommit;
1434 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1439 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1441 Replaces the OLD_RECORD with this one in the database. If there is an error,
1442 returns the error, otherwise returns false.
1444 To change the customer's address, set the pseudo-fields C<bill_location> and
1445 C<ship_location>. The address will still only change if at least one of the
1446 address fields differs from the existing values.
1448 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1449 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1450 expected and rollback the entire transaction; it is not necessary to call
1451 check_invoicing_list first. Here's an example:
1453 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1455 Currently available options are: I<tax_exemption>.
1457 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1458 of tax names and exemption numbers. FS::cust_main_exemption records will be
1459 deleted and inserted as appropriate.
1466 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1468 : $self->replace_old;
1472 warn "$me replace called\n"
1475 my $curuser = $FS::CurrentUser::CurrentUser;
1476 if ( $self->payby eq 'COMP'
1477 && $self->payby ne $old->payby
1478 && ! $curuser->access_right('Complimentary customer')
1481 return "You are not permitted to create complimentary accounts.";
1484 local($ignore_expired_card) = 1
1485 if $old->payby =~ /^(CARD|DCRD)$/
1486 && $self->payby =~ /^(CARD|DCRD)$/
1487 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1489 local($ignore_banned_card) = 1
1490 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1491 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1492 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1494 return "Invoicing locale is required"
1497 && $conf->exists('cust_main-require_locale');
1499 local $SIG{HUP} = 'IGNORE';
1500 local $SIG{INT} = 'IGNORE';
1501 local $SIG{QUIT} = 'IGNORE';
1502 local $SIG{TERM} = 'IGNORE';
1503 local $SIG{TSTP} = 'IGNORE';
1504 local $SIG{PIPE} = 'IGNORE';
1506 my $oldAutoCommit = $FS::UID::AutoCommit;
1507 local $FS::UID::AutoCommit = 0;
1510 for my $l (qw(bill_location ship_location)) {
1511 my $old_loc = $old->$l;
1512 my $new_loc = $self->$l;
1514 # find the existing location if there is one
1515 $new_loc->set('custnum' => $self->custnum);
1516 my $error = $new_loc->find_or_insert;
1518 $dbh->rollback if $oldAutoCommit;
1521 $self->set($l.'num', $new_loc->locationnum);
1524 # replace the customer record
1525 my $error = $self->SUPER::replace($old);
1528 $dbh->rollback if $oldAutoCommit;
1532 # now move packages to the new service location
1533 $self->set('ship_location', ''); #flush cache
1534 if ( $old->ship_locationnum and # should only be null during upgrade...
1535 $old->ship_locationnum != $self->ship_locationnum ) {
1536 $error = $old->ship_location->move_to($self->ship_location);
1538 $dbh->rollback if $oldAutoCommit;
1542 # don't move packages based on the billing location, but
1543 # disable it if it's no longer in use
1544 if ( $old->bill_locationnum and
1545 $old->bill_locationnum != $self->bill_locationnum ) {
1546 $error = $old->bill_location->disable_if_unused;
1548 $dbh->rollback if $oldAutoCommit;
1553 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1554 my $invoicing_list = shift @param;
1555 $error = $self->check_invoicing_list( $invoicing_list );
1557 $dbh->rollback if $oldAutoCommit;
1560 $self->invoicing_list( $invoicing_list );
1563 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1565 #this could be more efficient than deleting and re-inserting, if it matters
1566 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1567 my $error = $cust_tag->delete;
1569 $dbh->rollback if $oldAutoCommit;
1573 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1574 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1575 'custnum' => $self->custnum };
1576 my $error = $cust_tag->insert;
1578 $dbh->rollback if $oldAutoCommit;
1585 my %options = @param;
1587 my $tax_exemption = delete $options{'tax_exemption'};
1588 if ( $tax_exemption ) {
1590 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1591 if ref($tax_exemption) eq 'ARRAY';
1593 my %cust_main_exemption =
1594 map { $_->taxname => $_ }
1595 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1597 foreach my $taxname ( keys %$tax_exemption ) {
1599 if ( $cust_main_exemption{$taxname} &&
1600 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1603 delete $cust_main_exemption{$taxname};
1607 my $cust_main_exemption = new FS::cust_main_exemption {
1608 'custnum' => $self->custnum,
1609 'taxname' => $taxname,
1610 'exempt_number' => $tax_exemption->{$taxname},
1612 my $error = $cust_main_exemption->insert;
1614 $dbh->rollback if $oldAutoCommit;
1615 return "inserting cust_main_exemption (transaction rolled back): $error";
1619 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1620 my $error = $cust_main_exemption->delete;
1622 $dbh->rollback if $oldAutoCommit;
1623 return "deleting cust_main_exemption (transaction rolled back): $error";
1629 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1630 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1631 && $self->get('payinfo') !~ /^99\d{14}$/
1633 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1638 # card/check/lec info has changed, want to retry realtime_ invoice events
1639 my $error = $self->retry_realtime;
1641 $dbh->rollback if $oldAutoCommit;
1646 unless ( $import || $skip_fuzzyfiles ) {
1647 $error = $self->queue_fuzzyfiles_update;
1649 $dbh->rollback if $oldAutoCommit;
1650 return "updating fuzzy search cache: $error";
1654 # tax district update in cust_location
1656 # cust_main exports!
1658 my $export_args = $options{'export_args'} || [];
1661 map qsearch( 'part_export', {exportnum=>$_} ),
1662 $conf->config('cust_main-exports'); #, $agentnum
1664 foreach my $part_export ( @part_export ) {
1665 my $error = $part_export->export_replace( $self, $old, @$export_args);
1667 $dbh->rollback if $oldAutoCommit;
1668 return "exporting to ". $part_export->exporttype.
1669 " (transaction rolled back): $error";
1673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1678 =item queue_fuzzyfiles_update
1680 Used by insert & replace to update the fuzzy search cache
1684 use FS::cust_main::Search;
1685 sub queue_fuzzyfiles_update {
1688 local $SIG{HUP} = 'IGNORE';
1689 local $SIG{INT} = 'IGNORE';
1690 local $SIG{QUIT} = 'IGNORE';
1691 local $SIG{TERM} = 'IGNORE';
1692 local $SIG{TSTP} = 'IGNORE';
1693 local $SIG{PIPE} = 'IGNORE';
1695 my $oldAutoCommit = $FS::UID::AutoCommit;
1696 local $FS::UID::AutoCommit = 0;
1699 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1700 my $queue = new FS::queue {
1701 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1703 my @args = "cust_main.$field", $self->get($field);
1704 my $error = $queue->insert( @args );
1706 $dbh->rollback if $oldAutoCommit;
1707 return "queueing job (transaction rolled back): $error";
1711 my @locations = $self->bill_location;
1712 push @locations, $self->ship_location if $self->has_ship_address;
1713 foreach my $location (@locations) {
1714 my $queue = new FS::queue {
1715 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1717 my @args = 'cust_location.address1', $location->address1;
1718 my $error = $queue->insert( @args );
1720 $dbh->rollback if $oldAutoCommit;
1721 return "queueing job (transaction rolled back): $error";
1725 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1732 Checks all fields to make sure this is a valid customer record. If there is
1733 an error, returns the error, otherwise returns false. Called by the insert
1734 and replace methods.
1741 warn "$me check BEFORE: \n". $self->_dump
1745 $self->ut_numbern('custnum')
1746 || $self->ut_number('agentnum')
1747 || $self->ut_textn('agent_custid')
1748 || $self->ut_number('refnum')
1749 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1750 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1751 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1752 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1753 || $self->ut_textn('custbatch')
1754 || $self->ut_name('last')
1755 || $self->ut_name('first')
1756 || $self->ut_snumbern('signupdate')
1757 || $self->ut_snumbern('birthdate')
1758 || $self->ut_snumbern('spouse_birthdate')
1759 || $self->ut_snumbern('anniversary_date')
1760 || $self->ut_textn('company')
1761 || $self->ut_textn('ship_company')
1762 || $self->ut_anything('comments')
1763 || $self->ut_numbern('referral_custnum')
1764 || $self->ut_textn('stateid')
1765 || $self->ut_textn('stateid_state')
1766 || $self->ut_textn('invoice_terms')
1767 || $self->ut_floatn('cdr_termination_percentage')
1768 || $self->ut_floatn('credit_limit')
1769 || $self->ut_numbern('billday')
1770 || $self->ut_numbern('prorate_day')
1771 || $self->ut_flag('edit_subject')
1772 || $self->ut_flag('calling_list_exempt')
1773 || $self->ut_flag('invoice_noemail')
1774 || $self->ut_flag('message_noemail')
1775 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1778 foreach (qw(company ship_company)) {
1779 my $company = $self->get($_);
1780 $company =~ s/^\s+//;
1781 $company =~ s/\s+$//;
1782 $company =~ s/\s+/ /g;
1783 $self->set($_, $company);
1786 #barf. need message catalogs. i18n. etc.
1787 $error .= "Please select an advertising source."
1788 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1789 return $error if $error;
1791 return "Unknown agent"
1792 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1794 return "Unknown refnum"
1795 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1797 return "Unknown referring custnum: ". $self->referral_custnum
1798 unless ! $self->referral_custnum
1799 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1801 if ( $self->ss eq '' ) {
1806 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1807 or return "Illegal social security number: ". $self->ss;
1808 $self->ss("$1-$2-$3");
1811 # cust_main_county verification now handled by cust_location check
1814 $self->ut_phonen('daytime', $self->country)
1815 || $self->ut_phonen('night', $self->country)
1816 || $self->ut_phonen('fax', $self->country)
1817 || $self->ut_phonen('mobile', $self->country)
1819 return $error if $error;
1821 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1823 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1826 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1828 : FS::Msgcat::_gettext('daytime');
1829 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1831 : FS::Msgcat::_gettext('night');
1833 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1835 : FS::Msgcat::_gettext('mobile');
1837 return "$daytime_label, $night_label or $mobile_label is required"
1841 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1842 # or return "Illegal payby: ". $self->payby;
1844 FS::payby->can_payby($self->table, $self->payby)
1845 or return "Illegal payby: ". $self->payby;
1847 $error = $self->ut_numbern('paystart_month')
1848 || $self->ut_numbern('paystart_year')
1849 || $self->ut_numbern('payissue')
1850 || $self->ut_textn('paytype')
1852 return $error if $error;
1854 if ( $self->payip eq '' ) {
1857 $error = $self->ut_ip('payip');
1858 return $error if $error;
1861 # If it is encrypted and the private key is not availaible then we can't
1862 # check the credit card.
1863 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1865 # Need some kind of global flag to accept invalid cards, for testing
1867 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1869 my $payinfo = $self->payinfo;
1870 $payinfo =~ s/\D//g;
1871 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1872 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1874 $self->payinfo($payinfo);
1876 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1878 return gettext('unknown_card_type')
1879 if $self->payinfo !~ /^99\d{14}$/ #token
1880 && cardtype($self->payinfo) eq "Unknown";
1882 unless ( $ignore_banned_card ) {
1883 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1885 if ( $ban->bantype eq 'warn' ) {
1886 #or others depending on value of $ban->reason ?
1887 return '_duplicate_card'.
1888 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1889 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1890 ' (ban# '. $ban->bannum. ')'
1891 unless $self->override_ban_warn;
1893 return 'Banned credit card: banned on '.
1894 time2str('%a %h %o at %r', $ban->_date).
1895 ' by '. $ban->otaker.
1896 ' (ban# '. $ban->bannum. ')';
1901 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1902 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1903 $self->paycvv =~ /^(\d{4})$/
1904 or return "CVV2 (CID) for American Express cards is four digits.";
1907 $self->paycvv =~ /^(\d{3})$/
1908 or return "CVV2 (CVC2/CID) is three digits.";
1915 my $cardtype = cardtype($payinfo);
1916 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1918 return "Start date or issue number is required for $cardtype cards"
1919 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1921 return "Start month must be between 1 and 12"
1922 if $self->paystart_month
1923 and $self->paystart_month < 1 || $self->paystart_month > 12;
1925 return "Start year must be 1990 or later"
1926 if $self->paystart_year
1927 and $self->paystart_year < 1990;
1929 return "Issue number must be beween 1 and 99"
1931 and $self->payissue < 1 || $self->payissue > 99;
1934 $self->paystart_month('');
1935 $self->paystart_year('');
1936 $self->payissue('');
1939 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1941 my $payinfo = $self->payinfo;
1942 $payinfo =~ s/[^\d\@\.]//g;
1943 if ( $conf->config('echeck-country') eq 'CA' ) {
1944 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1945 or return 'invalid echeck account@branch.bank';
1946 $payinfo = "$1\@$2.$3";
1947 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1948 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1949 $payinfo = "$1\@$2";
1951 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1952 $payinfo = "$1\@$2";
1954 $self->payinfo($payinfo);
1957 unless ( $ignore_banned_card ) {
1958 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1960 if ( $ban->bantype eq 'warn' ) {
1961 #or others depending on value of $ban->reason ?
1962 return '_duplicate_ach' unless $self->override_ban_warn;
1964 return 'Banned ACH account: banned on '.
1965 time2str('%a %h %o at %r', $ban->_date).
1966 ' by '. $ban->otaker.
1967 ' (ban# '. $ban->bannum. ')';
1972 } elsif ( $self->payby eq 'LECB' ) {
1974 my $payinfo = $self->payinfo;
1975 $payinfo =~ s/\D//g;
1976 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1978 $self->payinfo($payinfo);
1981 } elsif ( $self->payby eq 'BILL' ) {
1983 $error = $self->ut_textn('payinfo');
1984 return "Illegal P.O. number: ". $self->payinfo if $error;
1987 } elsif ( $self->payby eq 'COMP' ) {
1989 my $curuser = $FS::CurrentUser::CurrentUser;
1990 if ( ! $self->custnum
1991 && ! $curuser->access_right('Complimentary customer')
1994 return "You are not permitted to create complimentary accounts."
1997 $error = $self->ut_textn('payinfo');
1998 return "Illegal comp account issuer: ". $self->payinfo if $error;
2001 } elsif ( $self->payby eq 'PREPAY' ) {
2003 my $payinfo = $self->payinfo;
2004 $payinfo =~ s/\W//g; #anything else would just confuse things
2005 $self->payinfo($payinfo);
2006 $error = $self->ut_alpha('payinfo');
2007 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2008 return "Unknown prepayment identifier"
2009 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2014 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2015 return "Expiration date required"
2016 # shouldn't payinfo_check do this?
2017 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2021 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2022 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2023 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2024 ( $m, $y ) = ( $2, "19$1" );
2025 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2026 ( $m, $y ) = ( $3, "20$2" );
2028 return "Illegal expiration date: ". $self->paydate;
2030 $m = sprintf('%02d',$m);
2031 $self->paydate("$y-$m-01");
2032 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2033 return gettext('expired_card')
2035 && !$ignore_expired_card
2036 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2039 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2040 ( ! $conf->exists('require_cardname')
2041 || $self->payby !~ /^(CARD|DCRD)$/ )
2043 $self->payname( $self->first. " ". $self->getfield('last') );
2045 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2046 or return gettext('illegal_name'). " payname: ". $self->payname;
2050 return "Please select an invoicing locale"
2053 && $conf->exists('cust_main-require_locale');
2055 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2056 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2060 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2062 warn "$me check AFTER: \n". $self->_dump
2065 $self->SUPER::check;
2070 Returns a list of fields which have ship_ duplicates.
2075 qw( last first company
2076 address1 address2 city county state zip country
2078 daytime night fax mobile
2082 =item has_ship_address
2084 Returns true if this customer record has a separate shipping address.
2088 sub has_ship_address {
2090 $self->bill_locationnum != $self->ship_locationnum;
2095 Returns a list of key/value pairs, with the following keys: address1,
2096 adddress2, city, county, state, zip, country, district, and geocode. The
2097 shipping address is used if present.
2103 $self->ship_location->location_hash;
2108 Returns all locations (see L<FS::cust_location>) for this customer.
2114 qsearch('cust_location', { 'custnum' => $self->custnum,
2115 'prospectnum' => '' } );
2120 Returns all contacts (see L<FS::contact>) for this customer.
2124 #already used :/ sub contact {
2127 qsearch('contact', { 'custnum' => $self->custnum } );
2132 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2133 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2134 on success or a list of errors.
2140 grep { $_->unsuspend } $self->suspended_pkgs;
2145 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2147 Returns a list: an empty list on success or a list of errors.
2153 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2156 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2158 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2159 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2160 of a list of pkgparts; the hashref has the following keys:
2164 =item pkgparts - listref of pkgparts
2166 =item (other options are passed to the suspend method)
2171 Returns a list: an empty list on success or a list of errors.
2175 sub suspend_if_pkgpart {
2177 my (@pkgparts, %opt);
2178 if (ref($_[0]) eq 'HASH'){
2179 @pkgparts = @{$_[0]{pkgparts}};
2184 grep { $_->suspend(%opt) }
2185 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2186 $self->unsuspended_pkgs;
2189 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2191 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2192 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2193 instead of a list of pkgparts; the hashref has the following keys:
2197 =item pkgparts - listref of pkgparts
2199 =item (other options are passed to the suspend method)
2203 Returns a list: an empty list on success or a list of errors.
2207 sub suspend_unless_pkgpart {
2209 my (@pkgparts, %opt);
2210 if (ref($_[0]) eq 'HASH'){
2211 @pkgparts = @{$_[0]{pkgparts}};
2216 grep { $_->suspend(%opt) }
2217 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2218 $self->unsuspended_pkgs;
2221 =item cancel [ OPTION => VALUE ... ]
2223 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2225 Available options are:
2229 =item quiet - can be set true to supress email cancellation notices.
2231 =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.
2233 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2235 =item nobill - can be set true to skip billing if it might otherwise be done.
2239 Always returns a list: an empty list on success or a list of errors.
2243 # nb that dates are not specified as valid options to this method
2246 my( $self, %opt ) = @_;
2248 warn "$me cancel called on customer ". $self->custnum. " with options ".
2249 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2252 return ( 'access denied' )
2253 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2255 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2257 #should try decryption (we might have the private key)
2258 # and if not maybe queue a job for the server that does?
2259 return ( "Can't (yet) ban encrypted credit cards" )
2260 if $self->is_encrypted($self->payinfo);
2262 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2263 my $error = $ban->insert;
2264 return ( $error ) if $error;
2268 my @pkgs = $self->ncancelled_pkgs;
2270 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2272 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2273 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2277 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2278 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2281 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2284 sub _banned_pay_hashref {
2295 'payby' => $payby2ban{$self->payby},
2296 'payinfo' => $self->payinfo,
2297 #don't ever *search* on reason! #'reason' =>
2301 sub _new_banned_pay_hashref {
2303 my $hr = $self->_banned_pay_hashref;
2304 $hr->{payinfo} = md5_base64($hr->{payinfo});
2310 Returns all notes (see L<FS::cust_main_note>) for this customer.
2315 my($self,$orderby_classnum) = (shift,shift);
2316 my $orderby = "_DATE DESC";
2317 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2318 qsearch( 'cust_main_note',
2319 { 'custnum' => $self->custnum },
2321 "ORDER BY $orderby",
2327 Returns the agent (see L<FS::agent>) for this customer.
2333 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2338 Returns the agent name (see L<FS::agent>) for this customer.
2344 $self->agent->agent;
2349 Returns any tags associated with this customer, as FS::cust_tag objects,
2350 or an empty list if there are no tags.
2356 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2361 Returns any tags associated with this customer, as FS::part_tag objects,
2362 or an empty list if there are no tags.
2368 map $_->part_tag, $self->cust_tag;
2374 Returns the customer class, as an FS::cust_class object, or the empty string
2375 if there is no customer class.
2381 if ( $self->classnum ) {
2382 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2390 Returns the customer category name, or the empty string if there is no customer
2397 my $cust_class = $self->cust_class;
2399 ? $cust_class->categoryname
2405 Returns the customer class name, or the empty string if there is no customer
2412 my $cust_class = $self->cust_class;
2414 ? $cust_class->classname
2418 =item BILLING METHODS
2420 Documentation on billing methods has been moved to
2421 L<FS::cust_main::Billing>.
2423 =item REALTIME BILLING METHODS
2425 Documentation on realtime billing methods has been moved to
2426 L<FS::cust_main::Billing_Realtime>.
2430 Removes the I<paycvv> field from the database directly.
2432 If there is an error, returns the error, otherwise returns false.
2438 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2439 or return dbh->errstr;
2440 $sth->execute($self->custnum)
2441 or return $sth->errstr;
2446 =item batch_card OPTION => VALUE...
2448 Adds a payment for this invoice to the pending credit card batch (see
2449 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2450 runs the payment using a realtime gateway.
2452 Options may include:
2454 B<amount>: the amount to be paid; defaults to the customer's balance minus
2455 any payments in transit.
2457 B<payby>: the payment method; defaults to cust_main.payby
2459 B<realtime>: runs this as a realtime payment instead of adding it to a
2462 B<invnum>: sets cust_pay_batch.invnum.
2464 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2465 the billing address for the payment; defaults to the customer's billing
2468 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2469 date, and name; defaults to those fields in cust_main.
2474 my ($self, %options) = @_;
2477 if (exists($options{amount})) {
2478 $amount = $options{amount};
2480 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2482 return '' unless $amount > 0;
2484 my $invnum = delete $options{invnum};
2485 my $payby = $options{payby} || $self->payby; #still dubious
2487 if ($options{'realtime'}) {
2488 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2494 my $oldAutoCommit = $FS::UID::AutoCommit;
2495 local $FS::UID::AutoCommit = 0;
2498 #this needs to handle mysql as well as Pg, like svc_acct.pm
2499 #(make it into a common function if folks need to do batching with mysql)
2500 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2501 or return "Cannot lock pay_batch: " . $dbh->errstr;
2505 'payby' => FS::payby->payby2payment($payby),
2507 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2509 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2511 unless ( $pay_batch ) {
2512 $pay_batch = new FS::pay_batch \%pay_batch;
2513 my $error = $pay_batch->insert;
2515 $dbh->rollback if $oldAutoCommit;
2516 die "error creating new batch: $error\n";
2520 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2521 'batchnum' => $pay_batch->batchnum,
2522 'custnum' => $self->custnum,
2525 foreach (qw( address1 address2 city state zip country latitude longitude
2526 payby payinfo paydate payname ))
2528 $options{$_} = '' unless exists($options{$_});
2531 my $loc = $self->bill_location;
2533 my $cust_pay_batch = new FS::cust_pay_batch ( {
2534 'batchnum' => $pay_batch->batchnum,
2535 'invnum' => $invnum || 0, # is there a better value?
2536 # this field should be
2538 # cust_bill_pay_batch now
2539 'custnum' => $self->custnum,
2540 'last' => $self->getfield('last'),
2541 'first' => $self->getfield('first'),
2542 'address1' => $options{address1} || $loc->address1,
2543 'address2' => $options{address2} || $loc->address2,
2544 'city' => $options{city} || $loc->city,
2545 'state' => $options{state} || $loc->state,
2546 'zip' => $options{zip} || $loc->zip,
2547 'country' => $options{country} || $loc->country,
2548 'payby' => $options{payby} || $self->payby,
2549 'payinfo' => $options{payinfo} || $self->payinfo,
2550 'exp' => $options{paydate} || $self->paydate,
2551 'payname' => $options{payname} || $self->payname,
2552 'amount' => $amount, # consolidating
2555 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2556 if $old_cust_pay_batch;
2559 if ($old_cust_pay_batch) {
2560 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2562 $error = $cust_pay_batch->insert;
2566 $dbh->rollback if $oldAutoCommit;
2570 my $unapplied = $self->total_unapplied_credits
2571 + $self->total_unapplied_payments
2572 + $self->in_transit_payments;
2573 foreach my $cust_bill ($self->open_cust_bill) {
2574 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2575 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2576 'invnum' => $cust_bill->invnum,
2577 'paybatchnum' => $cust_pay_batch->paybatchnum,
2578 'amount' => $cust_bill->owed,
2581 if ($unapplied >= $cust_bill_pay_batch->amount){
2582 $unapplied -= $cust_bill_pay_batch->amount;
2585 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2586 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2588 $error = $cust_bill_pay_batch->insert;
2590 $dbh->rollback if $oldAutoCommit;
2595 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2601 Returns the total owed for this customer on all invoices
2602 (see L<FS::cust_bill/owed>).
2608 $self->total_owed_date(2145859200); #12/31/2037
2611 =item total_owed_date TIME
2613 Returns the total owed for this customer on all invoices with date earlier than
2614 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2615 see L<Time::Local> and L<Date::Parse> for conversion functions.
2619 sub total_owed_date {
2623 my $custnum = $self->custnum;
2625 my $owed_sql = FS::cust_bill->owed_sql;
2628 SELECT SUM($owed_sql) FROM cust_bill
2629 WHERE custnum = $custnum
2633 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2637 =item total_owed_pkgnum PKGNUM
2639 Returns the total owed on all invoices for this customer's specific package
2640 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2644 sub total_owed_pkgnum {
2645 my( $self, $pkgnum ) = @_;
2646 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2649 =item total_owed_date_pkgnum TIME PKGNUM
2651 Returns the total owed for this customer's specific package when using
2652 experimental package balances on all invoices with date earlier than
2653 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2654 see L<Time::Local> and L<Date::Parse> for conversion functions.
2658 sub total_owed_date_pkgnum {
2659 my( $self, $time, $pkgnum ) = @_;
2662 foreach my $cust_bill (
2663 grep { $_->_date <= $time }
2664 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2666 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2668 sprintf( "%.2f", $total_bill );
2674 Returns the total amount of all payments.
2681 $total += $_->paid foreach $self->cust_pay;
2682 sprintf( "%.2f", $total );
2685 =item total_unapplied_credits
2687 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2688 customer. See L<FS::cust_credit/credited>.
2690 =item total_credited
2692 Old name for total_unapplied_credits. Don't use.
2696 sub total_credited {
2697 #carp "total_credited deprecated, use total_unapplied_credits";
2698 shift->total_unapplied_credits(@_);
2701 sub total_unapplied_credits {
2704 my $custnum = $self->custnum;
2706 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2709 SELECT SUM($unapplied_sql) FROM cust_credit
2710 WHERE custnum = $custnum
2713 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2717 =item total_unapplied_credits_pkgnum PKGNUM
2719 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2720 customer. See L<FS::cust_credit/credited>.
2724 sub total_unapplied_credits_pkgnum {
2725 my( $self, $pkgnum ) = @_;
2726 my $total_credit = 0;
2727 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2728 sprintf( "%.2f", $total_credit );
2732 =item total_unapplied_payments
2734 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2735 See L<FS::cust_pay/unapplied>.
2739 sub total_unapplied_payments {
2742 my $custnum = $self->custnum;
2744 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2747 SELECT SUM($unapplied_sql) FROM cust_pay
2748 WHERE custnum = $custnum
2751 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2755 =item total_unapplied_payments_pkgnum PKGNUM
2757 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2758 specific package when using experimental package balances. See
2759 L<FS::cust_pay/unapplied>.
2763 sub total_unapplied_payments_pkgnum {
2764 my( $self, $pkgnum ) = @_;
2765 my $total_unapplied = 0;
2766 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2767 sprintf( "%.2f", $total_unapplied );
2771 =item total_unapplied_refunds
2773 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2774 customer. See L<FS::cust_refund/unapplied>.
2778 sub total_unapplied_refunds {
2780 my $custnum = $self->custnum;
2782 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2785 SELECT SUM($unapplied_sql) FROM cust_refund
2786 WHERE custnum = $custnum
2789 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2795 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2796 total_unapplied_credits minus total_unapplied_payments).
2802 $self->balance_date_range;
2805 =item balance_date TIME
2807 Returns the balance for this customer, only considering invoices with date
2808 earlier than TIME (total_owed_date minus total_credited minus
2809 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2810 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2817 $self->balance_date_range(shift);
2820 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2822 Returns the balance for this customer, optionally considering invoices with
2823 date earlier than START_TIME, and not later than END_TIME
2824 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2826 Times are specified as SQL fragments or numeric
2827 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2828 L<Date::Parse> for conversion functions. The empty string can be passed
2829 to disable that time constraint completely.
2831 Available options are:
2835 =item unapplied_date
2837 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)
2843 sub balance_date_range {
2845 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2846 ') FROM cust_main WHERE custnum='. $self->custnum;
2847 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2850 =item balance_pkgnum PKGNUM
2852 Returns the balance for this customer's specific package when using
2853 experimental package balances (total_owed plus total_unrefunded, minus
2854 total_unapplied_credits minus total_unapplied_payments)
2858 sub balance_pkgnum {
2859 my( $self, $pkgnum ) = @_;
2862 $self->total_owed_pkgnum($pkgnum)
2863 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2864 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2865 - $self->total_unapplied_credits_pkgnum($pkgnum)
2866 - $self->total_unapplied_payments_pkgnum($pkgnum)
2870 =item in_transit_payments
2872 Returns the total of requests for payments for this customer pending in
2873 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2877 sub in_transit_payments {
2879 my $in_transit_payments = 0;
2880 foreach my $pay_batch ( qsearch('pay_batch', {
2883 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2884 'batchnum' => $pay_batch->batchnum,
2885 'custnum' => $self->custnum,
2887 $in_transit_payments += $cust_pay_batch->amount;
2890 sprintf( "%.2f", $in_transit_payments );
2895 Returns a hash of useful information for making a payment.
2905 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2906 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2907 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2911 For credit card transactions:
2923 For electronic check transactions:
2938 $return{balance} = $self->balance;
2940 $return{payname} = $self->payname
2941 || ( $self->first. ' '. $self->get('last') );
2943 $return{$_} = $self->bill_location->$_
2944 for qw(address1 address2 city state zip);
2946 $return{payby} = $self->payby;
2947 $return{stateid_state} = $self->stateid_state;
2949 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2950 $return{card_type} = cardtype($self->payinfo);
2951 $return{payinfo} = $self->paymask;
2953 @return{'month', 'year'} = $self->paydate_monthyear;
2957 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2958 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2959 $return{payinfo1} = $payinfo1;
2960 $return{payinfo2} = $payinfo2;
2961 $return{paytype} = $self->paytype;
2962 $return{paystate} = $self->paystate;
2966 #doubleclick protection
2968 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2974 =item paydate_monthyear
2976 Returns a two-element list consisting of the month and year of this customer's
2977 paydate (credit card expiration date for CARD customers)
2981 sub paydate_monthyear {
2983 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2985 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2994 Returns the exact time in seconds corresponding to the payment method
2995 expiration date. For CARD/DCRD customers this is the end of the month;
2996 for others (COMP is the only other payby that uses paydate) it's the start.
2997 Returns 0 if the paydate is empty or set to the far future.
3003 my ($month, $year) = $self->paydate_monthyear;
3004 return 0 if !$year or $year >= 2037;
3005 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3007 if ( $month == 13 ) {
3011 return timelocal(0,0,0,1,$month-1,$year) - 1;
3014 return timelocal(0,0,0,1,$month-1,$year);
3018 =item paydate_epoch_sql
3020 Class method. Returns an SQL expression to obtain the payment expiration date
3021 as a number of seconds.
3025 # Special expiration date behavior for non-CARD/DCRD customers has been
3026 # carefully preserved. Do we really use that?
3027 sub paydate_epoch_sql {
3029 my $table = shift || 'cust_main';
3030 my ($case1, $case2);
3031 if ( driver_name eq 'Pg' ) {
3032 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3033 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3035 elsif ( lc(driver_name) eq 'mysql' ) {
3036 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3037 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3040 return "CASE WHEN $table.payby IN('CARD','DCRD')
3046 =item tax_exemption TAXNAME
3051 my( $self, $taxname ) = @_;
3053 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3054 'taxname' => $taxname,
3059 =item cust_main_exemption
3063 sub cust_main_exemption {
3065 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3068 =item invoicing_list [ ARRAYREF ]
3070 If an arguement is given, sets these email addresses as invoice recipients
3071 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3072 (except as warnings), so use check_invoicing_list first.
3074 Returns a list of email addresses (with svcnum entries expanded).
3076 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3077 check it without disturbing anything by passing nothing.
3079 This interface may change in the future.
3083 sub invoicing_list {
3084 my( $self, $arrayref ) = @_;
3087 my @cust_main_invoice;
3088 if ( $self->custnum ) {
3089 @cust_main_invoice =
3090 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3092 @cust_main_invoice = ();
3094 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3095 #warn $cust_main_invoice->destnum;
3096 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3097 #warn $cust_main_invoice->destnum;
3098 my $error = $cust_main_invoice->delete;
3099 warn $error if $error;
3102 if ( $self->custnum ) {
3103 @cust_main_invoice =
3104 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3106 @cust_main_invoice = ();
3108 my %seen = map { $_->address => 1 } @cust_main_invoice;
3109 foreach my $address ( @{$arrayref} ) {
3110 next if exists $seen{$address} && $seen{$address};
3111 $seen{$address} = 1;
3112 my $cust_main_invoice = new FS::cust_main_invoice ( {
3113 'custnum' => $self->custnum,
3116 my $error = $cust_main_invoice->insert;
3117 warn $error if $error;
3121 if ( $self->custnum ) {
3123 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3130 =item check_invoicing_list ARRAYREF
3132 Checks these arguements as valid input for the invoicing_list method. If there
3133 is an error, returns the error, otherwise returns false.
3137 sub check_invoicing_list {
3138 my( $self, $arrayref ) = @_;
3140 foreach my $address ( @$arrayref ) {
3142 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3143 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3146 my $cust_main_invoice = new FS::cust_main_invoice ( {
3147 'custnum' => $self->custnum,
3150 my $error = $self->custnum
3151 ? $cust_main_invoice->check
3152 : $cust_main_invoice->checkdest
3154 return $error if $error;
3158 return "Email address required"
3159 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3160 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3165 =item set_default_invoicing_list
3167 Sets the invoicing list to all accounts associated with this customer,
3168 overwriting any previous invoicing list.
3172 sub set_default_invoicing_list {
3174 $self->invoicing_list($self->all_emails);
3179 Returns the email addresses of all accounts provisioned for this customer.
3186 foreach my $cust_pkg ( $self->all_pkgs ) {
3187 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3189 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3190 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3192 $list{$_}=1 foreach map { $_->email } @svc_acct;
3197 =item invoicing_list_addpost
3199 Adds postal invoicing to this customer. If this customer is already configured
3200 to receive postal invoices, does nothing.
3204 sub invoicing_list_addpost {
3206 return if grep { $_ eq 'POST' } $self->invoicing_list;
3207 my @invoicing_list = $self->invoicing_list;
3208 push @invoicing_list, 'POST';
3209 $self->invoicing_list(\@invoicing_list);
3212 =item invoicing_list_emailonly
3214 Returns the list of email invoice recipients (invoicing_list without non-email
3215 destinations such as POST and FAX).
3219 sub invoicing_list_emailonly {
3221 warn "$me invoicing_list_emailonly called"
3223 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3226 =item invoicing_list_emailonly_scalar
3228 Returns the list of email invoice recipients (invoicing_list without non-email
3229 destinations such as POST and FAX) as a comma-separated scalar.
3233 sub invoicing_list_emailonly_scalar {
3235 warn "$me invoicing_list_emailonly_scalar called"
3237 join(', ', $self->invoicing_list_emailonly);
3240 =item referral_custnum_cust_main
3242 Returns the customer who referred this customer (or the empty string, if
3243 this customer was not referred).
3245 Note the difference with referral_cust_main method: This method,
3246 referral_custnum_cust_main returns the single customer (if any) who referred
3247 this customer, while referral_cust_main returns an array of customers referred
3252 sub referral_custnum_cust_main {
3254 return '' unless $self->referral_custnum;
3255 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3258 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3260 Returns an array of customers referred by this customer (referral_custnum set
3261 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3262 customers referred by customers referred by this customer and so on, inclusive.
3263 The default behavior is DEPTH 1 (no recursion).
3265 Note the difference with referral_custnum_cust_main method: This method,
3266 referral_cust_main, returns an array of customers referred BY this customer,
3267 while referral_custnum_cust_main returns the single customer (if any) who
3268 referred this customer.
3272 sub referral_cust_main {
3274 my $depth = @_ ? shift : 1;
3275 my $exclude = @_ ? shift : {};
3278 map { $exclude->{$_->custnum}++; $_; }
3279 grep { ! $exclude->{ $_->custnum } }
3280 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3284 map { $_->referral_cust_main($depth-1, $exclude) }
3291 =item referral_cust_main_ncancelled
3293 Same as referral_cust_main, except only returns customers with uncancelled
3298 sub referral_cust_main_ncancelled {
3300 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3303 =item referral_cust_pkg [ DEPTH ]
3305 Like referral_cust_main, except returns a flat list of all unsuspended (and
3306 uncancelled) packages for each customer. The number of items in this list may
3307 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3311 sub referral_cust_pkg {
3313 my $depth = @_ ? shift : 1;
3315 map { $_->unsuspended_pkgs }
3316 grep { $_->unsuspended_pkgs }
3317 $self->referral_cust_main($depth);
3320 =item referring_cust_main
3322 Returns the single cust_main record for the customer who referred this customer
3323 (referral_custnum), or false.
3327 sub referring_cust_main {
3329 return '' unless $self->referral_custnum;
3330 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3333 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3335 Applies a credit to this customer. If there is an error, returns the error,
3336 otherwise returns false.
3338 REASON can be a text string, an FS::reason object, or a scalar reference to
3339 a reasonnum. If a text string, it will be automatically inserted as a new
3340 reason, and a 'reason_type' option must be passed to indicate the
3341 FS::reason_type for the new reason.
3343 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3344 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3345 I<commission_pkgnum>.
3347 Any other options are passed to FS::cust_credit::insert.
3352 my( $self, $amount, $reason, %options ) = @_;
3354 my $cust_credit = new FS::cust_credit {
3355 'custnum' => $self->custnum,
3356 'amount' => $amount,
3359 if ( ref($reason) ) {
3361 if ( ref($reason) eq 'SCALAR' ) {
3362 $cust_credit->reasonnum( $$reason );
3364 $cust_credit->reasonnum( $reason->reasonnum );
3368 $cust_credit->set('reason', $reason)
3371 $cust_credit->$_( delete $options{$_} )
3372 foreach grep exists($options{$_}),
3373 qw( addlinfo eventnum ),
3374 map "commission_$_", qw( agentnum salesnum pkgnum );
3376 $cust_credit->insert(%options);
3380 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3382 Creates a one-time charge for this customer. If there is an error, returns
3383 the error, otherwise returns false.
3385 New-style, with a hashref of options:
3387 my $error = $cust_main->charge(
3391 'start_date' => str2time('7/4/2009'),
3392 'pkg' => 'Description',
3393 'comment' => 'Comment',
3394 'additional' => [], #extra invoice detail
3395 'classnum' => 1, #pkg_class
3397 'setuptax' => '', # or 'Y' for tax exempt
3399 'locationnum'=> 1234, # optional
3402 'taxclass' => 'Tax class',
3405 'taxproduct' => 2, #part_pkg_taxproduct
3406 'override' => {}, #XXX describe
3408 #will be filled in with the new object
3409 'cust_pkg_ref' => \$cust_pkg,
3411 #generate an invoice immediately
3413 'invoice_terms' => '', #with these terms
3419 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3425 my ( $amount, $quantity, $start_date, $classnum );
3426 my ( $pkg, $comment, $additional );
3427 my ( $setuptax, $taxclass ); #internal taxes
3428 my ( $taxproduct, $override ); #vendor (CCH) taxes
3430 my $cust_pkg_ref = '';
3431 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3433 if ( ref( $_[0] ) ) {
3434 $amount = $_[0]->{amount};
3435 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3436 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3437 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3438 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3439 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3440 : '$'. sprintf("%.2f",$amount);
3441 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3442 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3443 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3444 $additional = $_[0]->{additional} || [];
3445 $taxproduct = $_[0]->{taxproductnum};
3446 $override = { '' => $_[0]->{tax_override} };
3447 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3448 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3449 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3450 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3455 $pkg = @_ ? shift : 'One-time charge';
3456 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3458 $taxclass = @_ ? shift : '';
3462 local $SIG{HUP} = 'IGNORE';
3463 local $SIG{INT} = 'IGNORE';
3464 local $SIG{QUIT} = 'IGNORE';
3465 local $SIG{TERM} = 'IGNORE';
3466 local $SIG{TSTP} = 'IGNORE';
3467 local $SIG{PIPE} = 'IGNORE';
3469 my $oldAutoCommit = $FS::UID::AutoCommit;
3470 local $FS::UID::AutoCommit = 0;
3473 my $part_pkg = new FS::part_pkg ( {
3475 'comment' => $comment,
3479 'classnum' => ( $classnum ? $classnum : '' ),
3480 'setuptax' => $setuptax,
3481 'taxclass' => $taxclass,
3482 'taxproductnum' => $taxproduct,
3485 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3486 ( 0 .. @$additional - 1 )
3488 'additional_count' => scalar(@$additional),
3489 'setup_fee' => $amount,
3492 my $error = $part_pkg->insert( options => \%options,
3493 tax_overrides => $override,
3496 $dbh->rollback if $oldAutoCommit;
3500 my $pkgpart = $part_pkg->pkgpart;
3501 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3502 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3503 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3504 $error = $type_pkgs->insert;
3506 $dbh->rollback if $oldAutoCommit;
3511 my $cust_pkg = new FS::cust_pkg ( {
3512 'custnum' => $self->custnum,
3513 'pkgpart' => $pkgpart,
3514 'quantity' => $quantity,
3515 'start_date' => $start_date,
3516 'no_auto' => $no_auto,
3517 'locationnum'=> $locationnum,
3520 $error = $cust_pkg->insert;
3522 $dbh->rollback if $oldAutoCommit;
3524 } elsif ( $cust_pkg_ref ) {
3525 ${$cust_pkg_ref} = $cust_pkg;
3529 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3530 'pkg_list' => [ $cust_pkg ],
3533 $dbh->rollback if $oldAutoCommit;
3538 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3543 #=item charge_postal_fee
3545 #Applies a one time charge this customer. If there is an error,
3546 #returns the error, returns the cust_pkg charge object or false
3547 #if there was no charge.
3551 # This should be a customer event. For that to work requires that bill
3552 # also be a customer event.
3554 sub charge_postal_fee {
3557 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3558 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3560 my $cust_pkg = new FS::cust_pkg ( {
3561 'custnum' => $self->custnum,
3562 'pkgpart' => $pkgpart,
3566 my $error = $cust_pkg->insert;
3567 $error ? $error : $cust_pkg;
3570 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3572 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3574 Optionally, a list or hashref of additional arguments to the qsearch call can
3581 my $opt = ref($_[0]) ? shift : { @_ };
3583 #return $self->num_cust_bill unless wantarray || keys %$opt;
3585 $opt->{'table'} = 'cust_bill';
3586 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3587 $opt->{'hashref'}{'custnum'} = $self->custnum;
3588 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3590 map { $_ } #behavior of sort undefined in scalar context
3591 sort { $a->_date <=> $b->_date }
3595 =item open_cust_bill
3597 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3602 sub open_cust_bill {
3606 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3612 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3614 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3618 sub legacy_cust_bill {
3621 #return $self->num_legacy_cust_bill unless wantarray;
3623 map { $_ } #behavior of sort undefined in scalar context
3624 sort { $a->_date <=> $b->_date }
3625 qsearch({ 'table' => 'legacy_cust_bill',
3626 'hashref' => { 'custnum' => $self->custnum, },
3627 'order_by' => 'ORDER BY _date ASC',
3631 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3633 Returns all the statements (see L<FS::cust_statement>) for this customer.
3635 Optionally, a list or hashref of additional arguments to the qsearch call can
3640 =item cust_bill_void
3642 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3646 sub cust_bill_void {
3649 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3650 sort { $a->_date <=> $b->_date }
3651 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3654 sub cust_statement {
3656 my $opt = ref($_[0]) ? shift : { @_ };
3658 #return $self->num_cust_statement unless wantarray || keys %$opt;
3660 $opt->{'table'} = 'cust_statement';
3661 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3662 $opt->{'hashref'}{'custnum'} = $self->custnum;
3663 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3665 map { $_ } #behavior of sort undefined in scalar context
3666 sort { $a->_date <=> $b->_date }
3670 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3672 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3674 Optionally, a list or hashref of additional arguments to the qsearch call can
3675 be passed following the SVCDB.
3682 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3683 warn "$me svc_x requires a svcdb";
3686 my $opt = ref($_[0]) ? shift : { @_ };
3688 $opt->{'table'} = $svcdb;
3689 $opt->{'addl_from'} =
3690 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3691 ($opt->{'addl_from'} || '');
3693 my $custnum = $self->custnum;
3694 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3695 my $where = "cust_pkg.custnum = $custnum";
3697 my $extra_sql = $opt->{'extra_sql'} || '';
3698 if ( keys %{ $opt->{'hashref'} } ) {
3699 $extra_sql = " AND $where $extra_sql";
3702 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3703 $extra_sql = "WHERE $where AND $1";
3706 $extra_sql = "WHERE $where $extra_sql";
3709 $opt->{'extra_sql'} = $extra_sql;
3714 # required for use as an eventtable;
3717 $self->svc_x('svc_acct', @_);
3722 Returns all the credits (see L<FS::cust_credit>) for this customer.
3728 map { $_ } #return $self->num_cust_credit unless wantarray;
3729 sort { $a->_date <=> $b->_date }
3730 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3733 =item cust_credit_pkgnum
3735 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3736 package when using experimental package balances.
3740 sub cust_credit_pkgnum {
3741 my( $self, $pkgnum ) = @_;
3742 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3743 sort { $a->_date <=> $b->_date }
3744 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3745 'pkgnum' => $pkgnum,
3750 =item cust_credit_void
3752 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3756 sub cust_credit_void {
3759 sort { $a->_date <=> $b->_date }
3760 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3765 Returns all the payments (see L<FS::cust_pay>) for this customer.
3771 return $self->num_cust_pay unless wantarray;
3772 sort { $a->_date <=> $b->_date }
3773 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3778 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3779 called automatically when the cust_pay method is used in a scalar context.
3785 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3786 my $sth = dbh->prepare($sql) or die dbh->errstr;
3787 $sth->execute($self->custnum) or die $sth->errstr;
3788 $sth->fetchrow_arrayref->[0];
3791 =item cust_pay_pkgnum
3793 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3794 package when using experimental package balances.
3798 sub cust_pay_pkgnum {
3799 my( $self, $pkgnum ) = @_;
3800 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3801 sort { $a->_date <=> $b->_date }
3802 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3803 'pkgnum' => $pkgnum,
3810 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3816 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3817 sort { $a->_date <=> $b->_date }
3818 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3821 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3823 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3825 Optionally, a list or hashref of additional arguments to the qsearch call can
3830 sub cust_pay_batch {
3832 my $opt = ref($_[0]) ? shift : { @_ };
3834 #return $self->num_cust_statement unless wantarray || keys %$opt;
3836 $opt->{'table'} = 'cust_pay_batch';
3837 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3838 $opt->{'hashref'}{'custnum'} = $self->custnum;
3839 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3841 map { $_ } #behavior of sort undefined in scalar context
3842 sort { $a->paybatchnum <=> $b->paybatchnum }
3846 =item cust_pay_pending
3848 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3849 (without status "done").
3853 sub cust_pay_pending {
3855 return $self->num_cust_pay_pending unless wantarray;
3856 sort { $a->_date <=> $b->_date }
3857 qsearch( 'cust_pay_pending', {
3858 'custnum' => $self->custnum,
3859 'status' => { op=>'!=', value=>'done' },
3864 =item cust_pay_pending_attempt
3866 Returns all payment attempts / declined payments for this customer, as pending
3867 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3868 a corresponding payment (see L<FS::cust_pay>).
3872 sub cust_pay_pending_attempt {
3874 return $self->num_cust_pay_pending_attempt unless wantarray;
3875 sort { $a->_date <=> $b->_date }
3876 qsearch( 'cust_pay_pending', {
3877 'custnum' => $self->custnum,
3884 =item num_cust_pay_pending
3886 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3887 customer (without status "done"). Also called automatically when the
3888 cust_pay_pending method is used in a scalar context.
3892 sub num_cust_pay_pending {
3895 " SELECT COUNT(*) FROM cust_pay_pending ".
3896 " WHERE custnum = ? AND status != 'done' ",
3901 =item num_cust_pay_pending_attempt
3903 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3904 customer, with status "done" but without a corresp. Also called automatically when the
3905 cust_pay_pending method is used in a scalar context.
3909 sub num_cust_pay_pending_attempt {
3912 " SELECT COUNT(*) FROM cust_pay_pending ".
3913 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3920 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3926 map { $_ } #return $self->num_cust_refund unless wantarray;
3927 sort { $a->_date <=> $b->_date }
3928 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3931 =item display_custnum
3933 Returns the displayed customer number for this customer: agent_custid if
3934 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3938 sub display_custnum {
3941 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3942 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3943 if ( $special eq 'CoStAg' ) {
3944 $prefix = uc( join('',
3946 ($self->state =~ /^(..)/),
3947 $prefix || ($self->agent->agent =~ /^(..)/)
3950 elsif ( $special eq 'CoStCl' ) {
3951 $prefix = uc( join('',
3953 ($self->state =~ /^(..)/),
3954 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3957 # add any others here if needed
3960 my $length = $conf->config('cust_main-custnum-display_length');
3961 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3962 return $self->agent_custid;
3963 } elsif ( $prefix ) {
3964 $length = 8 if !defined($length);
3966 sprintf('%0'.$length.'d', $self->custnum)
3967 } elsif ( $length ) {
3968 return sprintf('%0'.$length.'d', $self->custnum);
3970 return $self->custnum;
3976 Returns a name string for this customer, either "Company (Last, First)" or
3983 my $name = $self->contact;
3984 $name = $self->company. " ($name)" if $self->company;
3988 =item service_contact
3990 Returns the L<FS::contact> object for this customer that has the 'Service'
3991 contact class, or undef if there is no such contact. Deprecated; don't use
3996 sub service_contact {
3998 if ( !exists($self->{service_contact}) ) {
3999 my $classnum = $self->scalar_sql(
4000 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4001 ) || 0; #if it's zero, qsearchs will return nothing
4002 $self->{service_contact} = qsearchs('contact', {
4003 'classnum' => $classnum, 'custnum' => $self->custnum
4006 $self->{service_contact};
4011 Returns a name string for this (service/shipping) contact, either
4012 "Company (Last, First)" or "Last, First".
4019 my $name = $self->ship_contact;
4020 $name = $self->company. " ($name)" if $self->company;
4026 Returns a name string for this customer, either "Company" or "First Last".
4032 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4035 =item ship_name_short
4037 Returns a name string for this (service/shipping) contact, either "Company"
4042 sub ship_name_short {
4044 $self->service_contact
4045 ? $self->ship_contact_firstlast
4051 Returns this customer's full (billing) contact name only, "Last, First"
4057 $self->get('last'). ', '. $self->first;
4062 Returns this customer's full (shipping) contact name only, "Last, First"
4068 my $contact = $self->service_contact || $self;
4069 $contact->get('last') . ', ' . $contact->get('first');
4072 =item contact_firstlast
4074 Returns this customers full (billing) contact name only, "First Last".
4078 sub contact_firstlast {
4080 $self->first. ' '. $self->get('last');
4083 =item ship_contact_firstlast
4085 Returns this customer's full (shipping) contact name only, "First Last".
4089 sub ship_contact_firstlast {
4091 my $contact = $self->service_contact || $self;
4092 $contact->get('first') . ' '. $contact->get('last');
4095 #XXX this doesn't work in 3.x+
4098 #Returns this customer's full country name
4104 # code2country($self->country);
4107 sub bill_country_full {
4109 code2country($self->bill_location->country);
4112 sub ship_country_full {
4114 code2country($self->ship_location->country);
4117 =item county_state_county [ PREFIX ]
4119 Returns a string consisting of just the county, state and country.
4123 sub county_state_country {
4126 if ( @_ && $_[0] && $self->has_ship_address ) {
4127 $locationnum = $self->ship_locationnum;
4129 $locationnum = $self->bill_locationnum;
4131 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4132 $cust_location->county_state_country;
4135 =item geocode DATA_VENDOR
4137 Returns a value for the customer location as encoded by DATA_VENDOR.
4138 Currently this only makes sense for "CCH" as DATA_VENDOR.
4146 Returns a status string for this customer, currently:
4150 =item prospect - No packages have ever been ordered
4152 =item ordered - Recurring packages all are new (not yet billed).
4154 =item active - One or more recurring packages is active
4156 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4158 =item suspended - All non-cancelled recurring packages are suspended
4160 =item cancelled - All recurring packages are cancelled
4164 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4165 cust_main-status_module configuration option.
4169 sub status { shift->cust_status(@_); }
4173 for my $status ( FS::cust_main->statuses() ) {
4174 my $method = $status.'_sql';
4175 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4176 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4177 $sth->execute( ($self->custnum) x $numnum )
4178 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4179 return $status if $sth->fetchrow_arrayref->[0];
4183 =item ucfirst_cust_status
4185 =item ucfirst_status
4187 Returns the status with the first character capitalized.
4191 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4193 sub ucfirst_cust_status {
4195 ucfirst($self->cust_status);
4200 Returns a hex triplet color string for this customer's status.
4204 sub statuscolor { shift->cust_statuscolor(@_); }
4206 sub cust_statuscolor {
4208 __PACKAGE__->statuscolors->{$self->cust_status};
4213 Returns an array of hashes representing the customer's RT tickets.
4220 my $num = $conf->config('cust_main-max_tickets') || 10;
4223 if ( $conf->config('ticket_system') ) {
4224 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4226 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4230 foreach my $priority (
4231 $conf->config('ticket_system-custom_priority_field-values'), ''
4233 last if scalar(@tickets) >= $num;
4235 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4236 $num - scalar(@tickets),
4246 # Return services representing svc_accts in customer support packages
4247 sub support_services {
4249 my %packages = map { $_ => 1 } $conf->config('support_packages');
4251 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4252 grep { $_->part_svc->svcdb eq 'svc_acct' }
4253 map { $_->cust_svc }
4254 grep { exists $packages{ $_->pkgpart } }
4255 $self->ncancelled_pkgs;
4259 # Return a list of latitude/longitude for one of the services (if any)
4260 sub service_coordinates {
4264 grep { $_->latitude && $_->longitude }
4266 map { $_->cust_svc }
4267 $self->ncancelled_pkgs;
4269 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4274 Returns a masked version of the named field
4279 my ($self,$field) = @_;
4283 'x'x(length($self->getfield($field))-4).
4284 substr($self->getfield($field), (length($self->getfield($field))-4));
4290 =head1 CLASS METHODS
4296 Class method that returns the list of possible status strings for customers
4297 (see L<the status method|/status>). For example:
4299 @statuses = FS::cust_main->statuses();
4305 keys %{ $self->statuscolors };
4308 =item cust_status_sql
4310 Returns an SQL fragment to determine the status of a cust_main record, as a
4315 sub cust_status_sql {
4317 for my $status ( FS::cust_main->statuses() ) {
4318 my $method = $status.'_sql';
4319 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4328 Returns an SQL expression identifying prospective cust_main records (customers
4329 with no packages ever ordered)
4333 use vars qw($select_count_pkgs);
4334 $select_count_pkgs =
4335 "SELECT COUNT(*) FROM cust_pkg
4336 WHERE cust_pkg.custnum = cust_main.custnum";
4338 sub select_count_pkgs_sql {
4343 " 0 = ( $select_count_pkgs ) ";
4348 Returns an SQL expression identifying ordered cust_main records (customers with
4349 no active packages, but recurring packages not yet setup or one time charges
4355 FS::cust_main->none_active_sql.
4356 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4361 Returns an SQL expression identifying active cust_main records (customers with
4362 active recurring packages).
4367 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4370 =item none_active_sql
4372 Returns an SQL expression identifying cust_main records with no active
4373 recurring packages. This includes customers of status prospect, ordered,
4374 inactive, and suspended.
4378 sub none_active_sql {
4379 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4384 Returns an SQL expression identifying inactive cust_main records (customers with
4385 no active recurring packages, but otherwise unsuspended/uncancelled).
4390 FS::cust_main->none_active_sql.
4391 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4397 Returns an SQL expression identifying suspended cust_main records.
4402 sub suspended_sql { susp_sql(@_); }
4404 FS::cust_main->none_active_sql.
4405 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4411 Returns an SQL expression identifying cancelled cust_main records.
4415 sub cancel_sql { shift->cancelled_sql(@_); }
4418 =item uncancelled_sql
4420 Returns an SQL expression identifying un-cancelled cust_main records.
4424 sub uncancelled_sql { uncancel_sql(@_); }
4425 sub uncancel_sql { "
4426 ( 0 < ( $select_count_pkgs
4427 AND ( cust_pkg.cancel IS NULL
4428 OR cust_pkg.cancel = 0
4431 OR 0 = ( $select_count_pkgs )
4437 Returns an SQL fragment to retreive the balance.
4442 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4443 WHERE cust_bill.custnum = cust_main.custnum )
4444 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4445 WHERE cust_pay.custnum = cust_main.custnum )
4446 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4447 WHERE cust_credit.custnum = cust_main.custnum )
4448 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4449 WHERE cust_refund.custnum = cust_main.custnum )
4452 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4454 Returns an SQL fragment to retreive the balance for this customer, optionally
4455 considering invoices with date earlier than START_TIME, and not
4456 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4457 total_unapplied_payments).
4459 Times are specified as SQL fragments or numeric
4460 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4461 L<Date::Parse> for conversion functions. The empty string can be passed
4462 to disable that time constraint completely.
4464 Available options are:
4468 =item unapplied_date
4470 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)
4475 set to true to remove all customer comparison clauses, for totals
4480 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4485 JOIN clause (typically used with the total option)
4489 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4490 time will be ignored. Note that START_TIME and END_TIME only limit the date
4491 range for invoices and I<unapplied> payments, credits, and refunds.
4497 sub balance_date_sql {
4498 my( $class, $start, $end, %opt ) = @_;
4500 my $cutoff = $opt{'cutoff'};
4502 my $owed = FS::cust_bill->owed_sql($cutoff);
4503 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4504 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4505 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4507 my $j = $opt{'join'} || '';
4509 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4510 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4511 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4512 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4514 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4515 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4516 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4517 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4522 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4524 Returns an SQL fragment to retreive the total unapplied payments for this
4525 customer, only considering payments with date earlier than START_TIME, and
4526 optionally not later than END_TIME.
4528 Times are specified as SQL fragments or numeric
4529 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4530 L<Date::Parse> for conversion functions. The empty string can be passed
4531 to disable that time constraint completely.
4533 Available options are:
4537 sub unapplied_payments_date_sql {
4538 my( $class, $start, $end, %opt ) = @_;
4540 my $cutoff = $opt{'cutoff'};
4542 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4544 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4545 'unapplied_date'=>1 );
4547 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4550 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4552 Helper method for balance_date_sql; name (and usage) subject to change
4553 (suggestions welcome).
4555 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4556 cust_refund, cust_credit or cust_pay).
4558 If TABLE is "cust_bill" or the unapplied_date option is true, only
4559 considers records with date earlier than START_TIME, and optionally not
4560 later than END_TIME .
4564 sub _money_table_where {
4565 my( $class, $table, $start, $end, %opt ) = @_;
4568 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4569 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4570 push @where, "$table._date <= $start" if defined($start) && length($start);
4571 push @where, "$table._date > $end" if defined($end) && length($end);
4573 push @where, @{$opt{'where'}} if $opt{'where'};
4574 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4580 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4581 use FS::cust_main::Search;
4584 FS::cust_main::Search->search(@_);
4599 #warn join('-',keys %$param);
4600 my $fh = $param->{filehandle};
4601 my $agentnum = $param->{agentnum};
4602 my $format = $param->{format};
4604 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4607 if ( $format eq 'simple' ) {
4608 @fields = qw( custnum agent_custid amount pkg );
4610 die "unknown format $format";
4613 eval "use Text::CSV_XS;";
4616 my $csv = new Text::CSV_XS;
4623 local $SIG{HUP} = 'IGNORE';
4624 local $SIG{INT} = 'IGNORE';
4625 local $SIG{QUIT} = 'IGNORE';
4626 local $SIG{TERM} = 'IGNORE';
4627 local $SIG{TSTP} = 'IGNORE';
4628 local $SIG{PIPE} = 'IGNORE';
4630 my $oldAutoCommit = $FS::UID::AutoCommit;
4631 local $FS::UID::AutoCommit = 0;
4634 #while ( $columns = $csv->getline($fh) ) {
4636 while ( defined($line=<$fh>) ) {
4638 $csv->parse($line) or do {
4639 $dbh->rollback if $oldAutoCommit;
4640 return "can't parse: ". $csv->error_input();
4643 my @columns = $csv->fields();
4644 #warn join('-',@columns);
4647 foreach my $field ( @fields ) {
4648 $row{$field} = shift @columns;
4651 if ( $row{custnum} && $row{agent_custid} ) {
4652 dbh->rollback if $oldAutoCommit;
4653 return "can't specify custnum with agent_custid $row{agent_custid}";
4657 if ( $row{agent_custid} && $agentnum ) {
4658 %hash = ( 'agent_custid' => $row{agent_custid},
4659 'agentnum' => $agentnum,
4663 if ( $row{custnum} ) {
4664 %hash = ( 'custnum' => $row{custnum} );
4667 unless ( scalar(keys %hash) ) {
4668 $dbh->rollback if $oldAutoCommit;
4669 return "can't find customer without custnum or agent_custid and agentnum";
4672 my $cust_main = qsearchs('cust_main', { %hash } );
4673 unless ( $cust_main ) {
4674 $dbh->rollback if $oldAutoCommit;
4675 my $custnum = $row{custnum} || $row{agent_custid};
4676 return "unknown custnum $custnum";
4679 if ( $row{'amount'} > 0 ) {
4680 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4682 $dbh->rollback if $oldAutoCommit;
4686 } elsif ( $row{'amount'} < 0 ) {
4687 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4690 $dbh->rollback if $oldAutoCommit;
4700 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4702 return "Empty file!" unless $imported;
4708 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4710 Deprecated. Use event notification and message templates
4711 (L<FS::msg_template>) instead.
4713 Sends a templated email notification to the customer (see L<Text::Template>).
4715 OPTIONS is a hash and may include
4717 I<from> - the email sender (default is invoice_from)
4719 I<to> - comma-separated scalar or arrayref of recipients
4720 (default is invoicing_list)
4722 I<subject> - The subject line of the sent email notification
4723 (default is "Notice from company_name")
4725 I<extra_fields> - a hashref of name/value pairs which will be substituted
4728 The following variables are vavailable in the template.
4730 I<$first> - the customer first name
4731 I<$last> - the customer last name
4732 I<$company> - the customer company
4733 I<$payby> - a description of the method of payment for the customer
4734 # would be nice to use FS::payby::shortname
4735 I<$payinfo> - the account information used to collect for this customer
4736 I<$expdate> - the expiration of the customer payment in seconds from epoch
4741 my ($self, $template, %options) = @_;
4743 return unless $conf->exists($template);
4745 my $from = $conf->config('invoice_from', $self->agentnum)
4746 if $conf->exists('invoice_from', $self->agentnum);
4747 $from = $options{from} if exists($options{from});
4749 my $to = join(',', $self->invoicing_list_emailonly);
4750 $to = $options{to} if exists($options{to});
4752 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4753 if $conf->exists('company_name', $self->agentnum);
4754 $subject = $options{subject} if exists($options{subject});
4756 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4757 SOURCE => [ map "$_\n",
4758 $conf->config($template)]
4760 or die "can't create new Text::Template object: Text::Template::ERROR";
4761 $notify_template->compile()
4762 or die "can't compile template: Text::Template::ERROR";
4764 $FS::notify_template::_template::company_name =
4765 $conf->config('company_name', $self->agentnum);
4766 $FS::notify_template::_template::company_address =
4767 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4769 my $paydate = $self->paydate || '2037-12-31';
4770 $FS::notify_template::_template::first = $self->first;
4771 $FS::notify_template::_template::last = $self->last;
4772 $FS::notify_template::_template::company = $self->company;
4773 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4774 my $payby = $self->payby;
4775 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4776 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4778 #credit cards expire at the end of the month/year of their exp date
4779 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4780 $FS::notify_template::_template::payby = 'credit card';
4781 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4782 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4784 }elsif ($payby eq 'COMP') {
4785 $FS::notify_template::_template::payby = 'complimentary account';
4787 $FS::notify_template::_template::payby = 'current method';
4789 $FS::notify_template::_template::expdate = $expire_time;
4791 for (keys %{$options{extra_fields}}){
4793 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4796 send_email(from => $from,
4798 subject => $subject,
4799 body => $notify_template->fill_in( PACKAGE =>
4800 'FS::notify_template::_template' ),
4805 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4807 Generates a templated notification to the customer (see L<Text::Template>).
4809 OPTIONS is a hash and may include
4811 I<extra_fields> - a hashref of name/value pairs which will be substituted
4812 into the template. These values may override values mentioned below
4813 and those from the customer record.
4815 The following variables are available in the template instead of or in addition
4816 to the fields of the customer record.
4818 I<$payby> - a description of the method of payment for the customer
4819 # would be nice to use FS::payby::shortname
4820 I<$payinfo> - the masked account information used to collect for this customer
4821 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4822 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4826 # a lot like cust_bill::print_latex
4827 sub generate_letter {
4828 my ($self, $template, %options) = @_;
4830 return unless $conf->exists($template);
4832 my $letter_template = new Text::Template
4834 SOURCE => [ map "$_\n", $conf->config($template)],
4835 DELIMITERS => [ '[@--', '--@]' ],
4837 or die "can't create new Text::Template object: Text::Template::ERROR";
4839 $letter_template->compile()
4840 or die "can't compile template: Text::Template::ERROR";
4842 my %letter_data = map { $_ => $self->$_ } $self->fields;
4843 $letter_data{payinfo} = $self->mask_payinfo;
4845 #my $paydate = $self->paydate || '2037-12-31';
4846 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4848 my $payby = $self->payby;
4849 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4850 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4852 #credit cards expire at the end of the month/year of their exp date
4853 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4854 $letter_data{payby} = 'credit card';
4855 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4856 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4858 }elsif ($payby eq 'COMP') {
4859 $letter_data{payby} = 'complimentary account';
4861 $letter_data{payby} = 'current method';
4863 $letter_data{expdate} = $expire_time;
4865 for (keys %{$options{extra_fields}}){
4866 $letter_data{$_} = $options{extra_fields}->{$_};
4869 unless(exists($letter_data{returnaddress})){
4870 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4871 $self->agent_template)
4873 if ( length($retadd) ) {
4874 $letter_data{returnaddress} = $retadd;
4875 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4876 $letter_data{returnaddress} =
4877 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4881 ( $conf->config('company_name', $self->agentnum),
4882 $conf->config('company_address', $self->agentnum),
4886 $letter_data{returnaddress} = '~';
4890 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4892 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4894 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4896 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4900 ) or die "can't open temp file: $!\n";
4901 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4902 or die "can't write temp file: $!\n";
4904 $letter_data{'logo_file'} = $lh->filename;
4906 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4910 ) or die "can't open temp file: $!\n";
4912 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4914 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4915 return ($1, $letter_data{'logo_file'});
4919 =item print_ps TEMPLATE
4921 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4927 my($file, $lfile) = $self->generate_letter(@_);
4928 my $ps = FS::Misc::generate_ps($file);
4929 unlink($file.'.tex');
4935 =item print TEMPLATE
4937 Prints the filled in template.
4939 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4943 sub queueable_print {
4946 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4947 or die "invalid customer number: " . $opt{custnum};
4949 my $error = $self->print( { 'template' => $opt{template} } );
4950 die $error if $error;
4954 my ($self, $template) = (shift, shift);
4956 [ $self->print_ps($template) ],
4957 'agentnum' => $self->agentnum,
4961 #these three subs should just go away once agent stuff is all config overrides
4963 sub agent_template {
4965 $self->_agent_plandata('agent_templatename');
4968 sub agent_invoice_from {
4970 $self->_agent_plandata('agent_invoice_from');
4973 sub _agent_plandata {
4974 my( $self, $option ) = @_;
4976 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4977 #agent-specific Conf
4979 use FS::part_event::Condition;
4981 my $agentnum = $self->agentnum;
4983 my $regexp = regexp_sql();
4985 my $part_event_option =
4987 'select' => 'part_event_option.*',
4988 'table' => 'part_event_option',
4990 LEFT JOIN part_event USING ( eventpart )
4991 LEFT JOIN part_event_option AS peo_agentnum
4992 ON ( part_event.eventpart = peo_agentnum.eventpart
4993 AND peo_agentnum.optionname = 'agentnum'
4994 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4996 LEFT JOIN part_event_condition
4997 ON ( part_event.eventpart = part_event_condition.eventpart
4998 AND part_event_condition.conditionname = 'cust_bill_age'
5000 LEFT JOIN part_event_condition_option
5001 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5002 AND part_event_condition_option.optionname = 'age'
5005 #'hashref' => { 'optionname' => $option },
5006 #'hashref' => { 'part_event_option.optionname' => $option },
5008 " WHERE part_event_option.optionname = ". dbh->quote($option).
5009 " AND action = 'cust_bill_send_agent' ".
5010 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5011 " AND peo_agentnum.optionname = 'agentnum' ".
5012 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5014 CASE WHEN part_event_condition_option.optionname IS NULL
5016 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5018 , part_event.weight".
5022 unless ( $part_event_option ) {
5023 return $self->agent->invoice_template || ''
5024 if $option eq 'agent_templatename';
5028 $part_event_option->optionvalue;
5032 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5034 Subroutine (not a method), designed to be called from the queue.
5036 Takes a list of options and values.
5038 Pulls up the customer record via the custnum option and calls bill_and_collect.
5043 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5045 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5046 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5048 $cust_main->bill_and_collect( %args );
5051 sub process_bill_and_collect {
5053 my $param = thaw(decode_base64(shift));
5054 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5055 or die "custnum '$param->{custnum}' not found!\n";
5056 $param->{'job'} = $job;
5057 $param->{'fatal'} = 1; # runs from job queue, will be caught
5058 $param->{'retry'} = 1;
5060 $cust_main->bill_and_collect( %$param );
5063 #starting to take quite a while for big dbs
5064 # (JRNL: journaled so it only happens once per database)
5065 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5066 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5067 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5068 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5069 # JRNL leading/trailing spaces in first, last, company
5070 # - otaker upgrade? journal and call it good? (double check to make sure
5071 # we're not still setting otaker here)
5073 #only going to get worse with new location stuff...
5075 sub _upgrade_data { #class method
5076 my ($class, %opts) = @_;
5079 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5082 #this seems to be the only expensive one.. why does it take so long?
5083 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5085 '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';
5086 FS::upgrade_journal->set_done('cust_main__signupdate');
5089 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5091 # fix yyyy-m-dd formatted paydates
5092 if ( driver_name =~ /^mysql/i ) {
5094 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5095 } else { # the SQL standard
5097 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5099 FS::upgrade_journal->set_done('cust_main__paydate');
5102 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5104 push @statements, #fix the weird BILL with a cc# in payinfo problem
5106 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5108 FS::upgrade_journal->set_done('cust_main__payinfo');
5113 foreach my $sql ( @statements ) {
5114 my $sth = dbh->prepare($sql) or die dbh->errstr;
5115 $sth->execute or die $sth->errstr;
5116 #warn ( (time - $t). " seconds\n" );
5120 local($ignore_expired_card) = 1;
5121 local($ignore_banned_card) = 1;
5122 local($skip_fuzzyfiles) = 1;
5123 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5125 FS::cust_main::Location->_upgrade_data(%opts);
5127 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5129 foreach my $cust_main ( qsearch({
5130 'table' => 'cust_main',
5132 'extra_sql' => 'WHERE '.
5134 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5135 qw( first last company )
5138 my $error = $cust_main->replace;
5139 die $error if $error;
5142 FS::upgrade_journal->set_done('cust_main__trimspaces');
5146 $class->_upgrade_otaker(%opts);
5156 The delete method should possibly take an FS::cust_main object reference
5157 instead of a scalar customer number.
5159 Bill and collect options should probably be passed as references instead of a
5162 There should probably be a configuration file with a list of allowed credit
5165 No multiple currency support (probably a larger project than just this module).
5167 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5169 Birthdates rely on negative epoch values.
5171 The payby for card/check batches is broken. With mixed batching, bad
5174 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5178 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5179 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5180 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.