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') );
2046 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2047 $self->payname =~ /^([\w \,\.\-\']*)$/
2048 or return gettext('illegal_name'). " payname: ". $self->payname;
2051 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2052 or return gettext('illegal_name'). " payname: ". $self->payname;
2058 return "Please select an invoicing locale"
2061 && $conf->exists('cust_main-require_locale');
2063 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2064 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2068 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2070 warn "$me check AFTER: \n". $self->_dump
2073 $self->SUPER::check;
2078 Returns a list of fields which have ship_ duplicates.
2083 qw( last first company
2084 address1 address2 city county state zip country
2086 daytime night fax mobile
2090 =item has_ship_address
2092 Returns true if this customer record has a separate shipping address.
2096 sub has_ship_address {
2098 $self->bill_locationnum != $self->ship_locationnum;
2103 Returns a list of key/value pairs, with the following keys: address1,
2104 adddress2, city, county, state, zip, country, district, and geocode. The
2105 shipping address is used if present.
2111 $self->ship_location->location_hash;
2116 Returns all locations (see L<FS::cust_location>) for this customer.
2122 qsearch('cust_location', { 'custnum' => $self->custnum,
2123 'prospectnum' => '' } );
2128 Returns all contacts (see L<FS::contact>) for this customer.
2132 #already used :/ sub contact {
2135 qsearch('contact', { 'custnum' => $self->custnum } );
2140 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2141 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2142 on success or a list of errors.
2148 grep { $_->unsuspend } $self->suspended_pkgs;
2153 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2155 Returns a list: an empty list on success or a list of errors.
2161 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2164 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2166 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2167 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2168 of a list of pkgparts; the hashref has the following keys:
2172 =item pkgparts - listref of pkgparts
2174 =item (other options are passed to the suspend method)
2179 Returns a list: an empty list on success or a list of errors.
2183 sub suspend_if_pkgpart {
2185 my (@pkgparts, %opt);
2186 if (ref($_[0]) eq 'HASH'){
2187 @pkgparts = @{$_[0]{pkgparts}};
2192 grep { $_->suspend(%opt) }
2193 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2194 $self->unsuspended_pkgs;
2197 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2199 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2200 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2201 instead of a list of pkgparts; the hashref has the following keys:
2205 =item pkgparts - listref of pkgparts
2207 =item (other options are passed to the suspend method)
2211 Returns a list: an empty list on success or a list of errors.
2215 sub suspend_unless_pkgpart {
2217 my (@pkgparts, %opt);
2218 if (ref($_[0]) eq 'HASH'){
2219 @pkgparts = @{$_[0]{pkgparts}};
2224 grep { $_->suspend(%opt) }
2225 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2226 $self->unsuspended_pkgs;
2229 =item cancel [ OPTION => VALUE ... ]
2231 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2233 Available options are:
2237 =item quiet - can be set true to supress email cancellation notices.
2239 =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.
2241 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2243 =item nobill - can be set true to skip billing if it might otherwise be done.
2247 Always returns a list: an empty list on success or a list of errors.
2251 # nb that dates are not specified as valid options to this method
2254 my( $self, %opt ) = @_;
2256 warn "$me cancel called on customer ". $self->custnum. " with options ".
2257 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2260 return ( 'access denied' )
2261 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2263 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2265 #should try decryption (we might have the private key)
2266 # and if not maybe queue a job for the server that does?
2267 return ( "Can't (yet) ban encrypted credit cards" )
2268 if $self->is_encrypted($self->payinfo);
2270 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2271 my $error = $ban->insert;
2272 return ( $error ) if $error;
2276 my @pkgs = $self->ncancelled_pkgs;
2278 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2280 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2281 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2285 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2286 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2289 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2292 sub _banned_pay_hashref {
2303 'payby' => $payby2ban{$self->payby},
2304 'payinfo' => $self->payinfo,
2305 #don't ever *search* on reason! #'reason' =>
2309 sub _new_banned_pay_hashref {
2311 my $hr = $self->_banned_pay_hashref;
2312 $hr->{payinfo} = md5_base64($hr->{payinfo});
2318 Returns all notes (see L<FS::cust_main_note>) for this customer.
2323 my($self,$orderby_classnum) = (shift,shift);
2324 my $orderby = "_DATE DESC";
2325 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2326 qsearch( 'cust_main_note',
2327 { 'custnum' => $self->custnum },
2329 "ORDER BY $orderby",
2335 Returns the agent (see L<FS::agent>) for this customer.
2341 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2346 Returns the agent name (see L<FS::agent>) for this customer.
2352 $self->agent->agent;
2357 Returns any tags associated with this customer, as FS::cust_tag objects,
2358 or an empty list if there are no tags.
2364 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2369 Returns any tags associated with this customer, as FS::part_tag objects,
2370 or an empty list if there are no tags.
2376 map $_->part_tag, $self->cust_tag;
2382 Returns the customer class, as an FS::cust_class object, or the empty string
2383 if there is no customer class.
2389 if ( $self->classnum ) {
2390 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2398 Returns the customer category name, or the empty string if there is no customer
2405 my $cust_class = $self->cust_class;
2407 ? $cust_class->categoryname
2413 Returns the customer class name, or the empty string if there is no customer
2420 my $cust_class = $self->cust_class;
2422 ? $cust_class->classname
2426 =item BILLING METHODS
2428 Documentation on billing methods has been moved to
2429 L<FS::cust_main::Billing>.
2431 =item REALTIME BILLING METHODS
2433 Documentation on realtime billing methods has been moved to
2434 L<FS::cust_main::Billing_Realtime>.
2438 Removes the I<paycvv> field from the database directly.
2440 If there is an error, returns the error, otherwise returns false.
2446 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2447 or return dbh->errstr;
2448 $sth->execute($self->custnum)
2449 or return $sth->errstr;
2454 =item batch_card OPTION => VALUE...
2456 Adds a payment for this invoice to the pending credit card batch (see
2457 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2458 runs the payment using a realtime gateway.
2460 Options may include:
2462 B<amount>: the amount to be paid; defaults to the customer's balance minus
2463 any payments in transit.
2465 B<payby>: the payment method; defaults to cust_main.payby
2467 B<realtime>: runs this as a realtime payment instead of adding it to a
2470 B<invnum>: sets cust_pay_batch.invnum.
2472 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2473 the billing address for the payment; defaults to the customer's billing
2476 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2477 date, and name; defaults to those fields in cust_main.
2482 my ($self, %options) = @_;
2485 if (exists($options{amount})) {
2486 $amount = $options{amount};
2488 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2490 return '' unless $amount > 0;
2492 my $invnum = delete $options{invnum};
2493 my $payby = $options{payby} || $self->payby; #still dubious
2495 if ($options{'realtime'}) {
2496 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2502 my $oldAutoCommit = $FS::UID::AutoCommit;
2503 local $FS::UID::AutoCommit = 0;
2506 #this needs to handle mysql as well as Pg, like svc_acct.pm
2507 #(make it into a common function if folks need to do batching with mysql)
2508 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2509 or return "Cannot lock pay_batch: " . $dbh->errstr;
2513 'payby' => FS::payby->payby2payment($payby),
2515 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2517 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2519 unless ( $pay_batch ) {
2520 $pay_batch = new FS::pay_batch \%pay_batch;
2521 my $error = $pay_batch->insert;
2523 $dbh->rollback if $oldAutoCommit;
2524 die "error creating new batch: $error\n";
2528 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2529 'batchnum' => $pay_batch->batchnum,
2530 'custnum' => $self->custnum,
2533 foreach (qw( address1 address2 city state zip country latitude longitude
2534 payby payinfo paydate payname ))
2536 $options{$_} = '' unless exists($options{$_});
2539 my $loc = $self->bill_location;
2541 my $cust_pay_batch = new FS::cust_pay_batch ( {
2542 'batchnum' => $pay_batch->batchnum,
2543 'invnum' => $invnum || 0, # is there a better value?
2544 # this field should be
2546 # cust_bill_pay_batch now
2547 'custnum' => $self->custnum,
2548 'last' => $self->getfield('last'),
2549 'first' => $self->getfield('first'),
2550 'address1' => $options{address1} || $loc->address1,
2551 'address2' => $options{address2} || $loc->address2,
2552 'city' => $options{city} || $loc->city,
2553 'state' => $options{state} || $loc->state,
2554 'zip' => $options{zip} || $loc->zip,
2555 'country' => $options{country} || $loc->country,
2556 'payby' => $options{payby} || $self->payby,
2557 'payinfo' => $options{payinfo} || $self->payinfo,
2558 'exp' => $options{paydate} || $self->paydate,
2559 'payname' => $options{payname} || $self->payname,
2560 'amount' => $amount, # consolidating
2563 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2564 if $old_cust_pay_batch;
2567 if ($old_cust_pay_batch) {
2568 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2570 $error = $cust_pay_batch->insert;
2574 $dbh->rollback if $oldAutoCommit;
2578 my $unapplied = $self->total_unapplied_credits
2579 + $self->total_unapplied_payments
2580 + $self->in_transit_payments;
2581 foreach my $cust_bill ($self->open_cust_bill) {
2582 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2583 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2584 'invnum' => $cust_bill->invnum,
2585 'paybatchnum' => $cust_pay_batch->paybatchnum,
2586 'amount' => $cust_bill->owed,
2589 if ($unapplied >= $cust_bill_pay_batch->amount){
2590 $unapplied -= $cust_bill_pay_batch->amount;
2593 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2594 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2596 $error = $cust_bill_pay_batch->insert;
2598 $dbh->rollback if $oldAutoCommit;
2603 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2609 Returns the total owed for this customer on all invoices
2610 (see L<FS::cust_bill/owed>).
2616 $self->total_owed_date(2145859200); #12/31/2037
2619 =item total_owed_date TIME
2621 Returns the total owed for this customer on all invoices with date earlier than
2622 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2623 see L<Time::Local> and L<Date::Parse> for conversion functions.
2627 sub total_owed_date {
2631 my $custnum = $self->custnum;
2633 my $owed_sql = FS::cust_bill->owed_sql;
2636 SELECT SUM($owed_sql) FROM cust_bill
2637 WHERE custnum = $custnum
2641 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2645 =item total_owed_pkgnum PKGNUM
2647 Returns the total owed on all invoices for this customer's specific package
2648 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2652 sub total_owed_pkgnum {
2653 my( $self, $pkgnum ) = @_;
2654 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2657 =item total_owed_date_pkgnum TIME PKGNUM
2659 Returns the total owed for this customer's specific package when using
2660 experimental package balances on all invoices with date earlier than
2661 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2662 see L<Time::Local> and L<Date::Parse> for conversion functions.
2666 sub total_owed_date_pkgnum {
2667 my( $self, $time, $pkgnum ) = @_;
2670 foreach my $cust_bill (
2671 grep { $_->_date <= $time }
2672 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2674 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2676 sprintf( "%.2f", $total_bill );
2682 Returns the total amount of all payments.
2689 $total += $_->paid foreach $self->cust_pay;
2690 sprintf( "%.2f", $total );
2693 =item total_unapplied_credits
2695 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2696 customer. See L<FS::cust_credit/credited>.
2698 =item total_credited
2700 Old name for total_unapplied_credits. Don't use.
2704 sub total_credited {
2705 #carp "total_credited deprecated, use total_unapplied_credits";
2706 shift->total_unapplied_credits(@_);
2709 sub total_unapplied_credits {
2712 my $custnum = $self->custnum;
2714 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2717 SELECT SUM($unapplied_sql) FROM cust_credit
2718 WHERE custnum = $custnum
2721 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2725 =item total_unapplied_credits_pkgnum PKGNUM
2727 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2728 customer. See L<FS::cust_credit/credited>.
2732 sub total_unapplied_credits_pkgnum {
2733 my( $self, $pkgnum ) = @_;
2734 my $total_credit = 0;
2735 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2736 sprintf( "%.2f", $total_credit );
2740 =item total_unapplied_payments
2742 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2743 See L<FS::cust_pay/unapplied>.
2747 sub total_unapplied_payments {
2750 my $custnum = $self->custnum;
2752 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2755 SELECT SUM($unapplied_sql) FROM cust_pay
2756 WHERE custnum = $custnum
2759 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2763 =item total_unapplied_payments_pkgnum PKGNUM
2765 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2766 specific package when using experimental package balances. See
2767 L<FS::cust_pay/unapplied>.
2771 sub total_unapplied_payments_pkgnum {
2772 my( $self, $pkgnum ) = @_;
2773 my $total_unapplied = 0;
2774 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2775 sprintf( "%.2f", $total_unapplied );
2779 =item total_unapplied_refunds
2781 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2782 customer. See L<FS::cust_refund/unapplied>.
2786 sub total_unapplied_refunds {
2788 my $custnum = $self->custnum;
2790 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2793 SELECT SUM($unapplied_sql) FROM cust_refund
2794 WHERE custnum = $custnum
2797 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2803 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2804 total_unapplied_credits minus total_unapplied_payments).
2810 $self->balance_date_range;
2813 =item balance_date TIME
2815 Returns the balance for this customer, only considering invoices with date
2816 earlier than TIME (total_owed_date minus total_credited minus
2817 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2818 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2825 $self->balance_date_range(shift);
2828 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2830 Returns the balance for this customer, optionally considering invoices with
2831 date earlier than START_TIME, and not later than END_TIME
2832 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2834 Times are specified as SQL fragments or numeric
2835 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2836 L<Date::Parse> for conversion functions. The empty string can be passed
2837 to disable that time constraint completely.
2839 Available options are:
2843 =item unapplied_date
2845 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)
2851 sub balance_date_range {
2853 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2854 ') FROM cust_main WHERE custnum='. $self->custnum;
2855 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2858 =item balance_pkgnum PKGNUM
2860 Returns the balance for this customer's specific package when using
2861 experimental package balances (total_owed plus total_unrefunded, minus
2862 total_unapplied_credits minus total_unapplied_payments)
2866 sub balance_pkgnum {
2867 my( $self, $pkgnum ) = @_;
2870 $self->total_owed_pkgnum($pkgnum)
2871 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2872 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2873 - $self->total_unapplied_credits_pkgnum($pkgnum)
2874 - $self->total_unapplied_payments_pkgnum($pkgnum)
2878 =item in_transit_payments
2880 Returns the total of requests for payments for this customer pending in
2881 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2885 sub in_transit_payments {
2887 my $in_transit_payments = 0;
2888 foreach my $pay_batch ( qsearch('pay_batch', {
2891 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2892 'batchnum' => $pay_batch->batchnum,
2893 'custnum' => $self->custnum,
2895 $in_transit_payments += $cust_pay_batch->amount;
2898 sprintf( "%.2f", $in_transit_payments );
2903 Returns a hash of useful information for making a payment.
2913 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2914 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2915 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2919 For credit card transactions:
2931 For electronic check transactions:
2946 $return{balance} = $self->balance;
2948 $return{payname} = $self->payname
2949 || ( $self->first. ' '. $self->get('last') );
2951 $return{$_} = $self->bill_location->$_
2952 for qw(address1 address2 city state zip);
2954 $return{payby} = $self->payby;
2955 $return{stateid_state} = $self->stateid_state;
2957 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2958 $return{card_type} = cardtype($self->payinfo);
2959 $return{payinfo} = $self->paymask;
2961 @return{'month', 'year'} = $self->paydate_monthyear;
2965 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2966 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2967 $return{payinfo1} = $payinfo1;
2968 $return{payinfo2} = $payinfo2;
2969 $return{paytype} = $self->paytype;
2970 $return{paystate} = $self->paystate;
2974 #doubleclick protection
2976 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2982 =item paydate_monthyear
2984 Returns a two-element list consisting of the month and year of this customer's
2985 paydate (credit card expiration date for CARD customers)
2989 sub paydate_monthyear {
2991 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2993 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3002 Returns the exact time in seconds corresponding to the payment method
3003 expiration date. For CARD/DCRD customers this is the end of the month;
3004 for others (COMP is the only other payby that uses paydate) it's the start.
3005 Returns 0 if the paydate is empty or set to the far future.
3011 my ($month, $year) = $self->paydate_monthyear;
3012 return 0 if !$year or $year >= 2037;
3013 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3015 if ( $month == 13 ) {
3019 return timelocal(0,0,0,1,$month-1,$year) - 1;
3022 return timelocal(0,0,0,1,$month-1,$year);
3026 =item paydate_epoch_sql
3028 Class method. Returns an SQL expression to obtain the payment expiration date
3029 as a number of seconds.
3033 # Special expiration date behavior for non-CARD/DCRD customers has been
3034 # carefully preserved. Do we really use that?
3035 sub paydate_epoch_sql {
3037 my $table = shift || 'cust_main';
3038 my ($case1, $case2);
3039 if ( driver_name eq 'Pg' ) {
3040 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3041 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3043 elsif ( lc(driver_name) eq 'mysql' ) {
3044 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3045 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3048 return "CASE WHEN $table.payby IN('CARD','DCRD')
3054 =item tax_exemption TAXNAME
3059 my( $self, $taxname ) = @_;
3061 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3062 'taxname' => $taxname,
3067 =item cust_main_exemption
3071 sub cust_main_exemption {
3073 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3076 =item invoicing_list [ ARRAYREF ]
3078 If an arguement is given, sets these email addresses as invoice recipients
3079 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3080 (except as warnings), so use check_invoicing_list first.
3082 Returns a list of email addresses (with svcnum entries expanded).
3084 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3085 check it without disturbing anything by passing nothing.
3087 This interface may change in the future.
3091 sub invoicing_list {
3092 my( $self, $arrayref ) = @_;
3095 my @cust_main_invoice;
3096 if ( $self->custnum ) {
3097 @cust_main_invoice =
3098 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3100 @cust_main_invoice = ();
3102 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3103 #warn $cust_main_invoice->destnum;
3104 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3105 #warn $cust_main_invoice->destnum;
3106 my $error = $cust_main_invoice->delete;
3107 warn $error if $error;
3110 if ( $self->custnum ) {
3111 @cust_main_invoice =
3112 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3114 @cust_main_invoice = ();
3116 my %seen = map { $_->address => 1 } @cust_main_invoice;
3117 foreach my $address ( @{$arrayref} ) {
3118 next if exists $seen{$address} && $seen{$address};
3119 $seen{$address} = 1;
3120 my $cust_main_invoice = new FS::cust_main_invoice ( {
3121 'custnum' => $self->custnum,
3124 my $error = $cust_main_invoice->insert;
3125 warn $error if $error;
3129 if ( $self->custnum ) {
3131 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3138 =item check_invoicing_list ARRAYREF
3140 Checks these arguements as valid input for the invoicing_list method. If there
3141 is an error, returns the error, otherwise returns false.
3145 sub check_invoicing_list {
3146 my( $self, $arrayref ) = @_;
3148 foreach my $address ( @$arrayref ) {
3150 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3151 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3154 my $cust_main_invoice = new FS::cust_main_invoice ( {
3155 'custnum' => $self->custnum,
3158 my $error = $self->custnum
3159 ? $cust_main_invoice->check
3160 : $cust_main_invoice->checkdest
3162 return $error if $error;
3166 return "Email address required"
3167 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3168 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3173 =item set_default_invoicing_list
3175 Sets the invoicing list to all accounts associated with this customer,
3176 overwriting any previous invoicing list.
3180 sub set_default_invoicing_list {
3182 $self->invoicing_list($self->all_emails);
3187 Returns the email addresses of all accounts provisioned for this customer.
3194 foreach my $cust_pkg ( $self->all_pkgs ) {
3195 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3197 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3198 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3200 $list{$_}=1 foreach map { $_->email } @svc_acct;
3205 =item invoicing_list_addpost
3207 Adds postal invoicing to this customer. If this customer is already configured
3208 to receive postal invoices, does nothing.
3212 sub invoicing_list_addpost {
3214 return if grep { $_ eq 'POST' } $self->invoicing_list;
3215 my @invoicing_list = $self->invoicing_list;
3216 push @invoicing_list, 'POST';
3217 $self->invoicing_list(\@invoicing_list);
3220 =item invoicing_list_emailonly
3222 Returns the list of email invoice recipients (invoicing_list without non-email
3223 destinations such as POST and FAX).
3227 sub invoicing_list_emailonly {
3229 warn "$me invoicing_list_emailonly called"
3231 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3234 =item invoicing_list_emailonly_scalar
3236 Returns the list of email invoice recipients (invoicing_list without non-email
3237 destinations such as POST and FAX) as a comma-separated scalar.
3241 sub invoicing_list_emailonly_scalar {
3243 warn "$me invoicing_list_emailonly_scalar called"
3245 join(', ', $self->invoicing_list_emailonly);
3248 =item referral_custnum_cust_main
3250 Returns the customer who referred this customer (or the empty string, if
3251 this customer was not referred).
3253 Note the difference with referral_cust_main method: This method,
3254 referral_custnum_cust_main returns the single customer (if any) who referred
3255 this customer, while referral_cust_main returns an array of customers referred
3260 sub referral_custnum_cust_main {
3262 return '' unless $self->referral_custnum;
3263 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3266 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3268 Returns an array of customers referred by this customer (referral_custnum set
3269 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3270 customers referred by customers referred by this customer and so on, inclusive.
3271 The default behavior is DEPTH 1 (no recursion).
3273 Note the difference with referral_custnum_cust_main method: This method,
3274 referral_cust_main, returns an array of customers referred BY this customer,
3275 while referral_custnum_cust_main returns the single customer (if any) who
3276 referred this customer.
3280 sub referral_cust_main {
3282 my $depth = @_ ? shift : 1;
3283 my $exclude = @_ ? shift : {};
3286 map { $exclude->{$_->custnum}++; $_; }
3287 grep { ! $exclude->{ $_->custnum } }
3288 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3292 map { $_->referral_cust_main($depth-1, $exclude) }
3299 =item referral_cust_main_ncancelled
3301 Same as referral_cust_main, except only returns customers with uncancelled
3306 sub referral_cust_main_ncancelled {
3308 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3311 =item referral_cust_pkg [ DEPTH ]
3313 Like referral_cust_main, except returns a flat list of all unsuspended (and
3314 uncancelled) packages for each customer. The number of items in this list may
3315 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3319 sub referral_cust_pkg {
3321 my $depth = @_ ? shift : 1;
3323 map { $_->unsuspended_pkgs }
3324 grep { $_->unsuspended_pkgs }
3325 $self->referral_cust_main($depth);
3328 =item referring_cust_main
3330 Returns the single cust_main record for the customer who referred this customer
3331 (referral_custnum), or false.
3335 sub referring_cust_main {
3337 return '' unless $self->referral_custnum;
3338 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3341 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3343 Applies a credit to this customer. If there is an error, returns the error,
3344 otherwise returns false.
3346 REASON can be a text string, an FS::reason object, or a scalar reference to
3347 a reasonnum. If a text string, it will be automatically inserted as a new
3348 reason, and a 'reason_type' option must be passed to indicate the
3349 FS::reason_type for the new reason.
3351 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3352 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3353 I<commission_pkgnum>.
3355 Any other options are passed to FS::cust_credit::insert.
3360 my( $self, $amount, $reason, %options ) = @_;
3362 my $cust_credit = new FS::cust_credit {
3363 'custnum' => $self->custnum,
3364 'amount' => $amount,
3367 if ( ref($reason) ) {
3369 if ( ref($reason) eq 'SCALAR' ) {
3370 $cust_credit->reasonnum( $$reason );
3372 $cust_credit->reasonnum( $reason->reasonnum );
3376 $cust_credit->set('reason', $reason)
3379 $cust_credit->$_( delete $options{$_} )
3380 foreach grep exists($options{$_}),
3381 qw( addlinfo eventnum ),
3382 map "commission_$_", qw( agentnum salesnum pkgnum );
3384 $cust_credit->insert(%options);
3388 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3390 Creates a one-time charge for this customer. If there is an error, returns
3391 the error, otherwise returns false.
3393 New-style, with a hashref of options:
3395 my $error = $cust_main->charge(
3399 'start_date' => str2time('7/4/2009'),
3400 'pkg' => 'Description',
3401 'comment' => 'Comment',
3402 'additional' => [], #extra invoice detail
3403 'classnum' => 1, #pkg_class
3405 'setuptax' => '', # or 'Y' for tax exempt
3407 'locationnum'=> 1234, # optional
3410 'taxclass' => 'Tax class',
3413 'taxproduct' => 2, #part_pkg_taxproduct
3414 'override' => {}, #XXX describe
3416 #will be filled in with the new object
3417 'cust_pkg_ref' => \$cust_pkg,
3419 #generate an invoice immediately
3421 'invoice_terms' => '', #with these terms
3427 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3433 my ( $amount, $quantity, $start_date, $classnum );
3434 my ( $pkg, $comment, $additional );
3435 my ( $setuptax, $taxclass ); #internal taxes
3436 my ( $taxproduct, $override ); #vendor (CCH) taxes
3438 my $cust_pkg_ref = '';
3439 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3441 if ( ref( $_[0] ) ) {
3442 $amount = $_[0]->{amount};
3443 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3444 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3445 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3446 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3447 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3448 : '$'. sprintf("%.2f",$amount);
3449 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3450 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3451 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3452 $additional = $_[0]->{additional} || [];
3453 $taxproduct = $_[0]->{taxproductnum};
3454 $override = { '' => $_[0]->{tax_override} };
3455 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3456 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3457 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3458 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3463 $pkg = @_ ? shift : 'One-time charge';
3464 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3466 $taxclass = @_ ? shift : '';
3470 local $SIG{HUP} = 'IGNORE';
3471 local $SIG{INT} = 'IGNORE';
3472 local $SIG{QUIT} = 'IGNORE';
3473 local $SIG{TERM} = 'IGNORE';
3474 local $SIG{TSTP} = 'IGNORE';
3475 local $SIG{PIPE} = 'IGNORE';
3477 my $oldAutoCommit = $FS::UID::AutoCommit;
3478 local $FS::UID::AutoCommit = 0;
3481 my $part_pkg = new FS::part_pkg ( {
3483 'comment' => $comment,
3487 'classnum' => ( $classnum ? $classnum : '' ),
3488 'setuptax' => $setuptax,
3489 'taxclass' => $taxclass,
3490 'taxproductnum' => $taxproduct,
3493 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3494 ( 0 .. @$additional - 1 )
3496 'additional_count' => scalar(@$additional),
3497 'setup_fee' => $amount,
3500 my $error = $part_pkg->insert( options => \%options,
3501 tax_overrides => $override,
3504 $dbh->rollback if $oldAutoCommit;
3508 my $pkgpart = $part_pkg->pkgpart;
3509 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3510 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3511 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3512 $error = $type_pkgs->insert;
3514 $dbh->rollback if $oldAutoCommit;
3519 my $cust_pkg = new FS::cust_pkg ( {
3520 'custnum' => $self->custnum,
3521 'pkgpart' => $pkgpart,
3522 'quantity' => $quantity,
3523 'start_date' => $start_date,
3524 'no_auto' => $no_auto,
3525 'locationnum'=> $locationnum,
3528 $error = $cust_pkg->insert;
3530 $dbh->rollback if $oldAutoCommit;
3532 } elsif ( $cust_pkg_ref ) {
3533 ${$cust_pkg_ref} = $cust_pkg;
3537 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3538 'pkg_list' => [ $cust_pkg ],
3541 $dbh->rollback if $oldAutoCommit;
3546 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3551 #=item charge_postal_fee
3553 #Applies a one time charge this customer. If there is an error,
3554 #returns the error, returns the cust_pkg charge object or false
3555 #if there was no charge.
3559 # This should be a customer event. For that to work requires that bill
3560 # also be a customer event.
3562 sub charge_postal_fee {
3565 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3566 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3568 my $cust_pkg = new FS::cust_pkg ( {
3569 'custnum' => $self->custnum,
3570 'pkgpart' => $pkgpart,
3574 my $error = $cust_pkg->insert;
3575 $error ? $error : $cust_pkg;
3578 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3580 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3582 Optionally, a list or hashref of additional arguments to the qsearch call can
3589 my $opt = ref($_[0]) ? shift : { @_ };
3591 #return $self->num_cust_bill unless wantarray || keys %$opt;
3593 $opt->{'table'} = 'cust_bill';
3594 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3595 $opt->{'hashref'}{'custnum'} = $self->custnum;
3596 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3598 map { $_ } #behavior of sort undefined in scalar context
3599 sort { $a->_date <=> $b->_date }
3603 =item open_cust_bill
3605 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3610 sub open_cust_bill {
3614 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3620 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3622 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3626 sub legacy_cust_bill {
3629 #return $self->num_legacy_cust_bill unless wantarray;
3631 map { $_ } #behavior of sort undefined in scalar context
3632 sort { $a->_date <=> $b->_date }
3633 qsearch({ 'table' => 'legacy_cust_bill',
3634 'hashref' => { 'custnum' => $self->custnum, },
3635 'order_by' => 'ORDER BY _date ASC',
3639 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3641 Returns all the statements (see L<FS::cust_statement>) for this customer.
3643 Optionally, a list or hashref of additional arguments to the qsearch call can
3648 =item cust_bill_void
3650 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3654 sub cust_bill_void {
3657 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3658 sort { $a->_date <=> $b->_date }
3659 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3662 sub cust_statement {
3664 my $opt = ref($_[0]) ? shift : { @_ };
3666 #return $self->num_cust_statement unless wantarray || keys %$opt;
3668 $opt->{'table'} = 'cust_statement';
3669 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3670 $opt->{'hashref'}{'custnum'} = $self->custnum;
3671 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3673 map { $_ } #behavior of sort undefined in scalar context
3674 sort { $a->_date <=> $b->_date }
3678 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3680 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3682 Optionally, a list or hashref of additional arguments to the qsearch call can
3683 be passed following the SVCDB.
3690 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3691 warn "$me svc_x requires a svcdb";
3694 my $opt = ref($_[0]) ? shift : { @_ };
3696 $opt->{'table'} = $svcdb;
3697 $opt->{'addl_from'} =
3698 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3699 ($opt->{'addl_from'} || '');
3701 my $custnum = $self->custnum;
3702 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3703 my $where = "cust_pkg.custnum = $custnum";
3705 my $extra_sql = $opt->{'extra_sql'} || '';
3706 if ( keys %{ $opt->{'hashref'} } ) {
3707 $extra_sql = " AND $where $extra_sql";
3710 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3711 $extra_sql = "WHERE $where AND $1";
3714 $extra_sql = "WHERE $where $extra_sql";
3717 $opt->{'extra_sql'} = $extra_sql;
3722 # required for use as an eventtable;
3725 $self->svc_x('svc_acct', @_);
3730 Returns all the credits (see L<FS::cust_credit>) for this customer.
3736 map { $_ } #return $self->num_cust_credit unless wantarray;
3737 sort { $a->_date <=> $b->_date }
3738 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3741 =item cust_credit_pkgnum
3743 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3744 package when using experimental package balances.
3748 sub cust_credit_pkgnum {
3749 my( $self, $pkgnum ) = @_;
3750 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3751 sort { $a->_date <=> $b->_date }
3752 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3753 'pkgnum' => $pkgnum,
3758 =item cust_credit_void
3760 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3764 sub cust_credit_void {
3767 sort { $a->_date <=> $b->_date }
3768 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3773 Returns all the payments (see L<FS::cust_pay>) for this customer.
3779 return $self->num_cust_pay unless wantarray;
3780 sort { $a->_date <=> $b->_date }
3781 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3786 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3787 called automatically when the cust_pay method is used in a scalar context.
3793 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3794 my $sth = dbh->prepare($sql) or die dbh->errstr;
3795 $sth->execute($self->custnum) or die $sth->errstr;
3796 $sth->fetchrow_arrayref->[0];
3799 =item cust_pay_pkgnum
3801 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3802 package when using experimental package balances.
3806 sub cust_pay_pkgnum {
3807 my( $self, $pkgnum ) = @_;
3808 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3809 sort { $a->_date <=> $b->_date }
3810 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3811 'pkgnum' => $pkgnum,
3818 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3824 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3825 sort { $a->_date <=> $b->_date }
3826 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3829 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3831 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3833 Optionally, a list or hashref of additional arguments to the qsearch call can
3838 sub cust_pay_batch {
3840 my $opt = ref($_[0]) ? shift : { @_ };
3842 #return $self->num_cust_statement unless wantarray || keys %$opt;
3844 $opt->{'table'} = 'cust_pay_batch';
3845 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3846 $opt->{'hashref'}{'custnum'} = $self->custnum;
3847 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3849 map { $_ } #behavior of sort undefined in scalar context
3850 sort { $a->paybatchnum <=> $b->paybatchnum }
3854 =item cust_pay_pending
3856 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3857 (without status "done").
3861 sub cust_pay_pending {
3863 return $self->num_cust_pay_pending unless wantarray;
3864 sort { $a->_date <=> $b->_date }
3865 qsearch( 'cust_pay_pending', {
3866 'custnum' => $self->custnum,
3867 'status' => { op=>'!=', value=>'done' },
3872 =item cust_pay_pending_attempt
3874 Returns all payment attempts / declined payments for this customer, as pending
3875 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3876 a corresponding payment (see L<FS::cust_pay>).
3880 sub cust_pay_pending_attempt {
3882 return $self->num_cust_pay_pending_attempt unless wantarray;
3883 sort { $a->_date <=> $b->_date }
3884 qsearch( 'cust_pay_pending', {
3885 'custnum' => $self->custnum,
3892 =item num_cust_pay_pending
3894 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3895 customer (without status "done"). Also called automatically when the
3896 cust_pay_pending method is used in a scalar context.
3900 sub num_cust_pay_pending {
3903 " SELECT COUNT(*) FROM cust_pay_pending ".
3904 " WHERE custnum = ? AND status != 'done' ",
3909 =item num_cust_pay_pending_attempt
3911 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3912 customer, with status "done" but without a corresp. Also called automatically when the
3913 cust_pay_pending method is used in a scalar context.
3917 sub num_cust_pay_pending_attempt {
3920 " SELECT COUNT(*) FROM cust_pay_pending ".
3921 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3928 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3934 map { $_ } #return $self->num_cust_refund unless wantarray;
3935 sort { $a->_date <=> $b->_date }
3936 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3939 =item display_custnum
3941 Returns the displayed customer number for this customer: agent_custid if
3942 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3946 sub display_custnum {
3949 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3950 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3951 if ( $special eq 'CoStAg' ) {
3952 $prefix = uc( join('',
3954 ($self->state =~ /^(..)/),
3955 $prefix || ($self->agent->agent =~ /^(..)/)
3958 elsif ( $special eq 'CoStCl' ) {
3959 $prefix = uc( join('',
3961 ($self->state =~ /^(..)/),
3962 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3965 # add any others here if needed
3968 my $length = $conf->config('cust_main-custnum-display_length');
3969 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3970 return $self->agent_custid;
3971 } elsif ( $prefix ) {
3972 $length = 8 if !defined($length);
3974 sprintf('%0'.$length.'d', $self->custnum)
3975 } elsif ( $length ) {
3976 return sprintf('%0'.$length.'d', $self->custnum);
3978 return $self->custnum;
3984 Returns a name string for this customer, either "Company (Last, First)" or
3991 my $name = $self->contact;
3992 $name = $self->company. " ($name)" if $self->company;
3996 =item service_contact
3998 Returns the L<FS::contact> object for this customer that has the 'Service'
3999 contact class, or undef if there is no such contact. Deprecated; don't use
4004 sub service_contact {
4006 if ( !exists($self->{service_contact}) ) {
4007 my $classnum = $self->scalar_sql(
4008 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4009 ) || 0; #if it's zero, qsearchs will return nothing
4010 $self->{service_contact} = qsearchs('contact', {
4011 'classnum' => $classnum, 'custnum' => $self->custnum
4014 $self->{service_contact};
4019 Returns a name string for this (service/shipping) contact, either
4020 "Company (Last, First)" or "Last, First".
4027 my $name = $self->ship_contact;
4028 $name = $self->company. " ($name)" if $self->company;
4034 Returns a name string for this customer, either "Company" or "First Last".
4040 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4043 =item ship_name_short
4045 Returns a name string for this (service/shipping) contact, either "Company"
4050 sub ship_name_short {
4052 $self->service_contact
4053 ? $self->ship_contact_firstlast
4059 Returns this customer's full (billing) contact name only, "Last, First"
4065 $self->get('last'). ', '. $self->first;
4070 Returns this customer's full (shipping) contact name only, "Last, First"
4076 my $contact = $self->service_contact || $self;
4077 $contact->get('last') . ', ' . $contact->get('first');
4080 =item contact_firstlast
4082 Returns this customers full (billing) contact name only, "First Last".
4086 sub contact_firstlast {
4088 $self->first. ' '. $self->get('last');
4091 =item ship_contact_firstlast
4093 Returns this customer's full (shipping) contact name only, "First Last".
4097 sub ship_contact_firstlast {
4099 my $contact = $self->service_contact || $self;
4100 $contact->get('first') . ' '. $contact->get('last');
4103 #XXX this doesn't work in 3.x+
4106 #Returns this customer's full country name
4112 # code2country($self->country);
4115 sub bill_country_full {
4117 code2country($self->bill_location->country);
4120 sub ship_country_full {
4122 code2country($self->ship_location->country);
4125 =item county_state_county [ PREFIX ]
4127 Returns a string consisting of just the county, state and country.
4131 sub county_state_country {
4134 if ( @_ && $_[0] && $self->has_ship_address ) {
4135 $locationnum = $self->ship_locationnum;
4137 $locationnum = $self->bill_locationnum;
4139 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4140 $cust_location->county_state_country;
4143 =item geocode DATA_VENDOR
4145 Returns a value for the customer location as encoded by DATA_VENDOR.
4146 Currently this only makes sense for "CCH" as DATA_VENDOR.
4154 Returns a status string for this customer, currently:
4158 =item prospect - No packages have ever been ordered
4160 =item ordered - Recurring packages all are new (not yet billed).
4162 =item active - One or more recurring packages is active
4164 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4166 =item suspended - All non-cancelled recurring packages are suspended
4168 =item cancelled - All recurring packages are cancelled
4172 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4173 cust_main-status_module configuration option.
4177 sub status { shift->cust_status(@_); }
4181 for my $status ( FS::cust_main->statuses() ) {
4182 my $method = $status.'_sql';
4183 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4184 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4185 $sth->execute( ($self->custnum) x $numnum )
4186 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4187 return $status if $sth->fetchrow_arrayref->[0];
4191 =item ucfirst_cust_status
4193 =item ucfirst_status
4195 Returns the status with the first character capitalized.
4199 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4201 sub ucfirst_cust_status {
4203 ucfirst($self->cust_status);
4208 Returns a hex triplet color string for this customer's status.
4212 sub statuscolor { shift->cust_statuscolor(@_); }
4214 sub cust_statuscolor {
4216 __PACKAGE__->statuscolors->{$self->cust_status};
4221 Returns an array of hashes representing the customer's RT tickets.
4228 my $num = $conf->config('cust_main-max_tickets') || 10;
4231 if ( $conf->config('ticket_system') ) {
4232 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4234 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4238 foreach my $priority (
4239 $conf->config('ticket_system-custom_priority_field-values'), ''
4241 last if scalar(@tickets) >= $num;
4243 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4244 $num - scalar(@tickets),
4254 # Return services representing svc_accts in customer support packages
4255 sub support_services {
4257 my %packages = map { $_ => 1 } $conf->config('support_packages');
4259 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4260 grep { $_->part_svc->svcdb eq 'svc_acct' }
4261 map { $_->cust_svc }
4262 grep { exists $packages{ $_->pkgpart } }
4263 $self->ncancelled_pkgs;
4267 # Return a list of latitude/longitude for one of the services (if any)
4268 sub service_coordinates {
4272 grep { $_->latitude && $_->longitude }
4274 map { $_->cust_svc }
4275 $self->ncancelled_pkgs;
4277 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4282 Returns a masked version of the named field
4287 my ($self,$field) = @_;
4291 'x'x(length($self->getfield($field))-4).
4292 substr($self->getfield($field), (length($self->getfield($field))-4));
4298 =head1 CLASS METHODS
4304 Class method that returns the list of possible status strings for customers
4305 (see L<the status method|/status>). For example:
4307 @statuses = FS::cust_main->statuses();
4313 keys %{ $self->statuscolors };
4316 =item cust_status_sql
4318 Returns an SQL fragment to determine the status of a cust_main record, as a
4323 sub cust_status_sql {
4325 for my $status ( FS::cust_main->statuses() ) {
4326 my $method = $status.'_sql';
4327 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4336 Returns an SQL expression identifying prospective cust_main records (customers
4337 with no packages ever ordered)
4341 use vars qw($select_count_pkgs);
4342 $select_count_pkgs =
4343 "SELECT COUNT(*) FROM cust_pkg
4344 WHERE cust_pkg.custnum = cust_main.custnum";
4346 sub select_count_pkgs_sql {
4351 " 0 = ( $select_count_pkgs ) ";
4356 Returns an SQL expression identifying ordered cust_main records (customers with
4357 no active packages, but recurring packages not yet setup or one time charges
4363 FS::cust_main->none_active_sql.
4364 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4369 Returns an SQL expression identifying active cust_main records (customers with
4370 active recurring packages).
4375 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4378 =item none_active_sql
4380 Returns an SQL expression identifying cust_main records with no active
4381 recurring packages. This includes customers of status prospect, ordered,
4382 inactive, and suspended.
4386 sub none_active_sql {
4387 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4392 Returns an SQL expression identifying inactive cust_main records (customers with
4393 no active recurring packages, but otherwise unsuspended/uncancelled).
4398 FS::cust_main->none_active_sql.
4399 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4405 Returns an SQL expression identifying suspended cust_main records.
4410 sub suspended_sql { susp_sql(@_); }
4412 FS::cust_main->none_active_sql.
4413 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4419 Returns an SQL expression identifying cancelled cust_main records.
4423 sub cancel_sql { shift->cancelled_sql(@_); }
4426 =item uncancelled_sql
4428 Returns an SQL expression identifying un-cancelled cust_main records.
4432 sub uncancelled_sql { uncancel_sql(@_); }
4433 sub uncancel_sql { "
4434 ( 0 < ( $select_count_pkgs
4435 AND ( cust_pkg.cancel IS NULL
4436 OR cust_pkg.cancel = 0
4439 OR 0 = ( $select_count_pkgs )
4445 Returns an SQL fragment to retreive the balance.
4450 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4451 WHERE cust_bill.custnum = cust_main.custnum )
4452 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4453 WHERE cust_pay.custnum = cust_main.custnum )
4454 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4455 WHERE cust_credit.custnum = cust_main.custnum )
4456 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4457 WHERE cust_refund.custnum = cust_main.custnum )
4460 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4462 Returns an SQL fragment to retreive the balance for this customer, optionally
4463 considering invoices with date earlier than START_TIME, and not
4464 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4465 total_unapplied_payments).
4467 Times are specified as SQL fragments or numeric
4468 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4469 L<Date::Parse> for conversion functions. The empty string can be passed
4470 to disable that time constraint completely.
4472 Available options are:
4476 =item unapplied_date
4478 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)
4483 set to true to remove all customer comparison clauses, for totals
4488 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4493 JOIN clause (typically used with the total option)
4497 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4498 time will be ignored. Note that START_TIME and END_TIME only limit the date
4499 range for invoices and I<unapplied> payments, credits, and refunds.
4505 sub balance_date_sql {
4506 my( $class, $start, $end, %opt ) = @_;
4508 my $cutoff = $opt{'cutoff'};
4510 my $owed = FS::cust_bill->owed_sql($cutoff);
4511 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4512 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4513 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4515 my $j = $opt{'join'} || '';
4517 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4518 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4519 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4520 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4522 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4523 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4524 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4525 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4530 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4532 Returns an SQL fragment to retreive the total unapplied payments for this
4533 customer, only considering payments with date earlier than START_TIME, and
4534 optionally not later than END_TIME.
4536 Times are specified as SQL fragments or numeric
4537 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4538 L<Date::Parse> for conversion functions. The empty string can be passed
4539 to disable that time constraint completely.
4541 Available options are:
4545 sub unapplied_payments_date_sql {
4546 my( $class, $start, $end, %opt ) = @_;
4548 my $cutoff = $opt{'cutoff'};
4550 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4552 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4553 'unapplied_date'=>1 );
4555 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4558 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4560 Helper method for balance_date_sql; name (and usage) subject to change
4561 (suggestions welcome).
4563 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4564 cust_refund, cust_credit or cust_pay).
4566 If TABLE is "cust_bill" or the unapplied_date option is true, only
4567 considers records with date earlier than START_TIME, and optionally not
4568 later than END_TIME .
4572 sub _money_table_where {
4573 my( $class, $table, $start, $end, %opt ) = @_;
4576 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4577 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4578 push @where, "$table._date <= $start" if defined($start) && length($start);
4579 push @where, "$table._date > $end" if defined($end) && length($end);
4581 push @where, @{$opt{'where'}} if $opt{'where'};
4582 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4588 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4589 use FS::cust_main::Search;
4592 FS::cust_main::Search->search(@_);
4607 #warn join('-',keys %$param);
4608 my $fh = $param->{filehandle};
4609 my $agentnum = $param->{agentnum};
4610 my $format = $param->{format};
4612 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4615 if ( $format eq 'simple' ) {
4616 @fields = qw( custnum agent_custid amount pkg );
4618 die "unknown format $format";
4621 eval "use Text::CSV_XS;";
4624 my $csv = new Text::CSV_XS;
4631 local $SIG{HUP} = 'IGNORE';
4632 local $SIG{INT} = 'IGNORE';
4633 local $SIG{QUIT} = 'IGNORE';
4634 local $SIG{TERM} = 'IGNORE';
4635 local $SIG{TSTP} = 'IGNORE';
4636 local $SIG{PIPE} = 'IGNORE';
4638 my $oldAutoCommit = $FS::UID::AutoCommit;
4639 local $FS::UID::AutoCommit = 0;
4642 #while ( $columns = $csv->getline($fh) ) {
4644 while ( defined($line=<$fh>) ) {
4646 $csv->parse($line) or do {
4647 $dbh->rollback if $oldAutoCommit;
4648 return "can't parse: ". $csv->error_input();
4651 my @columns = $csv->fields();
4652 #warn join('-',@columns);
4655 foreach my $field ( @fields ) {
4656 $row{$field} = shift @columns;
4659 if ( $row{custnum} && $row{agent_custid} ) {
4660 dbh->rollback if $oldAutoCommit;
4661 return "can't specify custnum with agent_custid $row{agent_custid}";
4665 if ( $row{agent_custid} && $agentnum ) {
4666 %hash = ( 'agent_custid' => $row{agent_custid},
4667 'agentnum' => $agentnum,
4671 if ( $row{custnum} ) {
4672 %hash = ( 'custnum' => $row{custnum} );
4675 unless ( scalar(keys %hash) ) {
4676 $dbh->rollback if $oldAutoCommit;
4677 return "can't find customer without custnum or agent_custid and agentnum";
4680 my $cust_main = qsearchs('cust_main', { %hash } );
4681 unless ( $cust_main ) {
4682 $dbh->rollback if $oldAutoCommit;
4683 my $custnum = $row{custnum} || $row{agent_custid};
4684 return "unknown custnum $custnum";
4687 if ( $row{'amount'} > 0 ) {
4688 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4690 $dbh->rollback if $oldAutoCommit;
4694 } elsif ( $row{'amount'} < 0 ) {
4695 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4698 $dbh->rollback if $oldAutoCommit;
4708 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4710 return "Empty file!" unless $imported;
4716 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4718 Deprecated. Use event notification and message templates
4719 (L<FS::msg_template>) instead.
4721 Sends a templated email notification to the customer (see L<Text::Template>).
4723 OPTIONS is a hash and may include
4725 I<from> - the email sender (default is invoice_from)
4727 I<to> - comma-separated scalar or arrayref of recipients
4728 (default is invoicing_list)
4730 I<subject> - The subject line of the sent email notification
4731 (default is "Notice from company_name")
4733 I<extra_fields> - a hashref of name/value pairs which will be substituted
4736 The following variables are vavailable in the template.
4738 I<$first> - the customer first name
4739 I<$last> - the customer last name
4740 I<$company> - the customer company
4741 I<$payby> - a description of the method of payment for the customer
4742 # would be nice to use FS::payby::shortname
4743 I<$payinfo> - the account information used to collect for this customer
4744 I<$expdate> - the expiration of the customer payment in seconds from epoch
4749 my ($self, $template, %options) = @_;
4751 return unless $conf->exists($template);
4753 my $from = $conf->config('invoice_from', $self->agentnum)
4754 if $conf->exists('invoice_from', $self->agentnum);
4755 $from = $options{from} if exists($options{from});
4757 my $to = join(',', $self->invoicing_list_emailonly);
4758 $to = $options{to} if exists($options{to});
4760 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4761 if $conf->exists('company_name', $self->agentnum);
4762 $subject = $options{subject} if exists($options{subject});
4764 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4765 SOURCE => [ map "$_\n",
4766 $conf->config($template)]
4768 or die "can't create new Text::Template object: Text::Template::ERROR";
4769 $notify_template->compile()
4770 or die "can't compile template: Text::Template::ERROR";
4772 $FS::notify_template::_template::company_name =
4773 $conf->config('company_name', $self->agentnum);
4774 $FS::notify_template::_template::company_address =
4775 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4777 my $paydate = $self->paydate || '2037-12-31';
4778 $FS::notify_template::_template::first = $self->first;
4779 $FS::notify_template::_template::last = $self->last;
4780 $FS::notify_template::_template::company = $self->company;
4781 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4782 my $payby = $self->payby;
4783 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4784 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4786 #credit cards expire at the end of the month/year of their exp date
4787 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4788 $FS::notify_template::_template::payby = 'credit card';
4789 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4790 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4792 }elsif ($payby eq 'COMP') {
4793 $FS::notify_template::_template::payby = 'complimentary account';
4795 $FS::notify_template::_template::payby = 'current method';
4797 $FS::notify_template::_template::expdate = $expire_time;
4799 for (keys %{$options{extra_fields}}){
4801 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4804 send_email(from => $from,
4806 subject => $subject,
4807 body => $notify_template->fill_in( PACKAGE =>
4808 'FS::notify_template::_template' ),
4813 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4815 Generates a templated notification to the customer (see L<Text::Template>).
4817 OPTIONS is a hash and may include
4819 I<extra_fields> - a hashref of name/value pairs which will be substituted
4820 into the template. These values may override values mentioned below
4821 and those from the customer record.
4823 The following variables are available in the template instead of or in addition
4824 to the fields of the customer record.
4826 I<$payby> - a description of the method of payment for the customer
4827 # would be nice to use FS::payby::shortname
4828 I<$payinfo> - the masked account information used to collect for this customer
4829 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4830 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4834 # a lot like cust_bill::print_latex
4835 sub generate_letter {
4836 my ($self, $template, %options) = @_;
4838 return unless $conf->exists($template);
4840 my $letter_template = new Text::Template
4842 SOURCE => [ map "$_\n", $conf->config($template)],
4843 DELIMITERS => [ '[@--', '--@]' ],
4845 or die "can't create new Text::Template object: Text::Template::ERROR";
4847 $letter_template->compile()
4848 or die "can't compile template: Text::Template::ERROR";
4850 my %letter_data = map { $_ => $self->$_ } $self->fields;
4851 $letter_data{payinfo} = $self->mask_payinfo;
4853 #my $paydate = $self->paydate || '2037-12-31';
4854 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4856 my $payby = $self->payby;
4857 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4858 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4860 #credit cards expire at the end of the month/year of their exp date
4861 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4862 $letter_data{payby} = 'credit card';
4863 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4864 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4866 }elsif ($payby eq 'COMP') {
4867 $letter_data{payby} = 'complimentary account';
4869 $letter_data{payby} = 'current method';
4871 $letter_data{expdate} = $expire_time;
4873 for (keys %{$options{extra_fields}}){
4874 $letter_data{$_} = $options{extra_fields}->{$_};
4877 unless(exists($letter_data{returnaddress})){
4878 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4879 $self->agent_template)
4881 if ( length($retadd) ) {
4882 $letter_data{returnaddress} = $retadd;
4883 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4884 $letter_data{returnaddress} =
4885 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4889 ( $conf->config('company_name', $self->agentnum),
4890 $conf->config('company_address', $self->agentnum),
4894 $letter_data{returnaddress} = '~';
4898 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4900 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4902 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4904 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4908 ) or die "can't open temp file: $!\n";
4909 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4910 or die "can't write temp file: $!\n";
4912 $letter_data{'logo_file'} = $lh->filename;
4914 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4918 ) or die "can't open temp file: $!\n";
4920 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4922 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4923 return ($1, $letter_data{'logo_file'});
4927 =item print_ps TEMPLATE
4929 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4935 my($file, $lfile) = $self->generate_letter(@_);
4936 my $ps = FS::Misc::generate_ps($file);
4937 unlink($file.'.tex');
4943 =item print TEMPLATE
4945 Prints the filled in template.
4947 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4951 sub queueable_print {
4954 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4955 or die "invalid customer number: " . $opt{custnum};
4957 my $error = $self->print( { 'template' => $opt{template} } );
4958 die $error if $error;
4962 my ($self, $template) = (shift, shift);
4964 [ $self->print_ps($template) ],
4965 'agentnum' => $self->agentnum,
4969 #these three subs should just go away once agent stuff is all config overrides
4971 sub agent_template {
4973 $self->_agent_plandata('agent_templatename');
4976 sub agent_invoice_from {
4978 $self->_agent_plandata('agent_invoice_from');
4981 sub _agent_plandata {
4982 my( $self, $option ) = @_;
4984 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4985 #agent-specific Conf
4987 use FS::part_event::Condition;
4989 my $agentnum = $self->agentnum;
4991 my $regexp = regexp_sql();
4993 my $part_event_option =
4995 'select' => 'part_event_option.*',
4996 'table' => 'part_event_option',
4998 LEFT JOIN part_event USING ( eventpart )
4999 LEFT JOIN part_event_option AS peo_agentnum
5000 ON ( part_event.eventpart = peo_agentnum.eventpart
5001 AND peo_agentnum.optionname = 'agentnum'
5002 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5004 LEFT JOIN part_event_condition
5005 ON ( part_event.eventpart = part_event_condition.eventpart
5006 AND part_event_condition.conditionname = 'cust_bill_age'
5008 LEFT JOIN part_event_condition_option
5009 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5010 AND part_event_condition_option.optionname = 'age'
5013 #'hashref' => { 'optionname' => $option },
5014 #'hashref' => { 'part_event_option.optionname' => $option },
5016 " WHERE part_event_option.optionname = ". dbh->quote($option).
5017 " AND action = 'cust_bill_send_agent' ".
5018 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5019 " AND peo_agentnum.optionname = 'agentnum' ".
5020 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5022 CASE WHEN part_event_condition_option.optionname IS NULL
5024 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5026 , part_event.weight".
5030 unless ( $part_event_option ) {
5031 return $self->agent->invoice_template || ''
5032 if $option eq 'agent_templatename';
5036 $part_event_option->optionvalue;
5040 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5042 Subroutine (not a method), designed to be called from the queue.
5044 Takes a list of options and values.
5046 Pulls up the customer record via the custnum option and calls bill_and_collect.
5051 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5053 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5054 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5056 #without this errors don't get rolled back
5057 $args{'fatal'} = 1; # runs from job queue, will be caught
5059 $cust_main->bill_and_collect( %args );
5062 sub process_bill_and_collect {
5064 my $param = thaw(decode_base64(shift));
5065 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5066 or die "custnum '$param->{custnum}' not found!\n";
5067 $param->{'job'} = $job;
5068 $param->{'fatal'} = 1; # runs from job queue, will be caught
5069 $param->{'retry'} = 1;
5071 $cust_main->bill_and_collect( %$param );
5074 #starting to take quite a while for big dbs
5075 # (JRNL: journaled so it only happens once per database)
5076 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5077 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5078 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5079 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5080 # JRNL leading/trailing spaces in first, last, company
5081 # - otaker upgrade? journal and call it good? (double check to make sure
5082 # we're not still setting otaker here)
5084 #only going to get worse with new location stuff...
5086 sub _upgrade_data { #class method
5087 my ($class, %opts) = @_;
5090 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5093 #this seems to be the only expensive one.. why does it take so long?
5094 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5096 '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';
5097 FS::upgrade_journal->set_done('cust_main__signupdate');
5100 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5102 # fix yyyy-m-dd formatted paydates
5103 if ( driver_name =~ /^mysql/i ) {
5105 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5106 } else { # the SQL standard
5108 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5110 FS::upgrade_journal->set_done('cust_main__paydate');
5113 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5115 push @statements, #fix the weird BILL with a cc# in payinfo problem
5117 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5119 FS::upgrade_journal->set_done('cust_main__payinfo');
5124 foreach my $sql ( @statements ) {
5125 my $sth = dbh->prepare($sql) or die dbh->errstr;
5126 $sth->execute or die $sth->errstr;
5127 #warn ( (time - $t). " seconds\n" );
5131 local($ignore_expired_card) = 1;
5132 local($ignore_banned_card) = 1;
5133 local($skip_fuzzyfiles) = 1;
5134 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5136 FS::cust_main::Location->_upgrade_data(%opts);
5138 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5140 foreach my $cust_main ( qsearch({
5141 'table' => 'cust_main',
5143 'extra_sql' => 'WHERE '.
5145 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5146 qw( first last company )
5149 my $error = $cust_main->replace;
5150 die $error if $error;
5153 FS::upgrade_journal->set_done('cust_main__trimspaces');
5157 $class->_upgrade_otaker(%opts);
5167 The delete method should possibly take an FS::cust_main object reference
5168 instead of a scalar customer number.
5170 Bill and collect options should probably be passed as references instead of a
5173 There should probably be a configuration file with a list of allowed credit
5176 No multiple currency support (probably a larger project than just this module).
5178 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5180 Birthdates rely on negative epoch values.
5182 The payby for card/check batches is broken. With mixed batching, bad
5185 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5189 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5190 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5191 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.