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
25 use Scalar::Util qw( blessed );
26 use Time::Local qw(timelocal);
27 use Storable qw(thaw);
31 use Digest::MD5 qw(md5_base64);
34 use File::Temp; #qw( tempfile );
35 use Business::CreditCard 0.28;
37 use FS::UID qw( dbh driver_name );
38 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
40 use FS::Misc qw( generate_email send_email generate_ps do_print );
41 use FS::Msgcat qw(gettext);
48 use FS::cust_bill_void;
49 use FS::legacy_cust_bill;
51 use FS::cust_pay_pending;
52 use FS::cust_pay_void;
53 use FS::cust_pay_batch;
56 use FS::part_referral;
57 use FS::cust_main_county;
58 use FS::cust_location;
60 use FS::cust_main_exemption;
61 use FS::cust_tax_adjustment;
62 use FS::cust_tax_location;
64 use FS::agent_currency;
65 use FS::cust_main_invoice;
67 use FS::prepay_credit;
73 use FS::payment_gateway;
74 use FS::agent_payment_gateway;
76 use FS::cust_main_note;
77 use FS::cust_attachment;
80 use FS::upgrade_journal;
84 # 1 is mostly method/subroutine entry and options
85 # 2 traces progress of some operations
86 # 3 is even more information including possibly sensitive data
88 $me = '[FS::cust_main]';
91 $ignore_expired_card = 0;
92 $ignore_banned_card = 0;
93 $ignore_invalid_card = 0;
97 @encrypted_fields = ('payinfo', 'paycvv');
98 sub nohistory_fields { ('payinfo', 'paycvv'); }
100 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
102 #ask FS::UID to run this stuff for us later
103 #$FS::UID::callback{'FS::cust_main'} = sub {
104 install_callback FS::UID sub {
105 $conf = new FS::Conf;
106 #yes, need it for stuff below (prolly should be cached)
107 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
112 my ( $hashref, $cache ) = @_;
113 if ( exists $hashref->{'pkgnum'} ) {
114 #@{ $self->{'_pkgnum'} } = ();
115 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
116 $self->{'_pkgnum'} = $subcache;
117 #push @{ $self->{'_pkgnum'} },
118 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
124 FS::cust_main - Object methods for cust_main records
130 $record = new FS::cust_main \%hash;
131 $record = new FS::cust_main { 'column' => 'value' };
133 $error = $record->insert;
135 $error = $new_record->replace($old_record);
137 $error = $record->delete;
139 $error = $record->check;
141 @cust_pkg = $record->all_pkgs;
143 @cust_pkg = $record->ncancelled_pkgs;
145 @cust_pkg = $record->suspended_pkgs;
147 $error = $record->bill;
148 $error = $record->bill %options;
149 $error = $record->bill 'time' => $time;
151 $error = $record->collect;
152 $error = $record->collect %options;
153 $error = $record->collect 'invoice_time' => $time,
158 An FS::cust_main object represents a customer. FS::cust_main inherits from
159 FS::Record. The following fields are currently supported:
165 Primary key (assigned automatically for new customers)
169 Agent (see L<FS::agent>)
173 Advertising source (see L<FS::part_referral>)
185 Cocial security number (optional)
209 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
213 Payment Information (See L<FS::payinfo_Mixin> for data format)
217 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
221 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
225 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
229 Start date month (maestro/solo cards only)
233 Start date year (maestro/solo cards only)
237 Issue number (maestro/solo cards only)
241 Name on card or billing name
245 IP address from which payment information was received
249 Tax exempt, empty or `Y'
253 Order taker (see L<FS::access_user>)
259 =item referral_custnum
261 Referring customer number
265 Enable individual CDR spooling, empty or `Y'
269 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
273 Discourage individual CDR printing, empty or `Y'
277 Allow self-service editing of ticket subjects, empty or 'Y'
279 =item calling_list_exempt
281 Do not call, empty or 'Y'
291 Creates a new customer. To add the customer to the database, see L<"insert">.
293 Note that this stores the hash reference, not a distinct copy of the hash it
294 points to. You can ask the object for a copy with the I<hash> method.
298 sub table { 'cust_main'; }
300 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
302 Adds this customer to the database. If there is an error, returns the error,
303 otherwise returns false.
305 Usually the customer's location will not yet exist in the database, and
306 the C<bill_location> and C<ship_location> pseudo-fields must be set to
307 uninserted L<FS::cust_location> objects. These will be inserted and linked
308 (in both directions) to the new customer record. If they're references
309 to the same object, they will become the same location.
311 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
312 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
313 are inserted atomicly, or the transaction is rolled back. Passing an empty
314 hash reference is equivalent to not supplying this parameter. There should be
315 a better explanation of this, but until then, here's an example:
318 tie %hash, 'Tie::RefHash'; #this part is important
320 $cust_pkg => [ $svc_acct ],
323 $cust_main->insert( \%hash );
325 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
326 be set as the invoicing list (see L<"invoicing_list">). Errors return as
327 expected and rollback the entire transaction; it is not necessary to call
328 check_invoicing_list first. The invoicing_list is set after the records in the
329 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
330 invoicing_list destination to the newly-created svc_acct. Here's an example:
332 $cust_main->insert( {}, [ $email, 'POST' ] );
334 Currently available options are: I<depend_jobnum>, I<noexport>,
335 I<tax_exemption> and I<prospectnum>.
337 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
338 on the supplied jobnum (they will not run until the specific job completes).
339 This can be used to defer provisioning until some action completes (such
340 as running the customer's credit card successfully).
342 The I<noexport> option is deprecated. If I<noexport> is set true, no
343 provisioning jobs (exports) are scheduled. (You can schedule them later with
344 the B<reexport> method.)
346 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
347 of tax names and exemption numbers. FS::cust_main_exemption records will be
348 created and inserted.
350 If I<prospectnum> is set, moves contacts and locations from that prospect.
356 my $cust_pkgs = @_ ? shift : {};
357 my $invoicing_list = @_ ? shift : '';
359 warn "$me insert called with options ".
360 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
363 local $SIG{HUP} = 'IGNORE';
364 local $SIG{INT} = 'IGNORE';
365 local $SIG{QUIT} = 'IGNORE';
366 local $SIG{TERM} = 'IGNORE';
367 local $SIG{TSTP} = 'IGNORE';
368 local $SIG{PIPE} = 'IGNORE';
370 my $oldAutoCommit = $FS::UID::AutoCommit;
371 local $FS::UID::AutoCommit = 0;
374 my $prepay_identifier = '';
375 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
377 if ( $self->payby eq 'PREPAY' ) {
379 $self->payby('BILL');
380 $prepay_identifier = $self->payinfo;
383 warn " looking up prepaid card $prepay_identifier\n"
386 my $error = $self->get_prepay( $prepay_identifier,
387 'amount_ref' => \$amount,
388 'seconds_ref' => \$seconds,
389 'upbytes_ref' => \$upbytes,
390 'downbytes_ref' => \$downbytes,
391 'totalbytes_ref' => \$totalbytes,
394 $dbh->rollback if $oldAutoCommit;
395 #return "error applying prepaid card (transaction rolled back): $error";
399 $payby = 'PREP' if $amount;
401 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
404 $self->payby('BILL');
405 $amount = $self->paid;
410 foreach my $l (qw(bill_location ship_location)) {
411 my $loc = delete $self->hashref->{$l};
412 # XXX if we're moving a prospect's locations, do that here
417 if ( !$loc->locationnum ) {
418 # warn the location that we're going to insert it with no custnum
419 $loc->set(custnum_pending => 1);
420 warn " inserting $l\n"
422 my $error = $loc->insert;
424 $dbh->rollback if $oldAutoCommit;
425 my $label = $l eq 'ship_location' ? 'service' : 'billing';
426 return "$error (in $label location)";
429 elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
430 # then it somehow belongs to another customer--shouldn't happen
431 $dbh->rollback if $oldAutoCommit;
432 return "$l belongs to customer ".$loc->custnum;
434 # else it already belongs to this customer
435 # (happens when ship_location is identical to bill_location)
437 $self->set($l.'num', $loc->locationnum);
439 if ( $self->get($l.'num') eq '' ) {
440 $dbh->rollback if $oldAutoCommit;
445 warn " inserting $self\n"
448 $self->signupdate(time) unless $self->signupdate;
450 $self->auto_agent_custid()
451 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
453 my $error = $self->SUPER::insert;
455 $dbh->rollback if $oldAutoCommit;
456 #return "inserting cust_main record (transaction rolled back): $error";
460 # now set cust_location.custnum
461 foreach my $l (qw(bill_location ship_location)) {
462 warn " setting $l.custnum\n"
465 unless ( $loc->custnum ) {
466 $loc->set(custnum => $self->custnum);
467 $error ||= $loc->replace;
471 $dbh->rollback if $oldAutoCommit;
472 return "error setting $l custnum: $error";
476 warn " setting invoicing list\n"
479 if ( $invoicing_list ) {
480 $error = $self->check_invoicing_list( $invoicing_list );
482 $dbh->rollback if $oldAutoCommit;
483 #return "checking invoicing_list (transaction rolled back): $error";
486 $self->invoicing_list( $invoicing_list );
489 warn " setting customer tags\n"
492 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
493 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
494 'custnum' => $self->custnum };
495 my $error = $cust_tag->insert;
497 $dbh->rollback if $oldAutoCommit;
502 my $prospectnum = delete $options{'prospectnum'};
503 if ( $prospectnum ) {
505 warn " moving contacts and locations from prospect $prospectnum\n"
509 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
510 unless ( $prospect_main ) {
511 $dbh->rollback if $oldAutoCommit;
512 return "Unknown prospectnum $prospectnum";
514 $prospect_main->custnum($self->custnum);
515 $prospect_main->disabled('Y');
516 my $error = $prospect_main->replace;
518 $dbh->rollback if $oldAutoCommit;
522 my @contact = $prospect_main->contact;
523 my @cust_location = $prospect_main->cust_location;
524 my @qual = $prospect_main->qual;
526 foreach my $r ( @contact, @cust_location, @qual ) {
528 $r->custnum($self->custnum);
529 my $error = $r->replace;
531 $dbh->rollback if $oldAutoCommit;
538 warn " setting cust_main_exemption\n"
541 my $tax_exemption = delete $options{'tax_exemption'};
542 if ( $tax_exemption ) {
544 $tax_exemption = { map { $_ => '' } @$tax_exemption }
545 if ref($tax_exemption) eq 'ARRAY';
547 foreach my $taxname ( keys %$tax_exemption ) {
548 my $cust_main_exemption = new FS::cust_main_exemption {
549 'custnum' => $self->custnum,
550 'taxname' => $taxname,
551 'exempt_number' => $tax_exemption->{$taxname},
553 my $error = $cust_main_exemption->insert;
555 $dbh->rollback if $oldAutoCommit;
556 return "inserting cust_main_exemption (transaction rolled back): $error";
561 warn " ordering packages\n"
564 $error = $self->order_pkgs( $cust_pkgs,
566 'seconds_ref' => \$seconds,
567 'upbytes_ref' => \$upbytes,
568 'downbytes_ref' => \$downbytes,
569 'totalbytes_ref' => \$totalbytes,
572 $dbh->rollback if $oldAutoCommit;
577 $dbh->rollback if $oldAutoCommit;
578 return "No svc_acct record to apply pre-paid time";
580 if ( $upbytes || $downbytes || $totalbytes ) {
581 $dbh->rollback if $oldAutoCommit;
582 return "No svc_acct record to apply pre-paid data";
586 warn " inserting initial $payby payment of $amount\n"
588 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
590 $dbh->rollback if $oldAutoCommit;
591 return "inserting payment (transaction rolled back): $error";
595 unless ( $import || $skip_fuzzyfiles ) {
596 warn " queueing fuzzyfiles update\n"
598 $error = $self->queue_fuzzyfiles_update;
600 $dbh->rollback if $oldAutoCommit;
601 return "updating fuzzy search cache: $error";
605 # FS::geocode_Mixin::after_insert or something?
606 if ( $conf->config('tax_district_method') and !$import ) {
607 # if anything non-empty, try to look it up
608 my $queue = new FS::queue {
609 'job' => 'FS::geocode_Mixin::process_district_update',
610 'custnum' => $self->custnum,
612 my $error = $queue->insert( ref($self), $self->custnum );
614 $dbh->rollback if $oldAutoCommit;
615 return "queueing tax district update: $error";
620 warn " exporting\n" if $DEBUG > 1;
622 my $export_args = $options{'export_args'} || [];
625 map qsearch( 'part_export', {exportnum=>$_} ),
626 $conf->config('cust_main-exports'); #, $agentnum
628 foreach my $part_export ( @part_export ) {
629 my $error = $part_export->export_insert($self, @$export_args);
631 $dbh->rollback if $oldAutoCommit;
632 return "exporting to ". $part_export->exporttype.
633 " (transaction rolled back): $error";
637 #foreach my $depend_jobnum ( @$depend_jobnums ) {
638 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
640 # foreach my $jobnum ( @jobnums ) {
641 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
642 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
644 # my $error = $queue->depend_insert($depend_jobnum);
646 # $dbh->rollback if $oldAutoCommit;
647 # return "error queuing job dependancy: $error";
654 #if ( exists $options{'jobnums'} ) {
655 # push @{ $options{'jobnums'} }, @jobnums;
658 warn " insert complete; committing transaction\n"
661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
666 use File::CounterFile;
667 sub auto_agent_custid {
670 my $format = $conf->config('cust_main-auto_agent_custid');
672 if ( $format eq '1YMMXXXXXXXX' ) {
674 my $counter = new File::CounterFile 'cust_main.agent_custid';
677 my $ym = 100000000000 + time2str('%y%m00000000', time);
678 if ( $ym > $counter->value ) {
679 $counter->{'value'} = $agent_custid = $ym;
680 $counter->{'updated'} = 1;
682 $agent_custid = $counter->inc;
688 die "Unknown cust_main-auto_agent_custid format: $format";
691 $self->agent_custid($agent_custid);
695 =item PACKAGE METHODS
697 Documentation on customer package methods has been moved to
698 L<FS::cust_main::Packages>.
700 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
702 Recharges this (existing) customer with the specified prepaid card (see
703 L<FS::prepay_credit>), specified either by I<identifier> or as an
704 FS::prepay_credit object. If there is an error, returns the error, otherwise
707 Optionally, five scalar references can be passed as well. They will have their
708 values filled in with the amount, number of seconds, and number of upload,
709 download, and total bytes applied by this prepaid card.
713 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
714 #the only place that uses these args
715 sub recharge_prepay {
716 my( $self, $prepay_credit, $amountref, $secondsref,
717 $upbytesref, $downbytesref, $totalbytesref ) = @_;
719 local $SIG{HUP} = 'IGNORE';
720 local $SIG{INT} = 'IGNORE';
721 local $SIG{QUIT} = 'IGNORE';
722 local $SIG{TERM} = 'IGNORE';
723 local $SIG{TSTP} = 'IGNORE';
724 local $SIG{PIPE} = 'IGNORE';
726 my $oldAutoCommit = $FS::UID::AutoCommit;
727 local $FS::UID::AutoCommit = 0;
730 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
732 my $error = $self->get_prepay( $prepay_credit,
733 'amount_ref' => \$amount,
734 'seconds_ref' => \$seconds,
735 'upbytes_ref' => \$upbytes,
736 'downbytes_ref' => \$downbytes,
737 'totalbytes_ref' => \$totalbytes,
739 || $self->increment_seconds($seconds)
740 || $self->increment_upbytes($upbytes)
741 || $self->increment_downbytes($downbytes)
742 || $self->increment_totalbytes($totalbytes)
743 || $self->insert_cust_pay_prepay( $amount,
745 ? $prepay_credit->identifier
750 $dbh->rollback if $oldAutoCommit;
754 if ( defined($amountref) ) { $$amountref = $amount; }
755 if ( defined($secondsref) ) { $$secondsref = $seconds; }
756 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
757 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
758 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
760 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
765 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
767 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
768 specified either by I<identifier> or as an FS::prepay_credit object.
770 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
771 incremented by the values of the prepaid card.
773 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
774 check or set this customer's I<agentnum>.
776 If there is an error, returns the error, otherwise returns false.
782 my( $self, $prepay_credit, %opt ) = @_;
784 local $SIG{HUP} = 'IGNORE';
785 local $SIG{INT} = 'IGNORE';
786 local $SIG{QUIT} = 'IGNORE';
787 local $SIG{TERM} = 'IGNORE';
788 local $SIG{TSTP} = 'IGNORE';
789 local $SIG{PIPE} = 'IGNORE';
791 my $oldAutoCommit = $FS::UID::AutoCommit;
792 local $FS::UID::AutoCommit = 0;
795 unless ( ref($prepay_credit) ) {
797 my $identifier = $prepay_credit;
799 $prepay_credit = qsearchs(
801 { 'identifier' => $identifier },
806 unless ( $prepay_credit ) {
807 $dbh->rollback if $oldAutoCommit;
808 return "Invalid prepaid card: ". $identifier;
813 if ( $prepay_credit->agentnum ) {
814 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
815 $dbh->rollback if $oldAutoCommit;
816 return "prepaid card not valid for agent ". $self->agentnum;
818 $self->agentnum($prepay_credit->agentnum);
821 my $error = $prepay_credit->delete;
823 $dbh->rollback if $oldAutoCommit;
824 return "removing prepay_credit (transaction rolled back): $error";
827 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
828 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
830 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
835 =item increment_upbytes SECONDS
837 Updates this customer's single or primary account (see L<FS::svc_acct>) by
838 the specified number of upbytes. If there is an error, returns the error,
839 otherwise returns false.
843 sub increment_upbytes {
844 _increment_column( shift, 'upbytes', @_);
847 =item increment_downbytes SECONDS
849 Updates this customer's single or primary account (see L<FS::svc_acct>) by
850 the specified number of downbytes. If there is an error, returns the error,
851 otherwise returns false.
855 sub increment_downbytes {
856 _increment_column( shift, 'downbytes', @_);
859 =item increment_totalbytes SECONDS
861 Updates this customer's single or primary account (see L<FS::svc_acct>) by
862 the specified number of totalbytes. If there is an error, returns the error,
863 otherwise returns false.
867 sub increment_totalbytes {
868 _increment_column( shift, 'totalbytes', @_);
871 =item increment_seconds SECONDS
873 Updates this customer's single or primary account (see L<FS::svc_acct>) by
874 the specified number of seconds. If there is an error, returns the error,
875 otherwise returns false.
879 sub increment_seconds {
880 _increment_column( shift, 'seconds', @_);
883 =item _increment_column AMOUNT
885 Updates this customer's single or primary account (see L<FS::svc_acct>) by
886 the specified number of seconds or bytes. If there is an error, returns
887 the error, otherwise returns false.
891 sub _increment_column {
892 my( $self, $column, $amount ) = @_;
893 warn "$me increment_column called: $column, $amount\n"
896 return '' unless $amount;
898 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
899 $self->ncancelled_pkgs;
902 return 'No packages with primary or single services found'.
903 ' to apply pre-paid time';
904 } elsif ( scalar(@cust_pkg) > 1 ) {
905 #maybe have a way to specify the package/account?
906 return 'Multiple packages found to apply pre-paid time';
909 my $cust_pkg = $cust_pkg[0];
910 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
914 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
917 return 'No account found to apply pre-paid time';
918 } elsif ( scalar(@cust_svc) > 1 ) {
919 return 'Multiple accounts found to apply pre-paid time';
922 my $svc_acct = $cust_svc[0]->svc_x;
923 warn " found service svcnum ". $svc_acct->pkgnum.
924 ' ('. $svc_acct->email. ")\n"
927 $column = "increment_$column";
928 $svc_acct->$column($amount);
932 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
934 Inserts a prepayment in the specified amount for this customer. An optional
935 second argument can specify the prepayment identifier for tracking purposes.
936 If there is an error, returns the error, otherwise returns false.
940 sub insert_cust_pay_prepay {
941 shift->insert_cust_pay('PREP', @_);
944 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
946 Inserts a cash payment in the specified amount for this customer. An optional
947 second argument can specify the payment identifier for tracking purposes.
948 If there is an error, returns the error, otherwise returns false.
952 sub insert_cust_pay_cash {
953 shift->insert_cust_pay('CASH', @_);
956 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
958 Inserts a Western Union payment in the specified amount for this customer. An
959 optional second argument can specify the prepayment identifier for tracking
960 purposes. If there is an error, returns the error, otherwise returns false.
964 sub insert_cust_pay_west {
965 shift->insert_cust_pay('WEST', @_);
968 sub insert_cust_pay {
969 my( $self, $payby, $amount ) = splice(@_, 0, 3);
970 my $payinfo = scalar(@_) ? shift : '';
972 my $cust_pay = new FS::cust_pay {
973 'custnum' => $self->custnum,
974 'paid' => sprintf('%.2f', $amount),
975 #'_date' => #date the prepaid card was purchased???
977 'payinfo' => $payinfo,
983 =item delete [ OPTION => VALUE ... ]
985 This deletes the customer. If there is an error, returns the error, otherwise
988 This will completely remove all traces of the customer record. This is not
989 what you want when a customer cancels service; for that, cancel all of the
990 customer's packages (see L</cancel>).
992 If the customer has any uncancelled packages, you need to pass a new (valid)
993 customer number for those packages to be transferred to, as the "new_customer"
994 option. Cancelled packages will be deleted. Did I mention that this is NOT
995 what you want when a customer cancels service and that you really should be
996 looking at L<FS::cust_pkg/cancel>?
998 You can't delete a customer with invoices (see L<FS::cust_bill>),
999 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1000 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1001 set the "delete_financials" option to a true value.
1006 my( $self, %opt ) = @_;
1008 local $SIG{HUP} = 'IGNORE';
1009 local $SIG{INT} = 'IGNORE';
1010 local $SIG{QUIT} = 'IGNORE';
1011 local $SIG{TERM} = 'IGNORE';
1012 local $SIG{TSTP} = 'IGNORE';
1013 local $SIG{PIPE} = 'IGNORE';
1015 my $oldAutoCommit = $FS::UID::AutoCommit;
1016 local $FS::UID::AutoCommit = 0;
1019 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1020 $dbh->rollback if $oldAutoCommit;
1021 return "Can't delete a master agent customer";
1024 #use FS::access_user
1025 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1026 $dbh->rollback if $oldAutoCommit;
1027 return "Can't delete a master employee customer";
1030 tie my %financial_tables, 'Tie::IxHash',
1031 'cust_bill' => 'invoices',
1032 'cust_statement' => 'statements',
1033 'cust_credit' => 'credits',
1034 'cust_pay' => 'payments',
1035 'cust_refund' => 'refunds',
1038 foreach my $table ( keys %financial_tables ) {
1040 my @records = $self->$table();
1042 if ( @records && ! $opt{'delete_financials'} ) {
1043 $dbh->rollback if $oldAutoCommit;
1044 return "Can't delete a customer with ". $financial_tables{$table};
1047 foreach my $record ( @records ) {
1048 my $error = $record->delete;
1050 $dbh->rollback if $oldAutoCommit;
1051 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1057 my @cust_pkg = $self->ncancelled_pkgs;
1059 my $new_custnum = $opt{'new_custnum'};
1060 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1061 $dbh->rollback if $oldAutoCommit;
1062 return "Invalid new customer number: $new_custnum";
1064 foreach my $cust_pkg ( @cust_pkg ) {
1065 my %hash = $cust_pkg->hash;
1066 $hash{'custnum'} = $new_custnum;
1067 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1068 my $error = $new_cust_pkg->replace($cust_pkg,
1069 options => { $cust_pkg->options },
1072 $dbh->rollback if $oldAutoCommit;
1077 my @cancelled_cust_pkg = $self->all_pkgs;
1078 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1079 my $error = $cust_pkg->delete;
1081 $dbh->rollback if $oldAutoCommit;
1086 #cust_tax_adjustment in financials?
1087 #cust_pay_pending? ouch
1089 foreach my $table (qw(
1090 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1091 cust_location cust_main_note cust_tax_adjustment
1092 cust_pay_void cust_pay_batch queue cust_tax_exempt
1094 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1095 my $error = $record->delete;
1097 $dbh->rollback if $oldAutoCommit;
1103 my $sth = $dbh->prepare(
1104 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1106 my $errstr = $dbh->errstr;
1107 $dbh->rollback if $oldAutoCommit;
1110 $sth->execute($self->custnum) or do {
1111 my $errstr = $sth->errstr;
1112 $dbh->rollback if $oldAutoCommit;
1118 my $ticket_dbh = '';
1119 if ($conf->config('ticket_system') eq 'RT_Internal') {
1121 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1122 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1123 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1124 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1127 if ( $ticket_dbh ) {
1129 my $ticket_sth = $ticket_dbh->prepare(
1130 'DELETE FROM Links WHERE Target = ?'
1132 my $errstr = $ticket_dbh->errstr;
1133 $dbh->rollback if $oldAutoCommit;
1136 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1138 my $errstr = $ticket_sth->errstr;
1139 $dbh->rollback if $oldAutoCommit;
1143 #check and see if the customer is the only link on the ticket, and
1144 #if so, set the ticket to deleted status in RT?
1145 #maybe someday, for now this will at least fix tickets not displaying
1149 #delete the customer record
1151 my $error = $self->SUPER::delete;
1153 $dbh->rollback if $oldAutoCommit;
1157 # cust_main exports!
1159 #my $export_args = $options{'export_args'} || [];
1162 map qsearch( 'part_export', {exportnum=>$_} ),
1163 $conf->config('cust_main-exports'); #, $agentnum
1165 foreach my $part_export ( @part_export ) {
1166 my $error = $part_export->export_delete( $self ); #, @$export_args);
1168 $dbh->rollback if $oldAutoCommit;
1169 return "exporting to ". $part_export->exporttype.
1170 " (transaction rolled back): $error";
1174 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1179 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1181 This merges this customer into the provided new custnum, and then deletes the
1182 customer. If there is an error, returns the error, otherwise returns false.
1184 The source customer's name, company name, phone numbers, agent,
1185 referring customer, customer class, advertising source, order taker, and
1186 billing information (except balance) are discarded.
1188 All packages are moved to the target customer. Packages with package locations
1189 are preserved. Packages without package locations are moved to a new package
1190 location with the source customer's service/shipping address.
1192 All invoices, statements, payments, credits and refunds are moved to the target
1193 customer. The source customer's balance is added to the target customer.
1195 All notes, attachments, tickets and customer tags are moved to the target
1198 Change history is not currently moved.
1203 my( $self, $new_custnum, %opt ) = @_;
1205 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1207 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1208 or return "Invalid new customer number: $new_custnum";
1210 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1211 if $self->agentnum != $new_cust_main->agentnum
1212 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1214 local $SIG{HUP} = 'IGNORE';
1215 local $SIG{INT} = 'IGNORE';
1216 local $SIG{QUIT} = 'IGNORE';
1217 local $SIG{TERM} = 'IGNORE';
1218 local $SIG{TSTP} = 'IGNORE';
1219 local $SIG{PIPE} = 'IGNORE';
1221 my $oldAutoCommit = $FS::UID::AutoCommit;
1222 local $FS::UID::AutoCommit = 0;
1225 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1226 $dbh->rollback if $oldAutoCommit;
1227 return "Can't merge a master agent customer";
1230 #use FS::access_user
1231 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1232 $dbh->rollback if $oldAutoCommit;
1233 return "Can't merge a master employee customer";
1236 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1237 'status' => { op=>'!=', value=>'done' },
1241 $dbh->rollback if $oldAutoCommit;
1242 return "Can't merge a customer with pending payments";
1245 tie my %financial_tables, 'Tie::IxHash',
1246 'cust_bill' => 'invoices',
1247 'cust_bill_void' => 'voided invoices',
1248 'cust_statement' => 'statements',
1249 'cust_credit' => 'credits',
1250 'cust_credit_void' => 'voided credits',
1251 'cust_pay' => 'payments',
1252 'cust_pay_void' => 'voided payments',
1253 'cust_refund' => 'refunds',
1256 foreach my $table ( keys %financial_tables ) {
1258 my @records = $self->$table();
1260 foreach my $record ( @records ) {
1261 $record->custnum($new_custnum);
1262 my $error = $record->replace;
1264 $dbh->rollback if $oldAutoCommit;
1265 return "Error merging ". $financial_tables{$table}. ": $error\n";
1271 my $name = $self->ship_name; #?
1273 my $locationnum = '';
1274 foreach my $cust_pkg ( $self->all_pkgs ) {
1275 $cust_pkg->custnum($new_custnum);
1277 unless ( $cust_pkg->locationnum ) {
1278 unless ( $locationnum ) {
1279 my $cust_location = new FS::cust_location {
1280 $self->location_hash,
1281 'custnum' => $new_custnum,
1283 my $error = $cust_location->insert;
1285 $dbh->rollback if $oldAutoCommit;
1288 $locationnum = $cust_location->locationnum;
1290 $cust_pkg->locationnum($locationnum);
1293 my $error = $cust_pkg->replace;
1295 $dbh->rollback if $oldAutoCommit;
1299 # add customer (ship) name to svc_phone.phone_name if blank
1300 my @cust_svc = $cust_pkg->cust_svc;
1301 foreach my $cust_svc (@cust_svc) {
1302 my($label, $value, $svcdb) = $cust_svc->label;
1303 next unless $svcdb eq 'svc_phone';
1304 my $svc_phone = $cust_svc->svc_x;
1305 next if $svc_phone->phone_name;
1306 $svc_phone->phone_name($name);
1307 my $error = $svc_phone->replace;
1309 $dbh->rollback if $oldAutoCommit;
1317 # cust_tax_exempt (texas tax exemptions)
1318 # cust_recon (some sort of not-well understood thing for OnPac)
1320 #these are moved over
1321 foreach my $table (qw(
1322 cust_tag cust_location contact cust_attachment cust_main_note
1323 cust_tax_adjustment cust_pay_batch queue
1325 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1326 $record->custnum($new_custnum);
1327 my $error = $record->replace;
1329 $dbh->rollback if $oldAutoCommit;
1335 #these aren't preserved
1336 foreach my $table (qw(
1337 cust_main_exemption cust_main_invoice
1339 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1340 my $error = $record->delete;
1342 $dbh->rollback if $oldAutoCommit;
1349 my $sth = $dbh->prepare(
1350 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1352 my $errstr = $dbh->errstr;
1353 $dbh->rollback if $oldAutoCommit;
1356 $sth->execute($new_custnum, $self->custnum) or do {
1357 my $errstr = $sth->errstr;
1358 $dbh->rollback if $oldAutoCommit;
1364 my $ticket_dbh = '';
1365 if ($conf->config('ticket_system') eq 'RT_Internal') {
1367 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1368 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1369 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1370 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1373 if ( $ticket_dbh ) {
1375 my $ticket_sth = $ticket_dbh->prepare(
1376 'UPDATE Links SET Target = ? WHERE Target = ?'
1378 my $errstr = $ticket_dbh->errstr;
1379 $dbh->rollback if $oldAutoCommit;
1382 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1383 'freeside://freeside/cust_main/'.$self->custnum)
1385 my $errstr = $ticket_sth->errstr;
1386 $dbh->rollback if $oldAutoCommit;
1392 #delete the customer record
1394 my $error = $self->delete;
1396 $dbh->rollback if $oldAutoCommit;
1400 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1405 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1407 Replaces the OLD_RECORD with this one in the database. If there is an error,
1408 returns the error, otherwise returns false.
1410 To change the customer's address, set the pseudo-fields C<bill_location> and
1411 C<ship_location>. The address will still only change if at least one of the
1412 address fields differs from the existing values.
1414 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1415 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1416 expected and rollback the entire transaction; it is not necessary to call
1417 check_invoicing_list first. Here's an example:
1419 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1421 Currently available options are: I<tax_exemption>.
1423 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1424 of tax names and exemption numbers. FS::cust_main_exemption records will be
1425 deleted and inserted as appropriate.
1432 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1434 : $self->replace_old;
1438 warn "$me replace called\n"
1441 my $curuser = $FS::CurrentUser::CurrentUser;
1442 if ( $self->payby eq 'COMP'
1443 && $self->payby ne $old->payby
1444 && ! $curuser->access_right('Complimentary customer')
1447 return "You are not permitted to create complimentary accounts.";
1450 local($ignore_expired_card) = 1
1451 if $old->payby =~ /^(CARD|DCRD)$/
1452 && $self->payby =~ /^(CARD|DCRD)$/
1453 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1455 local($ignore_banned_card) = 1
1456 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1457 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1458 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1460 return "Invoicing locale is required"
1463 && $conf->exists('cust_main-require_locale');
1465 local $SIG{HUP} = 'IGNORE';
1466 local $SIG{INT} = 'IGNORE';
1467 local $SIG{QUIT} = 'IGNORE';
1468 local $SIG{TERM} = 'IGNORE';
1469 local $SIG{TSTP} = 'IGNORE';
1470 local $SIG{PIPE} = 'IGNORE';
1472 my $oldAutoCommit = $FS::UID::AutoCommit;
1473 local $FS::UID::AutoCommit = 0;
1476 for my $l (qw(bill_location ship_location)) {
1477 my $old_loc = $old->$l;
1478 my $new_loc = $self->$l;
1480 # find the existing location if there is one
1481 $new_loc->set('custnum' => $self->custnum);
1482 my $error = $new_loc->find_or_insert;
1484 $dbh->rollback if $oldAutoCommit;
1487 $self->set($l.'num', $new_loc->locationnum);
1490 # replace the customer record
1491 my $error = $self->SUPER::replace($old);
1494 $dbh->rollback if $oldAutoCommit;
1498 # now move packages to the new service location
1499 $self->set('ship_location', ''); #flush cache
1500 if ( $old->ship_locationnum and # should only be null during upgrade...
1501 $old->ship_locationnum != $self->ship_locationnum ) {
1502 $error = $old->ship_location->move_to($self->ship_location);
1504 $dbh->rollback if $oldAutoCommit;
1508 # don't move packages based on the billing location, but
1509 # disable it if it's no longer in use
1510 if ( $old->bill_locationnum and
1511 $old->bill_locationnum != $self->bill_locationnum ) {
1512 $error = $old->bill_location->disable_if_unused;
1514 $dbh->rollback if $oldAutoCommit;
1519 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1520 my $invoicing_list = shift @param;
1521 $error = $self->check_invoicing_list( $invoicing_list );
1523 $dbh->rollback if $oldAutoCommit;
1526 $self->invoicing_list( $invoicing_list );
1529 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1531 #this could be more efficient than deleting and re-inserting, if it matters
1532 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1533 my $error = $cust_tag->delete;
1535 $dbh->rollback if $oldAutoCommit;
1539 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1540 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1541 'custnum' => $self->custnum };
1542 my $error = $cust_tag->insert;
1544 $dbh->rollback if $oldAutoCommit;
1551 my %options = @param;
1553 my $tax_exemption = delete $options{'tax_exemption'};
1554 if ( $tax_exemption ) {
1556 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1557 if ref($tax_exemption) eq 'ARRAY';
1559 my %cust_main_exemption =
1560 map { $_->taxname => $_ }
1561 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1563 foreach my $taxname ( keys %$tax_exemption ) {
1565 if ( $cust_main_exemption{$taxname} &&
1566 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1569 delete $cust_main_exemption{$taxname};
1573 my $cust_main_exemption = new FS::cust_main_exemption {
1574 'custnum' => $self->custnum,
1575 'taxname' => $taxname,
1576 'exempt_number' => $tax_exemption->{$taxname},
1578 my $error = $cust_main_exemption->insert;
1580 $dbh->rollback if $oldAutoCommit;
1581 return "inserting cust_main_exemption (transaction rolled back): $error";
1585 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1586 my $error = $cust_main_exemption->delete;
1588 $dbh->rollback if $oldAutoCommit;
1589 return "deleting cust_main_exemption (transaction rolled back): $error";
1595 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1596 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1597 && $self->get('payinfo') !~ /^99\d{14}$/
1599 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1604 # card/check/lec info has changed, want to retry realtime_ invoice events
1605 my $error = $self->retry_realtime;
1607 $dbh->rollback if $oldAutoCommit;
1612 unless ( $import || $skip_fuzzyfiles ) {
1613 $error = $self->queue_fuzzyfiles_update;
1615 $dbh->rollback if $oldAutoCommit;
1616 return "updating fuzzy search cache: $error";
1620 # tax district update in cust_location
1622 # cust_main exports!
1624 my $export_args = $options{'export_args'} || [];
1627 map qsearch( 'part_export', {exportnum=>$_} ),
1628 $conf->config('cust_main-exports'); #, $agentnum
1630 foreach my $part_export ( @part_export ) {
1631 my $error = $part_export->export_replace( $self, $old, @$export_args);
1633 $dbh->rollback if $oldAutoCommit;
1634 return "exporting to ". $part_export->exporttype.
1635 " (transaction rolled back): $error";
1639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1644 =item queue_fuzzyfiles_update
1646 Used by insert & replace to update the fuzzy search cache
1650 use FS::cust_main::Search;
1651 sub queue_fuzzyfiles_update {
1654 local $SIG{HUP} = 'IGNORE';
1655 local $SIG{INT} = 'IGNORE';
1656 local $SIG{QUIT} = 'IGNORE';
1657 local $SIG{TERM} = 'IGNORE';
1658 local $SIG{TSTP} = 'IGNORE';
1659 local $SIG{PIPE} = 'IGNORE';
1661 my $oldAutoCommit = $FS::UID::AutoCommit;
1662 local $FS::UID::AutoCommit = 0;
1665 my @locations = $self->bill_location;
1666 push @locations, $self->ship_location if $self->has_ship_address;
1667 foreach my $location (@locations) {
1668 my $queue = new FS::queue {
1669 'job' => 'FS::cust_main::Search::append_fuzzyfiles'
1671 my @args = map $location->get($_), @FS::cust_main::Search::fuzzyfields;
1672 my $error = $queue->insert( @args );
1674 $dbh->rollback if $oldAutoCommit;
1675 return "queueing job (transaction rolled back): $error";
1679 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1686 Checks all fields to make sure this is a valid customer record. If there is
1687 an error, returns the error, otherwise returns false. Called by the insert
1688 and replace methods.
1695 warn "$me check BEFORE: \n". $self->_dump
1699 $self->ut_numbern('custnum')
1700 || $self->ut_number('agentnum')
1701 || $self->ut_textn('agent_custid')
1702 || $self->ut_number('refnum')
1703 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1704 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1705 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1706 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1707 || $self->ut_textn('custbatch')
1708 || $self->ut_name('last')
1709 || $self->ut_name('first')
1710 || $self->ut_snumbern('signupdate')
1711 || $self->ut_snumbern('birthdate')
1712 || $self->ut_snumbern('spouse_birthdate')
1713 || $self->ut_snumbern('anniversary_date')
1714 || $self->ut_textn('company')
1715 || $self->ut_anything('comments')
1716 || $self->ut_numbern('referral_custnum')
1717 || $self->ut_textn('stateid')
1718 || $self->ut_textn('stateid_state')
1719 || $self->ut_textn('invoice_terms')
1720 || $self->ut_floatn('cdr_termination_percentage')
1721 || $self->ut_floatn('credit_limit')
1722 || $self->ut_numbern('billday')
1723 || $self->ut_numbern('prorate_day')
1724 || $self->ut_flag('edit_subject')
1725 || $self->ut_flag('calling_list_exempt')
1726 || $self->ut_flag('invoice_noemail')
1727 || $self->ut_flag('message_noemail')
1728 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1729 || $self->ut_currencyn('currency')
1732 my $company = $self->company;
1733 $company =~ s/^\s+//;
1734 $company =~ s/\s+$//;
1735 $company =~ s/\s+/ /g;
1736 $self->company($company);
1738 #barf. need message catalogs. i18n. etc.
1739 $error .= "Please select an advertising source."
1740 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1741 return $error if $error;
1743 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1744 or return "Unknown agent";
1746 if ( $self->currency ) {
1747 my $agent_currency = qsearchs( 'agent_currency', {
1748 'agentnum' => $agent->agentnum,
1749 'currency' => $self->currency,
1751 or return "Agent ". $agent->agent.
1752 " not permitted to offer ". $self->currency. " invoicing";
1755 return "Unknown refnum"
1756 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1758 return "Unknown referring custnum: ". $self->referral_custnum
1759 unless ! $self->referral_custnum
1760 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1762 if ( $self->ss eq '' ) {
1767 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1768 or return "Illegal social security number: ". $self->ss;
1769 $self->ss("$1-$2-$3");
1772 # cust_main_county verification now handled by cust_location check
1775 $self->ut_phonen('daytime', $self->country)
1776 || $self->ut_phonen('night', $self->country)
1777 || $self->ut_phonen('fax', $self->country)
1778 || $self->ut_phonen('mobile', $self->country)
1780 return $error if $error;
1782 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1784 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1787 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1789 : FS::Msgcat::_gettext('daytime');
1790 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1792 : FS::Msgcat::_gettext('night');
1794 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1796 : FS::Msgcat::_gettext('mobile');
1798 return "$daytime_label, $night_label or $mobile_label is required"
1802 ### start of stuff moved to cust_payby
1803 # then mostly kept here to support upgrades (can remove in 5.x)
1804 # but modified to allow everything to be empty
1806 if ( $self->payby ) {
1807 FS::payby->can_payby($self->table, $self->payby)
1808 or return "Illegal payby: ". $self->payby;
1813 $error = $self->ut_numbern('paystart_month')
1814 || $self->ut_numbern('paystart_year')
1815 || $self->ut_numbern('payissue')
1816 || $self->ut_textn('paytype')
1818 return $error if $error;
1820 if ( $self->payip eq '' ) {
1823 $error = $self->ut_ip('payip');
1824 return $error if $error;
1827 # If it is encrypted and the private key is not availaible then we can't
1828 # check the credit card.
1829 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1831 # Need some kind of global flag to accept invalid cards, for testing
1833 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1834 $self->payby =~ /^(CARD|DCRD)$/ ) {
1836 my $payinfo = $self->payinfo;
1837 $payinfo =~ s/\D//g;
1838 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1839 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1841 $self->payinfo($payinfo);
1843 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1845 return gettext('unknown_card_type')
1846 if $self->payinfo !~ /^99\d{14}$/ #token
1847 && cardtype($self->payinfo) eq "Unknown";
1849 unless ( $ignore_banned_card ) {
1850 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1852 if ( $ban->bantype eq 'warn' ) {
1853 #or others depending on value of $ban->reason ?
1854 return '_duplicate_card'.
1855 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1856 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1857 ' (ban# '. $ban->bannum. ')'
1858 unless $self->override_ban_warn;
1860 return 'Banned credit card: banned on '.
1861 time2str('%a %h %o at %r', $ban->_date).
1862 ' by '. $ban->otaker.
1863 ' (ban# '. $ban->bannum. ')';
1868 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1869 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1870 $self->paycvv =~ /^(\d{4})$/
1871 or return "CVV2 (CID) for American Express cards is four digits.";
1874 $self->paycvv =~ /^(\d{3})$/
1875 or return "CVV2 (CVC2/CID) is three digits.";
1882 my $cardtype = cardtype($payinfo);
1883 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1885 return "Start date or issue number is required for $cardtype cards"
1886 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1888 return "Start month must be between 1 and 12"
1889 if $self->paystart_month
1890 and $self->paystart_month < 1 || $self->paystart_month > 12;
1892 return "Start year must be 1990 or later"
1893 if $self->paystart_year
1894 and $self->paystart_year < 1990;
1896 return "Issue number must be beween 1 and 99"
1898 and $self->payissue < 1 || $self->payissue > 99;
1901 $self->paystart_month('');
1902 $self->paystart_year('');
1903 $self->payissue('');
1906 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1907 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1909 my $payinfo = $self->payinfo;
1910 $payinfo =~ s/[^\d\@\.]//g;
1911 if ( $conf->config('echeck-country') eq 'CA' ) {
1912 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1913 or return 'invalid echeck account@branch.bank';
1914 $payinfo = "$1\@$2.$3";
1915 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1916 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1917 $payinfo = "$1\@$2";
1919 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1920 $payinfo = "$1\@$2";
1922 $self->payinfo($payinfo);
1925 unless ( $ignore_banned_card ) {
1926 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1928 if ( $ban->bantype eq 'warn' ) {
1929 #or others depending on value of $ban->reason ?
1930 return '_duplicate_ach' unless $self->override_ban_warn;
1932 return 'Banned ACH account: banned on '.
1933 time2str('%a %h %o at %r', $ban->_date).
1934 ' by '. $ban->otaker.
1935 ' (ban# '. $ban->bannum. ')';
1940 } elsif ( $self->payby eq 'LECB' ) {
1942 my $payinfo = $self->payinfo;
1943 $payinfo =~ s/\D//g;
1944 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1946 $self->payinfo($payinfo);
1949 } elsif ( $self->payby eq 'BILL' ) {
1951 $error = $self->ut_textn('payinfo');
1952 return "Illegal P.O. number: ". $self->payinfo if $error;
1955 } elsif ( $self->payby eq 'COMP' ) {
1957 my $curuser = $FS::CurrentUser::CurrentUser;
1958 if ( ! $self->custnum
1959 && ! $curuser->access_right('Complimentary customer')
1962 return "You are not permitted to create complimentary accounts."
1965 $error = $self->ut_textn('payinfo');
1966 return "Illegal comp account issuer: ". $self->payinfo if $error;
1969 } elsif ( $self->payby eq 'PREPAY' ) {
1971 my $payinfo = $self->payinfo;
1972 $payinfo =~ s/\W//g; #anything else would just confuse things
1973 $self->payinfo($payinfo);
1974 $error = $self->ut_alpha('payinfo');
1975 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1976 return "Unknown prepayment identifier"
1977 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1982 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1983 return "Expiration date required"
1984 # shouldn't payinfo_check do this?
1985 unless ! $self->payby
1986 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
1990 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1991 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1992 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1993 ( $m, $y ) = ( $2, "19$1" );
1994 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1995 ( $m, $y ) = ( $3, "20$2" );
1997 return "Illegal expiration date: ". $self->paydate;
1999 $m = sprintf('%02d',$m);
2000 $self->paydate("$y-$m-01");
2001 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2002 return gettext('expired_card')
2004 && !$ignore_expired_card
2005 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2008 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2009 ( ! $conf->exists('require_cardname')
2010 || $self->payby !~ /^(CARD|DCRD)$/ )
2012 $self->payname( $self->first. " ". $self->getfield('last') );
2014 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2015 or return gettext('illegal_name'). " payname: ". $self->payname;
2019 ### end of stuff moved to cust_payby
2021 return "Please select an invoicing locale"
2024 && $conf->exists('cust_main-require_locale');
2026 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2027 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2031 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2033 warn "$me check AFTER: \n". $self->_dump
2036 $self->SUPER::check;
2041 Returns a list of fields which have ship_ duplicates.
2046 qw( last first company
2047 address1 address2 city county state zip country
2049 daytime night fax mobile
2053 =item has_ship_address
2055 Returns true if this customer record has a separate shipping address.
2059 sub has_ship_address {
2061 $self->bill_locationnum != $self->ship_locationnum;
2066 Returns a list of key/value pairs, with the following keys: address1,
2067 adddress2, city, county, state, zip, country, district, and geocode. The
2068 shipping address is used if present.
2074 $self->ship_location->location_hash;
2079 Returns all locations (see L<FS::cust_location>) for this customer.
2085 qsearch('cust_location', { 'custnum' => $self->custnum,
2086 'prospectnum' => '' } );
2091 Returns all contacts (see L<FS::contact>) for this customer.
2095 #already used :/ sub contact {
2098 qsearch('contact', { 'custnum' => $self->custnum } );
2103 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2110 'table' => 'cust_payby',
2111 'hashref' => { 'custnum' => $self->custnum },
2112 'order_by' => 'ORDER BY weight ASC',
2118 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2119 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2120 on success or a list of errors.
2126 grep { $_->unsuspend } $self->suspended_pkgs;
2131 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2133 Returns a list: an empty list on success or a list of errors.
2139 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2142 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2144 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2145 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2146 of a list of pkgparts; the hashref has the following keys:
2150 =item pkgparts - listref of pkgparts
2152 =item (other options are passed to the suspend method)
2157 Returns a list: an empty list on success or a list of errors.
2161 sub suspend_if_pkgpart {
2163 my (@pkgparts, %opt);
2164 if (ref($_[0]) eq 'HASH'){
2165 @pkgparts = @{$_[0]{pkgparts}};
2170 grep { $_->suspend(%opt) }
2171 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2172 $self->unsuspended_pkgs;
2175 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2177 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2178 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2179 instead of a list of pkgparts; the hashref has the following keys:
2183 =item pkgparts - listref of pkgparts
2185 =item (other options are passed to the suspend method)
2189 Returns a list: an empty list on success or a list of errors.
2193 sub suspend_unless_pkgpart {
2195 my (@pkgparts, %opt);
2196 if (ref($_[0]) eq 'HASH'){
2197 @pkgparts = @{$_[0]{pkgparts}};
2202 grep { $_->suspend(%opt) }
2203 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2204 $self->unsuspended_pkgs;
2207 =item cancel [ OPTION => VALUE ... ]
2209 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2211 Available options are:
2215 =item quiet - can be set true to supress email cancellation notices.
2217 =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.
2219 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2221 =item nobill - can be set true to skip billing if it might otherwise be done.
2225 Always returns a list: an empty list on success or a list of errors.
2229 # nb that dates are not specified as valid options to this method
2232 my( $self, %opt ) = @_;
2234 warn "$me cancel called on customer ". $self->custnum. " with options ".
2235 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2238 return ( 'access denied' )
2239 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2241 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2243 #should try decryption (we might have the private key)
2244 # and if not maybe queue a job for the server that does?
2245 return ( "Can't (yet) ban encrypted credit cards" )
2246 if $self->is_encrypted($self->payinfo);
2248 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2249 my $error = $ban->insert;
2250 return ( $error ) if $error;
2254 my @pkgs = $self->ncancelled_pkgs;
2256 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2258 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2259 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2263 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2264 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2267 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2270 sub _banned_pay_hashref {
2281 'payby' => $payby2ban{$self->payby},
2282 'payinfo' => $self->payinfo,
2283 #don't ever *search* on reason! #'reason' =>
2287 sub _new_banned_pay_hashref {
2289 my $hr = $self->_banned_pay_hashref;
2290 $hr->{payinfo} = md5_base64($hr->{payinfo});
2296 Returns all notes (see L<FS::cust_main_note>) for this customer.
2301 my($self,$orderby_classnum) = (shift,shift);
2302 my $orderby = "_DATE DESC";
2303 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2304 qsearch( 'cust_main_note',
2305 { 'custnum' => $self->custnum },
2307 "ORDER BY $orderby",
2313 Returns the agent (see L<FS::agent>) for this customer.
2319 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2324 Returns the agent name (see L<FS::agent>) for this customer.
2330 $self->agent->agent;
2335 Returns any tags associated with this customer, as FS::cust_tag objects,
2336 or an empty list if there are no tags.
2342 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2347 Returns any tags associated with this customer, as FS::part_tag objects,
2348 or an empty list if there are no tags.
2354 map $_->part_tag, $self->cust_tag;
2360 Returns the customer class, as an FS::cust_class object, or the empty string
2361 if there is no customer class.
2367 if ( $self->classnum ) {
2368 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2376 Returns the customer category name, or the empty string if there is no customer
2383 my $cust_class = $self->cust_class;
2385 ? $cust_class->categoryname
2391 Returns the customer class name, or the empty string if there is no customer
2398 my $cust_class = $self->cust_class;
2400 ? $cust_class->classname
2404 =item BILLING METHODS
2406 Documentation on billing methods has been moved to
2407 L<FS::cust_main::Billing>.
2409 =item REALTIME BILLING METHODS
2411 Documentation on realtime billing methods has been moved to
2412 L<FS::cust_main::Billing_Realtime>.
2416 Removes the I<paycvv> field from the database directly.
2418 If there is an error, returns the error, otherwise returns false.
2424 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2425 or return dbh->errstr;
2426 $sth->execute($self->custnum)
2427 or return $sth->errstr;
2432 =item batch_card OPTION => VALUE...
2434 Adds a payment for this invoice to the pending credit card batch (see
2435 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2436 runs the payment using a realtime gateway.
2438 Options may include:
2440 B<amount>: the amount to be paid; defaults to the customer's balance minus
2441 any payments in transit.
2443 B<payby>: the payment method; defaults to cust_main.payby
2445 B<realtime>: runs this as a realtime payment instead of adding it to a
2448 B<invnum>: sets cust_pay_batch.invnum.
2450 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2451 the billing address for the payment; defaults to the customer's billing
2454 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2455 date, and name; defaults to those fields in cust_main.
2460 my ($self, %options) = @_;
2463 if (exists($options{amount})) {
2464 $amount = $options{amount};
2466 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2468 return '' unless $amount > 0;
2470 my $invnum = delete $options{invnum};
2471 my $payby = $options{payby} || $self->payby; #still dubious
2473 if ($options{'realtime'}) {
2474 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2480 my $oldAutoCommit = $FS::UID::AutoCommit;
2481 local $FS::UID::AutoCommit = 0;
2484 #this needs to handle mysql as well as Pg, like svc_acct.pm
2485 #(make it into a common function if folks need to do batching with mysql)
2486 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2487 or return "Cannot lock pay_batch: " . $dbh->errstr;
2491 'payby' => FS::payby->payby2payment($payby),
2493 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2495 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2497 unless ( $pay_batch ) {
2498 $pay_batch = new FS::pay_batch \%pay_batch;
2499 my $error = $pay_batch->insert;
2501 $dbh->rollback if $oldAutoCommit;
2502 die "error creating new batch: $error\n";
2506 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2507 'batchnum' => $pay_batch->batchnum,
2508 'custnum' => $self->custnum,
2511 foreach (qw( address1 address2 city state zip country latitude longitude
2512 payby payinfo paydate payname ))
2514 $options{$_} = '' unless exists($options{$_});
2517 my $loc = $self->bill_location;
2519 my $cust_pay_batch = new FS::cust_pay_batch ( {
2520 'batchnum' => $pay_batch->batchnum,
2521 'invnum' => $invnum || 0, # is there a better value?
2522 # this field should be
2524 # cust_bill_pay_batch now
2525 'custnum' => $self->custnum,
2526 'last' => $self->getfield('last'),
2527 'first' => $self->getfield('first'),
2528 'address1' => $options{address1} || $loc->address1,
2529 'address2' => $options{address2} || $loc->address2,
2530 'city' => $options{city} || $loc->city,
2531 'state' => $options{state} || $loc->state,
2532 'zip' => $options{zip} || $loc->zip,
2533 'country' => $options{country} || $loc->country,
2534 'payby' => $options{payby} || $self->payby,
2535 'payinfo' => $options{payinfo} || $self->payinfo,
2536 'exp' => $options{paydate} || $self->paydate,
2537 'payname' => $options{payname} || $self->payname,
2538 'amount' => $amount, # consolidating
2541 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2542 if $old_cust_pay_batch;
2545 if ($old_cust_pay_batch) {
2546 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2548 $error = $cust_pay_batch->insert;
2552 $dbh->rollback if $oldAutoCommit;
2556 my $unapplied = $self->total_unapplied_credits
2557 + $self->total_unapplied_payments
2558 + $self->in_transit_payments;
2559 foreach my $cust_bill ($self->open_cust_bill) {
2560 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2561 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2562 'invnum' => $cust_bill->invnum,
2563 'paybatchnum' => $cust_pay_batch->paybatchnum,
2564 'amount' => $cust_bill->owed,
2567 if ($unapplied >= $cust_bill_pay_batch->amount){
2568 $unapplied -= $cust_bill_pay_batch->amount;
2571 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2572 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2574 $error = $cust_bill_pay_batch->insert;
2576 $dbh->rollback if $oldAutoCommit;
2581 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2587 Returns the total owed for this customer on all invoices
2588 (see L<FS::cust_bill/owed>).
2594 $self->total_owed_date(2145859200); #12/31/2037
2597 =item total_owed_date TIME
2599 Returns the total owed for this customer on all invoices with date earlier than
2600 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2601 see L<Time::Local> and L<Date::Parse> for conversion functions.
2605 sub total_owed_date {
2609 my $custnum = $self->custnum;
2611 my $owed_sql = FS::cust_bill->owed_sql;
2614 SELECT SUM($owed_sql) FROM cust_bill
2615 WHERE custnum = $custnum
2619 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2623 =item total_owed_pkgnum PKGNUM
2625 Returns the total owed on all invoices for this customer's specific package
2626 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2630 sub total_owed_pkgnum {
2631 my( $self, $pkgnum ) = @_;
2632 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2635 =item total_owed_date_pkgnum TIME PKGNUM
2637 Returns the total owed for this customer's specific package when using
2638 experimental package balances on all invoices with date earlier than
2639 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2640 see L<Time::Local> and L<Date::Parse> for conversion functions.
2644 sub total_owed_date_pkgnum {
2645 my( $self, $time, $pkgnum ) = @_;
2648 foreach my $cust_bill (
2649 grep { $_->_date <= $time }
2650 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2652 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2654 sprintf( "%.2f", $total_bill );
2660 Returns the total amount of all payments.
2667 $total += $_->paid foreach $self->cust_pay;
2668 sprintf( "%.2f", $total );
2671 =item total_unapplied_credits
2673 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2674 customer. See L<FS::cust_credit/credited>.
2676 =item total_credited
2678 Old name for total_unapplied_credits. Don't use.
2682 sub total_credited {
2683 #carp "total_credited deprecated, use total_unapplied_credits";
2684 shift->total_unapplied_credits(@_);
2687 sub total_unapplied_credits {
2690 my $custnum = $self->custnum;
2692 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2695 SELECT SUM($unapplied_sql) FROM cust_credit
2696 WHERE custnum = $custnum
2699 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2703 =item total_unapplied_credits_pkgnum PKGNUM
2705 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2706 customer. See L<FS::cust_credit/credited>.
2710 sub total_unapplied_credits_pkgnum {
2711 my( $self, $pkgnum ) = @_;
2712 my $total_credit = 0;
2713 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2714 sprintf( "%.2f", $total_credit );
2718 =item total_unapplied_payments
2720 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2721 See L<FS::cust_pay/unapplied>.
2725 sub total_unapplied_payments {
2728 my $custnum = $self->custnum;
2730 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2733 SELECT SUM($unapplied_sql) FROM cust_pay
2734 WHERE custnum = $custnum
2737 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2741 =item total_unapplied_payments_pkgnum PKGNUM
2743 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2744 specific package when using experimental package balances. See
2745 L<FS::cust_pay/unapplied>.
2749 sub total_unapplied_payments_pkgnum {
2750 my( $self, $pkgnum ) = @_;
2751 my $total_unapplied = 0;
2752 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2753 sprintf( "%.2f", $total_unapplied );
2757 =item total_unapplied_refunds
2759 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2760 customer. See L<FS::cust_refund/unapplied>.
2764 sub total_unapplied_refunds {
2766 my $custnum = $self->custnum;
2768 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2771 SELECT SUM($unapplied_sql) FROM cust_refund
2772 WHERE custnum = $custnum
2775 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2781 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2782 total_unapplied_credits minus total_unapplied_payments).
2788 $self->balance_date_range;
2791 =item balance_date TIME
2793 Returns the balance for this customer, only considering invoices with date
2794 earlier than TIME (total_owed_date minus total_credited minus
2795 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2796 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2803 $self->balance_date_range(shift);
2806 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2808 Returns the balance for this customer, optionally considering invoices with
2809 date earlier than START_TIME, and not later than END_TIME
2810 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2812 Times are specified as SQL fragments or numeric
2813 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2814 L<Date::Parse> for conversion functions. The empty string can be passed
2815 to disable that time constraint completely.
2817 Available options are:
2821 =item unapplied_date
2823 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)
2829 sub balance_date_range {
2831 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2832 ') FROM cust_main WHERE custnum='. $self->custnum;
2833 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2836 =item balance_pkgnum PKGNUM
2838 Returns the balance for this customer's specific package when using
2839 experimental package balances (total_owed plus total_unrefunded, minus
2840 total_unapplied_credits minus total_unapplied_payments)
2844 sub balance_pkgnum {
2845 my( $self, $pkgnum ) = @_;
2848 $self->total_owed_pkgnum($pkgnum)
2849 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2850 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2851 - $self->total_unapplied_credits_pkgnum($pkgnum)
2852 - $self->total_unapplied_payments_pkgnum($pkgnum)
2856 =item in_transit_payments
2858 Returns the total of requests for payments for this customer pending in
2859 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2863 sub in_transit_payments {
2865 my $in_transit_payments = 0;
2866 foreach my $pay_batch ( qsearch('pay_batch', {
2869 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2870 'batchnum' => $pay_batch->batchnum,
2871 'custnum' => $self->custnum,
2873 $in_transit_payments += $cust_pay_batch->amount;
2876 sprintf( "%.2f", $in_transit_payments );
2881 Returns a hash of useful information for making a payment.
2891 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2892 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2893 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2897 For credit card transactions:
2909 For electronic check transactions:
2924 $return{balance} = $self->balance;
2926 $return{payname} = $self->payname
2927 || ( $self->first. ' '. $self->get('last') );
2929 $return{$_} = $self->bill_location->$_
2930 for qw(address1 address2 city state zip);
2932 $return{payby} = $self->payby;
2933 $return{stateid_state} = $self->stateid_state;
2935 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2936 $return{card_type} = cardtype($self->payinfo);
2937 $return{payinfo} = $self->paymask;
2939 @return{'month', 'year'} = $self->paydate_monthyear;
2943 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2944 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2945 $return{payinfo1} = $payinfo1;
2946 $return{payinfo2} = $payinfo2;
2947 $return{paytype} = $self->paytype;
2948 $return{paystate} = $self->paystate;
2952 #doubleclick protection
2954 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2960 =item paydate_monthyear
2962 Returns a two-element list consisting of the month and year of this customer's
2963 paydate (credit card expiration date for CARD customers)
2967 sub paydate_monthyear {
2969 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2971 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2980 Returns the exact time in seconds corresponding to the payment method
2981 expiration date. For CARD/DCRD customers this is the end of the month;
2982 for others (COMP is the only other payby that uses paydate) it's the start.
2983 Returns 0 if the paydate is empty or set to the far future.
2989 my ($month, $year) = $self->paydate_monthyear;
2990 return 0 if !$year or $year >= 2037;
2991 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2993 if ( $month == 13 ) {
2997 return timelocal(0,0,0,1,$month-1,$year) - 1;
3000 return timelocal(0,0,0,1,$month-1,$year);
3004 =item paydate_epoch_sql
3006 Class method. Returns an SQL expression to obtain the payment expiration date
3007 as a number of seconds.
3011 # Special expiration date behavior for non-CARD/DCRD customers has been
3012 # carefully preserved. Do we really use that?
3013 sub paydate_epoch_sql {
3015 my $table = shift || 'cust_main';
3016 my ($case1, $case2);
3017 if ( driver_name eq 'Pg' ) {
3018 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3019 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3021 elsif ( lc(driver_name) eq 'mysql' ) {
3022 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3023 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3026 return "CASE WHEN $table.payby IN('CARD','DCRD')
3032 =item tax_exemption TAXNAME
3037 my( $self, $taxname ) = @_;
3039 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3040 'taxname' => $taxname,
3045 =item cust_main_exemption
3049 sub cust_main_exemption {
3051 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3054 =item invoicing_list [ ARRAYREF ]
3056 If an arguement is given, sets these email addresses as invoice recipients
3057 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3058 (except as warnings), so use check_invoicing_list first.
3060 Returns a list of email addresses (with svcnum entries expanded).
3062 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3063 check it without disturbing anything by passing nothing.
3065 This interface may change in the future.
3069 sub invoicing_list {
3070 my( $self, $arrayref ) = @_;
3073 my @cust_main_invoice;
3074 if ( $self->custnum ) {
3075 @cust_main_invoice =
3076 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3078 @cust_main_invoice = ();
3080 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3081 #warn $cust_main_invoice->destnum;
3082 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3083 #warn $cust_main_invoice->destnum;
3084 my $error = $cust_main_invoice->delete;
3085 warn $error if $error;
3088 if ( $self->custnum ) {
3089 @cust_main_invoice =
3090 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3092 @cust_main_invoice = ();
3094 my %seen = map { $_->address => 1 } @cust_main_invoice;
3095 foreach my $address ( @{$arrayref} ) {
3096 next if exists $seen{$address} && $seen{$address};
3097 $seen{$address} = 1;
3098 my $cust_main_invoice = new FS::cust_main_invoice ( {
3099 'custnum' => $self->custnum,
3102 my $error = $cust_main_invoice->insert;
3103 warn $error if $error;
3107 if ( $self->custnum ) {
3109 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3116 =item check_invoicing_list ARRAYREF
3118 Checks these arguements as valid input for the invoicing_list method. If there
3119 is an error, returns the error, otherwise returns false.
3123 sub check_invoicing_list {
3124 my( $self, $arrayref ) = @_;
3126 foreach my $address ( @$arrayref ) {
3128 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3129 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3132 my $cust_main_invoice = new FS::cust_main_invoice ( {
3133 'custnum' => $self->custnum,
3136 my $error = $self->custnum
3137 ? $cust_main_invoice->check
3138 : $cust_main_invoice->checkdest
3140 return $error if $error;
3144 return "Email address required"
3145 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3146 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3151 =item set_default_invoicing_list
3153 Sets the invoicing list to all accounts associated with this customer,
3154 overwriting any previous invoicing list.
3158 sub set_default_invoicing_list {
3160 $self->invoicing_list($self->all_emails);
3165 Returns the email addresses of all accounts provisioned for this customer.
3172 foreach my $cust_pkg ( $self->all_pkgs ) {
3173 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3175 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3176 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3178 $list{$_}=1 foreach map { $_->email } @svc_acct;
3183 =item invoicing_list_addpost
3185 Adds postal invoicing to this customer. If this customer is already configured
3186 to receive postal invoices, does nothing.
3190 sub invoicing_list_addpost {
3192 return if grep { $_ eq 'POST' } $self->invoicing_list;
3193 my @invoicing_list = $self->invoicing_list;
3194 push @invoicing_list, 'POST';
3195 $self->invoicing_list(\@invoicing_list);
3198 =item invoicing_list_emailonly
3200 Returns the list of email invoice recipients (invoicing_list without non-email
3201 destinations such as POST and FAX).
3205 sub invoicing_list_emailonly {
3207 warn "$me invoicing_list_emailonly called"
3209 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3212 =item invoicing_list_emailonly_scalar
3214 Returns the list of email invoice recipients (invoicing_list without non-email
3215 destinations such as POST and FAX) as a comma-separated scalar.
3219 sub invoicing_list_emailonly_scalar {
3221 warn "$me invoicing_list_emailonly_scalar called"
3223 join(', ', $self->invoicing_list_emailonly);
3226 =item referral_custnum_cust_main
3228 Returns the customer who referred this customer (or the empty string, if
3229 this customer was not referred).
3231 Note the difference with referral_cust_main method: This method,
3232 referral_custnum_cust_main returns the single customer (if any) who referred
3233 this customer, while referral_cust_main returns an array of customers referred
3238 sub referral_custnum_cust_main {
3240 return '' unless $self->referral_custnum;
3241 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3244 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3246 Returns an array of customers referred by this customer (referral_custnum set
3247 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3248 customers referred by customers referred by this customer and so on, inclusive.
3249 The default behavior is DEPTH 1 (no recursion).
3251 Note the difference with referral_custnum_cust_main method: This method,
3252 referral_cust_main, returns an array of customers referred BY this customer,
3253 while referral_custnum_cust_main returns the single customer (if any) who
3254 referred this customer.
3258 sub referral_cust_main {
3260 my $depth = @_ ? shift : 1;
3261 my $exclude = @_ ? shift : {};
3264 map { $exclude->{$_->custnum}++; $_; }
3265 grep { ! $exclude->{ $_->custnum } }
3266 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3270 map { $_->referral_cust_main($depth-1, $exclude) }
3277 =item referral_cust_main_ncancelled
3279 Same as referral_cust_main, except only returns customers with uncancelled
3284 sub referral_cust_main_ncancelled {
3286 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3289 =item referral_cust_pkg [ DEPTH ]
3291 Like referral_cust_main, except returns a flat list of all unsuspended (and
3292 uncancelled) packages for each customer. The number of items in this list may
3293 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3297 sub referral_cust_pkg {
3299 my $depth = @_ ? shift : 1;
3301 map { $_->unsuspended_pkgs }
3302 grep { $_->unsuspended_pkgs }
3303 $self->referral_cust_main($depth);
3306 =item referring_cust_main
3308 Returns the single cust_main record for the customer who referred this customer
3309 (referral_custnum), or false.
3313 sub referring_cust_main {
3315 return '' unless $self->referral_custnum;
3316 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3319 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3321 Applies a credit to this customer. If there is an error, returns the error,
3322 otherwise returns false.
3324 REASON can be a text string, an FS::reason object, or a scalar reference to
3325 a reasonnum. If a text string, it will be automatically inserted as a new
3326 reason, and a 'reason_type' option must be passed to indicate the
3327 FS::reason_type for the new reason.
3329 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3330 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3331 I<commission_pkgnum>.
3333 Any other options are passed to FS::cust_credit::insert.
3338 my( $self, $amount, $reason, %options ) = @_;
3340 my $cust_credit = new FS::cust_credit {
3341 'custnum' => $self->custnum,
3342 'amount' => $amount,
3345 if ( ref($reason) ) {
3347 if ( ref($reason) eq 'SCALAR' ) {
3348 $cust_credit->reasonnum( $$reason );
3350 $cust_credit->reasonnum( $reason->reasonnum );
3354 $cust_credit->set('reason', $reason)
3357 $cust_credit->$_( delete $options{$_} )
3358 foreach grep exists($options{$_}),
3359 qw( addlinfo eventnum ),
3360 map "commission_$_", qw( agentnum salesnum pkgnum );
3362 $cust_credit->insert(%options);
3366 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3368 Creates a one-time charge for this customer. If there is an error, returns
3369 the error, otherwise returns false.
3371 New-style, with a hashref of options:
3373 my $error = $cust_main->charge(
3377 'start_date' => str2time('7/4/2009'),
3378 'pkg' => 'Description',
3379 'comment' => 'Comment',
3380 'additional' => [], #extra invoice detail
3381 'classnum' => 1, #pkg_class
3383 'setuptax' => '', # or 'Y' for tax exempt
3385 'locationnum'=> 1234, # optional
3388 'taxclass' => 'Tax class',
3391 'taxproduct' => 2, #part_pkg_taxproduct
3392 'override' => {}, #XXX describe
3394 #will be filled in with the new object
3395 'cust_pkg_ref' => \$cust_pkg,
3397 #generate an invoice immediately
3399 'invoice_terms' => '', #with these terms
3405 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3411 my ( $amount, $quantity, $start_date, $classnum );
3412 my ( $pkg, $comment, $additional );
3413 my ( $setuptax, $taxclass ); #internal taxes
3414 my ( $taxproduct, $override ); #vendor (CCH) taxes
3416 my $cust_pkg_ref = '';
3417 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3419 if ( ref( $_[0] ) ) {
3420 $amount = $_[0]->{amount};
3421 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3422 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3423 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3424 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3425 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3426 : '$'. sprintf("%.2f",$amount);
3427 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3428 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3429 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3430 $additional = $_[0]->{additional} || [];
3431 $taxproduct = $_[0]->{taxproductnum};
3432 $override = { '' => $_[0]->{tax_override} };
3433 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3434 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3435 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3436 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3441 $pkg = @_ ? shift : 'One-time charge';
3442 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3444 $taxclass = @_ ? shift : '';
3448 local $SIG{HUP} = 'IGNORE';
3449 local $SIG{INT} = 'IGNORE';
3450 local $SIG{QUIT} = 'IGNORE';
3451 local $SIG{TERM} = 'IGNORE';
3452 local $SIG{TSTP} = 'IGNORE';
3453 local $SIG{PIPE} = 'IGNORE';
3455 my $oldAutoCommit = $FS::UID::AutoCommit;
3456 local $FS::UID::AutoCommit = 0;
3459 my $part_pkg = new FS::part_pkg ( {
3461 'comment' => $comment,
3465 'classnum' => ( $classnum ? $classnum : '' ),
3466 'setuptax' => $setuptax,
3467 'taxclass' => $taxclass,
3468 'taxproductnum' => $taxproduct,
3471 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3472 ( 0 .. @$additional - 1 )
3474 'additional_count' => scalar(@$additional),
3475 'setup_fee' => $amount,
3478 my $error = $part_pkg->insert( options => \%options,
3479 tax_overrides => $override,
3482 $dbh->rollback if $oldAutoCommit;
3486 my $pkgpart = $part_pkg->pkgpart;
3487 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3488 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3489 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3490 $error = $type_pkgs->insert;
3492 $dbh->rollback if $oldAutoCommit;
3497 my $cust_pkg = new FS::cust_pkg ( {
3498 'custnum' => $self->custnum,
3499 'pkgpart' => $pkgpart,
3500 'quantity' => $quantity,
3501 'start_date' => $start_date,
3502 'no_auto' => $no_auto,
3503 'locationnum'=> $locationnum,
3506 $error = $cust_pkg->insert;
3508 $dbh->rollback if $oldAutoCommit;
3510 } elsif ( $cust_pkg_ref ) {
3511 ${$cust_pkg_ref} = $cust_pkg;
3515 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3516 'pkg_list' => [ $cust_pkg ],
3519 $dbh->rollback if $oldAutoCommit;
3524 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3529 #=item charge_postal_fee
3531 #Applies a one time charge this customer. If there is an error,
3532 #returns the error, returns the cust_pkg charge object or false
3533 #if there was no charge.
3537 # This should be a customer event. For that to work requires that bill
3538 # also be a customer event.
3540 sub charge_postal_fee {
3543 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3544 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3546 my $cust_pkg = new FS::cust_pkg ( {
3547 'custnum' => $self->custnum,
3548 'pkgpart' => $pkgpart,
3552 my $error = $cust_pkg->insert;
3553 $error ? $error : $cust_pkg;
3556 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3558 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3560 Optionally, a list or hashref of additional arguments to the qsearch call can
3567 my $opt = ref($_[0]) ? shift : { @_ };
3569 #return $self->num_cust_bill unless wantarray || keys %$opt;
3571 $opt->{'table'} = 'cust_bill';
3572 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3573 $opt->{'hashref'}{'custnum'} = $self->custnum;
3574 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3576 map { $_ } #behavior of sort undefined in scalar context
3577 sort { $a->_date <=> $b->_date }
3581 =item open_cust_bill
3583 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3588 sub open_cust_bill {
3592 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3598 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3600 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3604 sub legacy_cust_bill {
3607 #return $self->num_legacy_cust_bill unless wantarray;
3609 map { $_ } #behavior of sort undefined in scalar context
3610 sort { $a->_date <=> $b->_date }
3611 qsearch({ 'table' => 'legacy_cust_bill',
3612 'hashref' => { 'custnum' => $self->custnum, },
3613 'order_by' => 'ORDER BY _date ASC',
3617 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3619 Returns all the statements (see L<FS::cust_statement>) for this customer.
3621 Optionally, a list or hashref of additional arguments to the qsearch call can
3626 =item cust_bill_void
3628 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3632 sub cust_bill_void {
3635 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3636 sort { $a->_date <=> $b->_date }
3637 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3640 sub cust_statement {
3642 my $opt = ref($_[0]) ? shift : { @_ };
3644 #return $self->num_cust_statement unless wantarray || keys %$opt;
3646 $opt->{'table'} = 'cust_statement';
3647 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3648 $opt->{'hashref'}{'custnum'} = $self->custnum;
3649 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3651 map { $_ } #behavior of sort undefined in scalar context
3652 sort { $a->_date <=> $b->_date }
3656 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3658 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3660 Optionally, a list or hashref of additional arguments to the qsearch call can
3661 be passed following the SVCDB.
3668 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3669 warn "$me svc_x requires a svcdb";
3672 my $opt = ref($_[0]) ? shift : { @_ };
3674 $opt->{'table'} = $svcdb;
3675 $opt->{'addl_from'} =
3676 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3677 ($opt->{'addl_from'} || '');
3679 my $custnum = $self->custnum;
3680 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3681 my $where = "cust_pkg.custnum = $custnum";
3683 my $extra_sql = $opt->{'extra_sql'} || '';
3684 if ( keys %{ $opt->{'hashref'} } ) {
3685 $extra_sql = " AND $where $extra_sql";
3688 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3689 $extra_sql = "WHERE $where AND $1";
3692 $extra_sql = "WHERE $where $extra_sql";
3695 $opt->{'extra_sql'} = $extra_sql;
3700 # required for use as an eventtable;
3703 $self->svc_x('svc_acct', @_);
3708 Returns all the credits (see L<FS::cust_credit>) for this customer.
3714 map { $_ } #return $self->num_cust_credit unless wantarray;
3715 sort { $a->_date <=> $b->_date }
3716 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3719 =item cust_credit_pkgnum
3721 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3722 package when using experimental package balances.
3726 sub cust_credit_pkgnum {
3727 my( $self, $pkgnum ) = @_;
3728 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3729 sort { $a->_date <=> $b->_date }
3730 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3731 'pkgnum' => $pkgnum,
3736 =item cust_credit_void
3738 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3742 sub cust_credit_void {
3745 sort { $a->_date <=> $b->_date }
3746 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3751 Returns all the payments (see L<FS::cust_pay>) for this customer.
3757 return $self->num_cust_pay unless wantarray;
3758 sort { $a->_date <=> $b->_date }
3759 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3764 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3765 called automatically when the cust_pay method is used in a scalar context.
3771 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3772 my $sth = dbh->prepare($sql) or die dbh->errstr;
3773 $sth->execute($self->custnum) or die $sth->errstr;
3774 $sth->fetchrow_arrayref->[0];
3777 =item cust_pay_pkgnum
3779 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3780 package when using experimental package balances.
3784 sub cust_pay_pkgnum {
3785 my( $self, $pkgnum ) = @_;
3786 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3787 sort { $a->_date <=> $b->_date }
3788 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3789 'pkgnum' => $pkgnum,
3796 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3802 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3803 sort { $a->_date <=> $b->_date }
3804 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3807 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3809 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3811 Optionally, a list or hashref of additional arguments to the qsearch call can
3816 sub cust_pay_batch {
3818 my $opt = ref($_[0]) ? shift : { @_ };
3820 #return $self->num_cust_statement unless wantarray || keys %$opt;
3822 $opt->{'table'} = 'cust_pay_batch';
3823 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3824 $opt->{'hashref'}{'custnum'} = $self->custnum;
3825 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3827 map { $_ } #behavior of sort undefined in scalar context
3828 sort { $a->paybatchnum <=> $b->paybatchnum }
3832 =item cust_pay_pending
3834 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3835 (without status "done").
3839 sub cust_pay_pending {
3841 return $self->num_cust_pay_pending unless wantarray;
3842 sort { $a->_date <=> $b->_date }
3843 qsearch( 'cust_pay_pending', {
3844 'custnum' => $self->custnum,
3845 'status' => { op=>'!=', value=>'done' },
3850 =item cust_pay_pending_attempt
3852 Returns all payment attempts / declined payments for this customer, as pending
3853 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3854 a corresponding payment (see L<FS::cust_pay>).
3858 sub cust_pay_pending_attempt {
3860 return $self->num_cust_pay_pending_attempt unless wantarray;
3861 sort { $a->_date <=> $b->_date }
3862 qsearch( 'cust_pay_pending', {
3863 'custnum' => $self->custnum,
3870 =item num_cust_pay_pending
3872 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3873 customer (without status "done"). Also called automatically when the
3874 cust_pay_pending method is used in a scalar context.
3878 sub num_cust_pay_pending {
3881 " SELECT COUNT(*) FROM cust_pay_pending ".
3882 " WHERE custnum = ? AND status != 'done' ",
3887 =item num_cust_pay_pending_attempt
3889 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3890 customer, with status "done" but without a corresp. Also called automatically when the
3891 cust_pay_pending method is used in a scalar context.
3895 sub num_cust_pay_pending_attempt {
3898 " SELECT COUNT(*) FROM cust_pay_pending ".
3899 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3906 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3912 map { $_ } #return $self->num_cust_refund unless wantarray;
3913 sort { $a->_date <=> $b->_date }
3914 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3917 =item display_custnum
3919 Returns the displayed customer number for this customer: agent_custid if
3920 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3924 sub display_custnum {
3927 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3928 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3929 if ( $special eq 'CoStAg' ) {
3930 $prefix = uc( join('',
3932 ($self->state =~ /^(..)/),
3933 $prefix || ($self->agent->agent =~ /^(..)/)
3936 elsif ( $special eq 'CoStCl' ) {
3937 $prefix = uc( join('',
3939 ($self->state =~ /^(..)/),
3940 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3943 # add any others here if needed
3946 my $length = $conf->config('cust_main-custnum-display_length');
3947 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3948 return $self->agent_custid;
3949 } elsif ( $prefix ) {
3950 $length = 8 if !defined($length);
3952 sprintf('%0'.$length.'d', $self->custnum)
3953 } elsif ( $length ) {
3954 return sprintf('%0'.$length.'d', $self->custnum);
3956 return $self->custnum;
3962 Returns a name string for this customer, either "Company (Last, First)" or
3969 my $name = $self->contact;
3970 $name = $self->company. " ($name)" if $self->company;
3974 =item service_contact
3976 Returns the L<FS::contact> object for this customer that has the 'Service'
3977 contact class, or undef if there is no such contact. Deprecated; don't use
3982 sub service_contact {
3984 if ( !exists($self->{service_contact}) ) {
3985 my $classnum = $self->scalar_sql(
3986 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3987 ) || 0; #if it's zero, qsearchs will return nothing
3988 $self->{service_contact} = qsearchs('contact', {
3989 'classnum' => $classnum, 'custnum' => $self->custnum
3992 $self->{service_contact};
3997 Returns a name string for this (service/shipping) contact, either
3998 "Company (Last, First)" or "Last, First".
4005 my $name = $self->ship_contact;
4006 $name = $self->company. " ($name)" if $self->company;
4012 Returns a name string for this customer, either "Company" or "First Last".
4018 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4021 =item ship_name_short
4023 Returns a name string for this (service/shipping) contact, either "Company"
4028 sub ship_name_short {
4030 $self->service_contact
4031 ? $self->ship_contact_firstlast
4037 Returns this customer's full (billing) contact name only, "Last, First"
4043 $self->get('last'). ', '. $self->first;
4048 Returns this customer's full (shipping) contact name only, "Last, First"
4054 my $contact = $self->service_contact || $self;
4055 $contact->get('last') . ', ' . $contact->get('first');
4058 =item contact_firstlast
4060 Returns this customers full (billing) contact name only, "First Last".
4064 sub contact_firstlast {
4066 $self->first. ' '. $self->get('last');
4069 =item ship_contact_firstlast
4071 Returns this customer's full (shipping) contact name only, "First Last".
4075 sub ship_contact_firstlast {
4077 my $contact = $self->service_contact || $self;
4078 $contact->get('first') . ' '. $contact->get('last');
4081 #XXX this doesn't work in 3.x+
4084 #Returns this customer's full country name
4090 # code2country($self->country);
4093 sub bill_country_full {
4095 code2country($self->bill_location->country);
4098 sub ship_country_full {
4100 code2country($self->ship_location->country);
4103 =item county_state_county [ PREFIX ]
4105 Returns a string consisting of just the county, state and country.
4109 sub county_state_country {
4112 if ( @_ && $_[0] && $self->has_ship_address ) {
4113 $locationnum = $self->ship_locationnum;
4115 $locationnum = $self->bill_locationnum;
4117 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4118 $cust_location->county_state_country;
4121 =item geocode DATA_VENDOR
4123 Returns a value for the customer location as encoded by DATA_VENDOR.
4124 Currently this only makes sense for "CCH" as DATA_VENDOR.
4132 Returns a status string for this customer, currently:
4136 =item prospect - No packages have ever been ordered
4138 =item ordered - Recurring packages all are new (not yet billed).
4140 =item active - One or more recurring packages is active
4142 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4144 =item suspended - All non-cancelled recurring packages are suspended
4146 =item cancelled - All recurring packages are cancelled
4150 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4151 cust_main-status_module configuration option.
4155 sub status { shift->cust_status(@_); }
4159 for my $status ( FS::cust_main->statuses() ) {
4160 my $method = $status.'_sql';
4161 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4162 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4163 $sth->execute( ($self->custnum) x $numnum )
4164 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4165 return $status if $sth->fetchrow_arrayref->[0];
4169 =item ucfirst_cust_status
4171 =item ucfirst_status
4173 Returns the status with the first character capitalized.
4177 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4179 sub ucfirst_cust_status {
4181 ucfirst($self->cust_status);
4186 Returns a hex triplet color string for this customer's status.
4190 sub statuscolor { shift->cust_statuscolor(@_); }
4192 sub cust_statuscolor {
4194 __PACKAGE__->statuscolors->{$self->cust_status};
4197 =item tickets [ STATUS ]
4199 Returns an array of hashes representing the customer's RT tickets.
4201 An optional status (or arrayref or hashref of statuses) may be specified.
4207 my $status = ( @_ && $_[0] ) ? shift : '';
4209 my $num = $conf->config('cust_main-max_tickets') || 10;
4212 if ( $conf->config('ticket_system') ) {
4213 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4215 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4224 foreach my $priority (
4225 $conf->config('ticket_system-custom_priority_field-values'), ''
4227 last if scalar(@tickets) >= $num;
4229 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4230 $num - scalar(@tickets),
4241 # Return services representing svc_accts in customer support packages
4242 sub support_services {
4244 my %packages = map { $_ => 1 } $conf->config('support_packages');
4246 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4247 grep { $_->part_svc->svcdb eq 'svc_acct' }
4248 map { $_->cust_svc }
4249 grep { exists $packages{ $_->pkgpart } }
4250 $self->ncancelled_pkgs;
4254 # Return a list of latitude/longitude for one of the services (if any)
4255 sub service_coordinates {
4259 grep { $_->latitude && $_->longitude }
4261 map { $_->cust_svc }
4262 $self->ncancelled_pkgs;
4264 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4269 Returns a masked version of the named field
4274 my ($self,$field) = @_;
4278 'x'x(length($self->getfield($field))-4).
4279 substr($self->getfield($field), (length($self->getfield($field))-4));
4285 =head1 CLASS METHODS
4291 Class method that returns the list of possible status strings for customers
4292 (see L<the status method|/status>). For example:
4294 @statuses = FS::cust_main->statuses();
4300 keys %{ $self->statuscolors };
4303 =item cust_status_sql
4305 Returns an SQL fragment to determine the status of a cust_main record, as a
4310 sub cust_status_sql {
4312 for my $status ( FS::cust_main->statuses() ) {
4313 my $method = $status.'_sql';
4314 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4323 Returns an SQL expression identifying prospective cust_main records (customers
4324 with no packages ever ordered)
4328 use vars qw($select_count_pkgs);
4329 $select_count_pkgs =
4330 "SELECT COUNT(*) FROM cust_pkg
4331 WHERE cust_pkg.custnum = cust_main.custnum";
4333 sub select_count_pkgs_sql {
4338 " 0 = ( $select_count_pkgs ) ";
4343 Returns an SQL expression identifying ordered cust_main records (customers with
4344 no active packages, but recurring packages not yet setup or one time charges
4350 FS::cust_main->none_active_sql.
4351 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4356 Returns an SQL expression identifying active cust_main records (customers with
4357 active recurring packages).
4362 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4365 =item none_active_sql
4367 Returns an SQL expression identifying cust_main records with no active
4368 recurring packages. This includes customers of status prospect, ordered,
4369 inactive, and suspended.
4373 sub none_active_sql {
4374 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4379 Returns an SQL expression identifying inactive cust_main records (customers with
4380 no active recurring packages, but otherwise unsuspended/uncancelled).
4385 FS::cust_main->none_active_sql.
4386 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4392 Returns an SQL expression identifying suspended cust_main records.
4397 sub suspended_sql { susp_sql(@_); }
4399 FS::cust_main->none_active_sql.
4400 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4406 Returns an SQL expression identifying cancelled cust_main records.
4410 sub cancel_sql { shift->cancelled_sql(@_); }
4413 =item uncancelled_sql
4415 Returns an SQL expression identifying un-cancelled cust_main records.
4419 sub uncancelled_sql { uncancel_sql(@_); }
4420 sub uncancel_sql { "
4421 ( 0 < ( $select_count_pkgs
4422 AND ( cust_pkg.cancel IS NULL
4423 OR cust_pkg.cancel = 0
4426 OR 0 = ( $select_count_pkgs )
4432 Returns an SQL fragment to retreive the balance.
4437 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4438 WHERE cust_bill.custnum = cust_main.custnum )
4439 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4440 WHERE cust_pay.custnum = cust_main.custnum )
4441 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4442 WHERE cust_credit.custnum = cust_main.custnum )
4443 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4444 WHERE cust_refund.custnum = cust_main.custnum )
4447 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4449 Returns an SQL fragment to retreive the balance for this customer, optionally
4450 considering invoices with date earlier than START_TIME, and not
4451 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4452 total_unapplied_payments).
4454 Times are specified as SQL fragments or numeric
4455 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4456 L<Date::Parse> for conversion functions. The empty string can be passed
4457 to disable that time constraint completely.
4459 Available options are:
4463 =item unapplied_date
4465 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)
4470 set to true to remove all customer comparison clauses, for totals
4475 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4480 JOIN clause (typically used with the total option)
4484 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4485 time will be ignored. Note that START_TIME and END_TIME only limit the date
4486 range for invoices and I<unapplied> payments, credits, and refunds.
4492 sub balance_date_sql {
4493 my( $class, $start, $end, %opt ) = @_;
4495 my $cutoff = $opt{'cutoff'};
4497 my $owed = FS::cust_bill->owed_sql($cutoff);
4498 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4499 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4500 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4502 my $j = $opt{'join'} || '';
4504 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4505 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4506 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4507 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4509 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4510 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4511 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4512 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4517 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4519 Returns an SQL fragment to retreive the total unapplied payments for this
4520 customer, only considering payments with date earlier than START_TIME, and
4521 optionally not later than END_TIME.
4523 Times are specified as SQL fragments or numeric
4524 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4525 L<Date::Parse> for conversion functions. The empty string can be passed
4526 to disable that time constraint completely.
4528 Available options are:
4532 sub unapplied_payments_date_sql {
4533 my( $class, $start, $end, %opt ) = @_;
4535 my $cutoff = $opt{'cutoff'};
4537 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4539 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4540 'unapplied_date'=>1 );
4542 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4545 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4547 Helper method for balance_date_sql; name (and usage) subject to change
4548 (suggestions welcome).
4550 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4551 cust_refund, cust_credit or cust_pay).
4553 If TABLE is "cust_bill" or the unapplied_date option is true, only
4554 considers records with date earlier than START_TIME, and optionally not
4555 later than END_TIME .
4559 sub _money_table_where {
4560 my( $class, $table, $start, $end, %opt ) = @_;
4563 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4564 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4565 push @where, "$table._date <= $start" if defined($start) && length($start);
4566 push @where, "$table._date > $end" if defined($end) && length($end);
4568 push @where, @{$opt{'where'}} if $opt{'where'};
4569 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4575 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4576 use FS::cust_main::Search;
4579 FS::cust_main::Search->search(@_);
4594 #warn join('-',keys %$param);
4595 my $fh = $param->{filehandle};
4596 my $agentnum = $param->{agentnum};
4597 my $format = $param->{format};
4599 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4602 if ( $format eq 'simple' ) {
4603 @fields = qw( custnum agent_custid amount pkg );
4605 die "unknown format $format";
4608 eval "use Text::CSV_XS;";
4611 my $csv = new Text::CSV_XS;
4618 local $SIG{HUP} = 'IGNORE';
4619 local $SIG{INT} = 'IGNORE';
4620 local $SIG{QUIT} = 'IGNORE';
4621 local $SIG{TERM} = 'IGNORE';
4622 local $SIG{TSTP} = 'IGNORE';
4623 local $SIG{PIPE} = 'IGNORE';
4625 my $oldAutoCommit = $FS::UID::AutoCommit;
4626 local $FS::UID::AutoCommit = 0;
4629 #while ( $columns = $csv->getline($fh) ) {
4631 while ( defined($line=<$fh>) ) {
4633 $csv->parse($line) or do {
4634 $dbh->rollback if $oldAutoCommit;
4635 return "can't parse: ". $csv->error_input();
4638 my @columns = $csv->fields();
4639 #warn join('-',@columns);
4642 foreach my $field ( @fields ) {
4643 $row{$field} = shift @columns;
4646 if ( $row{custnum} && $row{agent_custid} ) {
4647 dbh->rollback if $oldAutoCommit;
4648 return "can't specify custnum with agent_custid $row{agent_custid}";
4652 if ( $row{agent_custid} && $agentnum ) {
4653 %hash = ( 'agent_custid' => $row{agent_custid},
4654 'agentnum' => $agentnum,
4658 if ( $row{custnum} ) {
4659 %hash = ( 'custnum' => $row{custnum} );
4662 unless ( scalar(keys %hash) ) {
4663 $dbh->rollback if $oldAutoCommit;
4664 return "can't find customer without custnum or agent_custid and agentnum";
4667 my $cust_main = qsearchs('cust_main', { %hash } );
4668 unless ( $cust_main ) {
4669 $dbh->rollback if $oldAutoCommit;
4670 my $custnum = $row{custnum} || $row{agent_custid};
4671 return "unknown custnum $custnum";
4674 if ( $row{'amount'} > 0 ) {
4675 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4677 $dbh->rollback if $oldAutoCommit;
4681 } elsif ( $row{'amount'} < 0 ) {
4682 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4685 $dbh->rollback if $oldAutoCommit;
4695 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4697 return "Empty file!" unless $imported;
4703 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4705 Deprecated. Use event notification and message templates
4706 (L<FS::msg_template>) instead.
4708 Sends a templated email notification to the customer (see L<Text::Template>).
4710 OPTIONS is a hash and may include
4712 I<from> - the email sender (default is invoice_from)
4714 I<to> - comma-separated scalar or arrayref of recipients
4715 (default is invoicing_list)
4717 I<subject> - The subject line of the sent email notification
4718 (default is "Notice from company_name")
4720 I<extra_fields> - a hashref of name/value pairs which will be substituted
4723 The following variables are vavailable in the template.
4725 I<$first> - the customer first name
4726 I<$last> - the customer last name
4727 I<$company> - the customer company
4728 I<$payby> - a description of the method of payment for the customer
4729 # would be nice to use FS::payby::shortname
4730 I<$payinfo> - the account information used to collect for this customer
4731 I<$expdate> - the expiration of the customer payment in seconds from epoch
4736 my ($self, $template, %options) = @_;
4738 return unless $conf->exists($template);
4740 my $from = $conf->config('invoice_from', $self->agentnum)
4741 if $conf->exists('invoice_from', $self->agentnum);
4742 $from = $options{from} if exists($options{from});
4744 my $to = join(',', $self->invoicing_list_emailonly);
4745 $to = $options{to} if exists($options{to});
4747 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4748 if $conf->exists('company_name', $self->agentnum);
4749 $subject = $options{subject} if exists($options{subject});
4751 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4752 SOURCE => [ map "$_\n",
4753 $conf->config($template)]
4755 or die "can't create new Text::Template object: Text::Template::ERROR";
4756 $notify_template->compile()
4757 or die "can't compile template: Text::Template::ERROR";
4759 $FS::notify_template::_template::company_name =
4760 $conf->config('company_name', $self->agentnum);
4761 $FS::notify_template::_template::company_address =
4762 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4764 my $paydate = $self->paydate || '2037-12-31';
4765 $FS::notify_template::_template::first = $self->first;
4766 $FS::notify_template::_template::last = $self->last;
4767 $FS::notify_template::_template::company = $self->company;
4768 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4769 my $payby = $self->payby;
4770 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4771 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4773 #credit cards expire at the end of the month/year of their exp date
4774 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4775 $FS::notify_template::_template::payby = 'credit card';
4776 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4777 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4779 }elsif ($payby eq 'COMP') {
4780 $FS::notify_template::_template::payby = 'complimentary account';
4782 $FS::notify_template::_template::payby = 'current method';
4784 $FS::notify_template::_template::expdate = $expire_time;
4786 for (keys %{$options{extra_fields}}){
4788 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4791 send_email(from => $from,
4793 subject => $subject,
4794 body => $notify_template->fill_in( PACKAGE =>
4795 'FS::notify_template::_template' ),
4800 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4802 Generates a templated notification to the customer (see L<Text::Template>).
4804 OPTIONS is a hash and may include
4806 I<extra_fields> - a hashref of name/value pairs which will be substituted
4807 into the template. These values may override values mentioned below
4808 and those from the customer record.
4810 The following variables are available in the template instead of or in addition
4811 to the fields of the customer record.
4813 I<$payby> - a description of the method of payment for the customer
4814 # would be nice to use FS::payby::shortname
4815 I<$payinfo> - the masked account information used to collect for this customer
4816 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4817 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4821 # a lot like cust_bill::print_latex
4822 sub generate_letter {
4823 my ($self, $template, %options) = @_;
4825 return unless $conf->exists($template);
4827 my $letter_template = new Text::Template
4829 SOURCE => [ map "$_\n", $conf->config($template)],
4830 DELIMITERS => [ '[@--', '--@]' ],
4832 or die "can't create new Text::Template object: Text::Template::ERROR";
4834 $letter_template->compile()
4835 or die "can't compile template: Text::Template::ERROR";
4837 my %letter_data = map { $_ => $self->$_ } $self->fields;
4838 $letter_data{payinfo} = $self->mask_payinfo;
4840 #my $paydate = $self->paydate || '2037-12-31';
4841 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4843 my $payby = $self->payby;
4844 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4845 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4847 #credit cards expire at the end of the month/year of their exp date
4848 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4849 $letter_data{payby} = 'credit card';
4850 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4851 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4853 }elsif ($payby eq 'COMP') {
4854 $letter_data{payby} = 'complimentary account';
4856 $letter_data{payby} = 'current method';
4858 $letter_data{expdate} = $expire_time;
4860 for (keys %{$options{extra_fields}}){
4861 $letter_data{$_} = $options{extra_fields}->{$_};
4864 unless(exists($letter_data{returnaddress})){
4865 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4866 $self->agent_template)
4868 if ( length($retadd) ) {
4869 $letter_data{returnaddress} = $retadd;
4870 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4871 $letter_data{returnaddress} =
4872 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4876 ( $conf->config('company_name', $self->agentnum),
4877 $conf->config('company_address', $self->agentnum),
4881 $letter_data{returnaddress} = '~';
4885 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4887 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4889 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4891 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4895 ) or die "can't open temp file: $!\n";
4896 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4897 or die "can't write temp file: $!\n";
4899 $letter_data{'logo_file'} = $lh->filename;
4901 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4905 ) or die "can't open temp file: $!\n";
4907 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4909 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4910 return ($1, $letter_data{'logo_file'});
4914 =item print_ps TEMPLATE
4916 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4922 my($file, $lfile) = $self->generate_letter(@_);
4923 my $ps = FS::Misc::generate_ps($file);
4924 unlink($file.'.tex');
4930 =item print TEMPLATE
4932 Prints the filled in template.
4934 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4938 sub queueable_print {
4941 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4942 or die "invalid customer number: " . $opt{custnum};
4944 my $error = $self->print( { 'template' => $opt{template} } );
4945 die $error if $error;
4949 my ($self, $template) = (shift, shift);
4951 [ $self->print_ps($template) ],
4952 'agentnum' => $self->agentnum,
4956 #these three subs should just go away once agent stuff is all config overrides
4958 sub agent_template {
4960 $self->_agent_plandata('agent_templatename');
4963 sub agent_invoice_from {
4965 $self->_agent_plandata('agent_invoice_from');
4968 sub _agent_plandata {
4969 my( $self, $option ) = @_;
4971 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4972 #agent-specific Conf
4974 use FS::part_event::Condition;
4976 my $agentnum = $self->agentnum;
4978 my $regexp = regexp_sql();
4980 my $part_event_option =
4982 'select' => 'part_event_option.*',
4983 'table' => 'part_event_option',
4985 LEFT JOIN part_event USING ( eventpart )
4986 LEFT JOIN part_event_option AS peo_agentnum
4987 ON ( part_event.eventpart = peo_agentnum.eventpart
4988 AND peo_agentnum.optionname = 'agentnum'
4989 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4991 LEFT JOIN part_event_condition
4992 ON ( part_event.eventpart = part_event_condition.eventpart
4993 AND part_event_condition.conditionname = 'cust_bill_age'
4995 LEFT JOIN part_event_condition_option
4996 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4997 AND part_event_condition_option.optionname = 'age'
5000 #'hashref' => { 'optionname' => $option },
5001 #'hashref' => { 'part_event_option.optionname' => $option },
5003 " WHERE part_event_option.optionname = ". dbh->quote($option).
5004 " AND action = 'cust_bill_send_agent' ".
5005 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5006 " AND peo_agentnum.optionname = 'agentnum' ".
5007 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5009 CASE WHEN part_event_condition_option.optionname IS NULL
5011 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5013 , part_event.weight".
5017 unless ( $part_event_option ) {
5018 return $self->agent->invoice_template || ''
5019 if $option eq 'agent_templatename';
5023 $part_event_option->optionvalue;
5027 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5029 Subroutine (not a method), designed to be called from the queue.
5031 Takes a list of options and values.
5033 Pulls up the customer record via the custnum option and calls bill_and_collect.
5038 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5040 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5041 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5043 $cust_main->bill_and_collect( %args );
5046 sub process_bill_and_collect {
5048 my $param = thaw(decode_base64(shift));
5049 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5050 or die "custnum '$param->{custnum}' not found!\n";
5051 $param->{'job'} = $job;
5052 $param->{'fatal'} = 1; # runs from job queue, will be caught
5053 $param->{'retry'} = 1;
5055 $cust_main->bill_and_collect( %$param );
5058 #starting to take quite a while for big dbs
5059 # (JRNL: journaled so it only happens once per database)
5060 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5061 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5062 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5063 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5064 # JRNL leading/trailing spaces in first, last, company
5065 # JRNL migrate to cust_payby
5066 # - otaker upgrade? journal and call it good? (double check to make sure
5067 # we're not still setting otaker here)
5069 #only going to get worse with new location stuff...
5071 sub _upgrade_data { #class method
5072 my ($class, %opts) = @_;
5075 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5078 #this seems to be the only expensive one.. why does it take so long?
5079 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5081 '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';
5082 FS::upgrade_journal->set_done('cust_main__signupdate');
5085 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5087 # fix yyyy-m-dd formatted paydates
5088 if ( driver_name =~ /^mysql/i ) {
5090 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5091 } else { # the SQL standard
5093 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5095 FS::upgrade_journal->set_done('cust_main__paydate');
5098 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5100 push @statements, #fix the weird BILL with a cc# in payinfo problem
5102 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5104 FS::upgrade_journal->set_done('cust_main__payinfo');
5109 foreach my $sql ( @statements ) {
5110 my $sth = dbh->prepare($sql) or die dbh->errstr;
5111 $sth->execute or die $sth->errstr;
5112 #warn ( (time - $t). " seconds\n" );
5116 local($ignore_expired_card) = 1;
5117 local($ignore_banned_card) = 1;
5118 local($skip_fuzzyfiles) = 1;
5119 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5121 FS::cust_main::Location->_upgrade_data(%opts);
5123 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5125 foreach my $cust_main ( qsearch({
5126 'table' => 'cust_main',
5128 'extra_sql' => 'WHERE '.
5130 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5131 qw( first last company )
5134 my $error = $cust_main->replace;
5135 die $error if $error;
5138 FS::upgrade_journal->set_done('cust_main__trimspaces');
5142 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5144 #we don't want to decrypt them, just stuff them as-is into cust_payby
5145 local(@encrypted_fields) = ();
5147 local($FS::cust_payby::ignore_expired_card) = 1;
5148 local($FS::cust_payby::ignore_banned_card) = 1;
5150 my @payfields = qw( payby payinfo paycvv paymask
5151 paydate paystart_month paystart_year payissue
5152 payname paystate paytype payip
5155 my $search = new FS::Cursor {
5156 'table' => 'cust_main',
5157 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5160 while (my $cust_main = $search->fetch) {
5162 my $cust_payby = new FS::cust_payby {
5163 'custnum' => $cust_main->custnum,
5165 map { $_ => $cust_main->$_(); } @payfields
5168 my $error = $cust_payby->insert;
5169 die $error if $error;
5171 $cust_main->setfield($_, '') foreach @payfields;
5172 $error = $cust_main->replace;
5173 die $error if $error;
5177 FS::upgrade_journal->set_done('cust_main__cust_payby');
5180 $class->_upgrade_otaker(%opts);
5190 The delete method should possibly take an FS::cust_main object reference
5191 instead of a scalar customer number.
5193 Bill and collect options should probably be passed as references instead of a
5196 There should probably be a configuration file with a list of allowed credit
5199 No multiple currency support (probably a larger project than just this module).
5201 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5203 Birthdates rely on negative epoch values.
5205 The payby for card/check batches is broken. With mixed batching, bad
5208 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5212 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5213 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5214 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.