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 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1666 my $queue = new FS::queue {
1667 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1669 my @args = "cust_main.$field", $self->get($field);
1670 my $error = $queue->insert( @args );
1672 $dbh->rollback if $oldAutoCommit;
1673 return "queueing job (transaction rolled back): $error";
1677 my @locations = $self->bill_location;
1678 push @locations, $self->ship_location if $self->has_ship_address;
1679 foreach my $location (@locations) {
1680 my $queue = new FS::queue {
1681 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1683 my @args = 'cust_location.address1', $location->address1;
1684 my $error = $queue->insert( @args );
1686 $dbh->rollback if $oldAutoCommit;
1687 return "queueing job (transaction rolled back): $error";
1691 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1698 Checks all fields to make sure this is a valid customer record. If there is
1699 an error, returns the error, otherwise returns false. Called by the insert
1700 and replace methods.
1707 warn "$me check BEFORE: \n". $self->_dump
1711 $self->ut_numbern('custnum')
1712 || $self->ut_number('agentnum')
1713 || $self->ut_textn('agent_custid')
1714 || $self->ut_number('refnum')
1715 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1716 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1717 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1718 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1719 || $self->ut_textn('custbatch')
1720 || $self->ut_name('last')
1721 || $self->ut_name('first')
1722 || $self->ut_snumbern('signupdate')
1723 || $self->ut_snumbern('birthdate')
1724 || $self->ut_snumbern('spouse_birthdate')
1725 || $self->ut_snumbern('anniversary_date')
1726 || $self->ut_textn('company')
1727 || $self->ut_textn('ship_company')
1728 || $self->ut_anything('comments')
1729 || $self->ut_numbern('referral_custnum')
1730 || $self->ut_textn('stateid')
1731 || $self->ut_textn('stateid_state')
1732 || $self->ut_textn('invoice_terms')
1733 || $self->ut_floatn('cdr_termination_percentage')
1734 || $self->ut_floatn('credit_limit')
1735 || $self->ut_numbern('billday')
1736 || $self->ut_numbern('prorate_day')
1737 || $self->ut_flag('edit_subject')
1738 || $self->ut_flag('calling_list_exempt')
1739 || $self->ut_flag('invoice_noemail')
1740 || $self->ut_flag('message_noemail')
1741 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1742 || $self->ut_currencyn('currency')
1745 foreach (qw(company ship_company)) {
1746 my $company = $self->get($_);
1747 $company =~ s/^\s+//;
1748 $company =~ s/\s+$//;
1749 $company =~ s/\s+/ /g;
1750 $self->set($_, $company);
1753 #barf. need message catalogs. i18n. etc.
1754 $error .= "Please select an advertising source."
1755 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1756 return $error if $error;
1758 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1759 or return "Unknown agent";
1761 if ( $self->currency ) {
1762 my $agent_currency = qsearchs( 'agent_currency', {
1763 'agentnum' => $agent->agentnum,
1764 'currency' => $self->currency,
1766 or return "Agent ". $agent->agent.
1767 " not permitted to offer ". $self->currency. " invoicing";
1770 return "Unknown refnum"
1771 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1773 return "Unknown referring custnum: ". $self->referral_custnum
1774 unless ! $self->referral_custnum
1775 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1777 if ( $self->ss eq '' ) {
1782 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1783 or return "Illegal social security number: ". $self->ss;
1784 $self->ss("$1-$2-$3");
1787 # cust_main_county verification now handled by cust_location check
1790 $self->ut_phonen('daytime', $self->country)
1791 || $self->ut_phonen('night', $self->country)
1792 || $self->ut_phonen('fax', $self->country)
1793 || $self->ut_phonen('mobile', $self->country)
1795 return $error if $error;
1797 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1799 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1802 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1804 : FS::Msgcat::_gettext('daytime');
1805 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1807 : FS::Msgcat::_gettext('night');
1809 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1811 : FS::Msgcat::_gettext('mobile');
1813 return "$daytime_label, $night_label or $mobile_label is required"
1817 ### start of stuff moved to cust_payby
1818 # then mostly kept here to support upgrades (can remove in 5.x)
1819 # but modified to allow everything to be empty
1821 if ( $self->payby ) {
1822 FS::payby->can_payby($self->table, $self->payby)
1823 or return "Illegal payby: ". $self->payby;
1828 $error = $self->ut_numbern('paystart_month')
1829 || $self->ut_numbern('paystart_year')
1830 || $self->ut_numbern('payissue')
1831 || $self->ut_textn('paytype')
1833 return $error if $error;
1835 if ( $self->payip eq '' ) {
1838 $error = $self->ut_ip('payip');
1839 return $error if $error;
1842 # If it is encrypted and the private key is not availaible then we can't
1843 # check the credit card.
1844 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1846 # Need some kind of global flag to accept invalid cards, for testing
1848 if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1849 $self->payby =~ /^(CARD|DCRD)$/ ) {
1851 my $payinfo = $self->payinfo;
1852 $payinfo =~ s/\D//g;
1853 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1854 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1856 $self->payinfo($payinfo);
1858 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1860 return gettext('unknown_card_type')
1861 if $self->payinfo !~ /^99\d{14}$/ #token
1862 && cardtype($self->payinfo) eq "Unknown";
1864 unless ( $ignore_banned_card ) {
1865 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1867 if ( $ban->bantype eq 'warn' ) {
1868 #or others depending on value of $ban->reason ?
1869 return '_duplicate_card'.
1870 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1871 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1872 ' (ban# '. $ban->bannum. ')'
1873 unless $self->override_ban_warn;
1875 return 'Banned credit card: banned on '.
1876 time2str('%a %h %o at %r', $ban->_date).
1877 ' by '. $ban->otaker.
1878 ' (ban# '. $ban->bannum. ')';
1883 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1884 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1885 $self->paycvv =~ /^(\d{4})$/
1886 or return "CVV2 (CID) for American Express cards is four digits.";
1889 $self->paycvv =~ /^(\d{3})$/
1890 or return "CVV2 (CVC2/CID) is three digits.";
1897 my $cardtype = cardtype($payinfo);
1898 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1900 return "Start date or issue number is required for $cardtype cards"
1901 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1903 return "Start month must be between 1 and 12"
1904 if $self->paystart_month
1905 and $self->paystart_month < 1 || $self->paystart_month > 12;
1907 return "Start year must be 1990 or later"
1908 if $self->paystart_year
1909 and $self->paystart_year < 1990;
1911 return "Issue number must be beween 1 and 99"
1913 and $self->payissue < 1 || $self->payissue > 99;
1916 $self->paystart_month('');
1917 $self->paystart_year('');
1918 $self->payissue('');
1921 } elsif ( !$ignore_invalid_card && $check_payinfo &&
1922 $self->payby =~ /^(CHEK|DCHK)$/ ) {
1924 my $payinfo = $self->payinfo;
1925 $payinfo =~ s/[^\d\@\.]//g;
1926 if ( $conf->config('echeck-country') eq 'CA' ) {
1927 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1928 or return 'invalid echeck account@branch.bank';
1929 $payinfo = "$1\@$2.$3";
1930 } elsif ( $conf->config('echeck-country') eq 'US' ) {
1931 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1932 $payinfo = "$1\@$2";
1934 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1935 $payinfo = "$1\@$2";
1937 $self->payinfo($payinfo);
1940 unless ( $ignore_banned_card ) {
1941 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1943 if ( $ban->bantype eq 'warn' ) {
1944 #or others depending on value of $ban->reason ?
1945 return '_duplicate_ach' unless $self->override_ban_warn;
1947 return 'Banned ACH account: banned on '.
1948 time2str('%a %h %o at %r', $ban->_date).
1949 ' by '. $ban->otaker.
1950 ' (ban# '. $ban->bannum. ')';
1955 } elsif ( $self->payby eq 'LECB' ) {
1957 my $payinfo = $self->payinfo;
1958 $payinfo =~ s/\D//g;
1959 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1961 $self->payinfo($payinfo);
1964 } elsif ( $self->payby eq 'BILL' ) {
1966 $error = $self->ut_textn('payinfo');
1967 return "Illegal P.O. number: ". $self->payinfo if $error;
1970 } elsif ( $self->payby eq 'COMP' ) {
1972 my $curuser = $FS::CurrentUser::CurrentUser;
1973 if ( ! $self->custnum
1974 && ! $curuser->access_right('Complimentary customer')
1977 return "You are not permitted to create complimentary accounts."
1980 $error = $self->ut_textn('payinfo');
1981 return "Illegal comp account issuer: ". $self->payinfo if $error;
1984 } elsif ( $self->payby eq 'PREPAY' ) {
1986 my $payinfo = $self->payinfo;
1987 $payinfo =~ s/\W//g; #anything else would just confuse things
1988 $self->payinfo($payinfo);
1989 $error = $self->ut_alpha('payinfo');
1990 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1991 return "Unknown prepayment identifier"
1992 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1997 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1998 return "Expiration date required"
1999 # shouldn't payinfo_check do this?
2000 unless ! $self->payby
2001 || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2005 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2006 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2007 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2008 ( $m, $y ) = ( $2, "19$1" );
2009 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2010 ( $m, $y ) = ( $3, "20$2" );
2012 return "Illegal expiration date: ". $self->paydate;
2014 $m = sprintf('%02d',$m);
2015 $self->paydate("$y-$m-01");
2016 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2017 return gettext('expired_card')
2019 && !$ignore_expired_card
2020 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2023 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2024 ( ! $conf->exists('require_cardname')
2025 || $self->payby !~ /^(CARD|DCRD)$/ )
2027 $self->payname( $self->first. " ". $self->getfield('last') );
2029 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2030 or return gettext('illegal_name'). " payname: ". $self->payname;
2034 ### end of stuff moved to cust_payby
2036 return "Please select an invoicing locale"
2039 && $conf->exists('cust_main-require_locale');
2041 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2042 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2046 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2048 warn "$me check AFTER: \n". $self->_dump
2051 $self->SUPER::check;
2056 Returns a list of fields which have ship_ duplicates.
2061 qw( last first company
2062 address1 address2 city county state zip country
2064 daytime night fax mobile
2068 =item has_ship_address
2070 Returns true if this customer record has a separate shipping address.
2074 sub has_ship_address {
2076 $self->bill_locationnum != $self->ship_locationnum;
2081 Returns a list of key/value pairs, with the following keys: address1,
2082 adddress2, city, county, state, zip, country, district, and geocode. The
2083 shipping address is used if present.
2089 $self->ship_location->location_hash;
2094 Returns all locations (see L<FS::cust_location>) for this customer.
2100 qsearch('cust_location', { 'custnum' => $self->custnum,
2101 'prospectnum' => '' } );
2106 Returns all contacts (see L<FS::contact>) for this customer.
2110 #already used :/ sub contact {
2113 qsearch('contact', { 'custnum' => $self->custnum } );
2118 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2125 'table' => 'cust_payby',
2126 'hashref' => { 'custnum' => $self->custnum },
2127 'order_by' => 'ORDER BY weight ASC',
2133 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2134 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2135 on success or a list of errors.
2141 grep { $_->unsuspend } $self->suspended_pkgs;
2146 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2148 Returns a list: an empty list on success or a list of errors.
2154 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2157 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2159 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2160 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2161 of a list of pkgparts; the hashref has the following keys:
2165 =item pkgparts - listref of pkgparts
2167 =item (other options are passed to the suspend method)
2172 Returns a list: an empty list on success or a list of errors.
2176 sub suspend_if_pkgpart {
2178 my (@pkgparts, %opt);
2179 if (ref($_[0]) eq 'HASH'){
2180 @pkgparts = @{$_[0]{pkgparts}};
2185 grep { $_->suspend(%opt) }
2186 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2187 $self->unsuspended_pkgs;
2190 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2192 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2193 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2194 instead of a list of pkgparts; the hashref has the following keys:
2198 =item pkgparts - listref of pkgparts
2200 =item (other options are passed to the suspend method)
2204 Returns a list: an empty list on success or a list of errors.
2208 sub suspend_unless_pkgpart {
2210 my (@pkgparts, %opt);
2211 if (ref($_[0]) eq 'HASH'){
2212 @pkgparts = @{$_[0]{pkgparts}};
2217 grep { $_->suspend(%opt) }
2218 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2219 $self->unsuspended_pkgs;
2222 =item cancel [ OPTION => VALUE ... ]
2224 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2226 Available options are:
2230 =item quiet - can be set true to supress email cancellation notices.
2232 =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.
2234 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2236 =item nobill - can be set true to skip billing if it might otherwise be done.
2240 Always returns a list: an empty list on success or a list of errors.
2244 # nb that dates are not specified as valid options to this method
2247 my( $self, %opt ) = @_;
2249 warn "$me cancel called on customer ". $self->custnum. " with options ".
2250 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2253 return ( 'access denied' )
2254 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2256 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2258 #should try decryption (we might have the private key)
2259 # and if not maybe queue a job for the server that does?
2260 return ( "Can't (yet) ban encrypted credit cards" )
2261 if $self->is_encrypted($self->payinfo);
2263 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2264 my $error = $ban->insert;
2265 return ( $error ) if $error;
2269 my @pkgs = $self->ncancelled_pkgs;
2271 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2273 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2274 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2278 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2279 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2282 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2285 sub _banned_pay_hashref {
2296 'payby' => $payby2ban{$self->payby},
2297 'payinfo' => $self->payinfo,
2298 #don't ever *search* on reason! #'reason' =>
2302 sub _new_banned_pay_hashref {
2304 my $hr = $self->_banned_pay_hashref;
2305 $hr->{payinfo} = md5_base64($hr->{payinfo});
2311 Returns all notes (see L<FS::cust_main_note>) for this customer.
2316 my($self,$orderby_classnum) = (shift,shift);
2317 my $orderby = "_DATE DESC";
2318 $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2319 qsearch( 'cust_main_note',
2320 { 'custnum' => $self->custnum },
2322 "ORDER BY $orderby",
2328 Returns the agent (see L<FS::agent>) for this customer.
2334 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2339 Returns the agent name (see L<FS::agent>) for this customer.
2345 $self->agent->agent;
2350 Returns any tags associated with this customer, as FS::cust_tag objects,
2351 or an empty list if there are no tags.
2357 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2362 Returns any tags associated with this customer, as FS::part_tag objects,
2363 or an empty list if there are no tags.
2369 map $_->part_tag, $self->cust_tag;
2375 Returns the customer class, as an FS::cust_class object, or the empty string
2376 if there is no customer class.
2382 if ( $self->classnum ) {
2383 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2391 Returns the customer category name, or the empty string if there is no customer
2398 my $cust_class = $self->cust_class;
2400 ? $cust_class->categoryname
2406 Returns the customer class name, or the empty string if there is no customer
2413 my $cust_class = $self->cust_class;
2415 ? $cust_class->classname
2419 =item BILLING METHODS
2421 Documentation on billing methods has been moved to
2422 L<FS::cust_main::Billing>.
2424 =item REALTIME BILLING METHODS
2426 Documentation on realtime billing methods has been moved to
2427 L<FS::cust_main::Billing_Realtime>.
2431 Removes the I<paycvv> field from the database directly.
2433 If there is an error, returns the error, otherwise returns false.
2439 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2440 or return dbh->errstr;
2441 $sth->execute($self->custnum)
2442 or return $sth->errstr;
2447 =item batch_card OPTION => VALUE...
2449 Adds a payment for this invoice to the pending credit card batch (see
2450 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2451 runs the payment using a realtime gateway.
2453 Options may include:
2455 B<amount>: the amount to be paid; defaults to the customer's balance minus
2456 any payments in transit.
2458 B<payby>: the payment method; defaults to cust_main.payby
2460 B<realtime>: runs this as a realtime payment instead of adding it to a
2463 B<invnum>: sets cust_pay_batch.invnum.
2465 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2466 the billing address for the payment; defaults to the customer's billing
2469 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2470 date, and name; defaults to those fields in cust_main.
2475 my ($self, %options) = @_;
2478 if (exists($options{amount})) {
2479 $amount = $options{amount};
2481 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2483 return '' unless $amount > 0;
2485 my $invnum = delete $options{invnum};
2486 my $payby = $options{payby} || $self->payby; #still dubious
2488 if ($options{'realtime'}) {
2489 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2495 my $oldAutoCommit = $FS::UID::AutoCommit;
2496 local $FS::UID::AutoCommit = 0;
2499 #this needs to handle mysql as well as Pg, like svc_acct.pm
2500 #(make it into a common function if folks need to do batching with mysql)
2501 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2502 or return "Cannot lock pay_batch: " . $dbh->errstr;
2506 'payby' => FS::payby->payby2payment($payby),
2508 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2510 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2512 unless ( $pay_batch ) {
2513 $pay_batch = new FS::pay_batch \%pay_batch;
2514 my $error = $pay_batch->insert;
2516 $dbh->rollback if $oldAutoCommit;
2517 die "error creating new batch: $error\n";
2521 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2522 'batchnum' => $pay_batch->batchnum,
2523 'custnum' => $self->custnum,
2526 foreach (qw( address1 address2 city state zip country latitude longitude
2527 payby payinfo paydate payname ))
2529 $options{$_} = '' unless exists($options{$_});
2532 my $loc = $self->bill_location;
2534 my $cust_pay_batch = new FS::cust_pay_batch ( {
2535 'batchnum' => $pay_batch->batchnum,
2536 'invnum' => $invnum || 0, # is there a better value?
2537 # this field should be
2539 # cust_bill_pay_batch now
2540 'custnum' => $self->custnum,
2541 'last' => $self->getfield('last'),
2542 'first' => $self->getfield('first'),
2543 'address1' => $options{address1} || $loc->address1,
2544 'address2' => $options{address2} || $loc->address2,
2545 'city' => $options{city} || $loc->city,
2546 'state' => $options{state} || $loc->state,
2547 'zip' => $options{zip} || $loc->zip,
2548 'country' => $options{country} || $loc->country,
2549 'payby' => $options{payby} || $self->payby,
2550 'payinfo' => $options{payinfo} || $self->payinfo,
2551 'exp' => $options{paydate} || $self->paydate,
2552 'payname' => $options{payname} || $self->payname,
2553 'amount' => $amount, # consolidating
2556 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2557 if $old_cust_pay_batch;
2560 if ($old_cust_pay_batch) {
2561 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2563 $error = $cust_pay_batch->insert;
2567 $dbh->rollback if $oldAutoCommit;
2571 my $unapplied = $self->total_unapplied_credits
2572 + $self->total_unapplied_payments
2573 + $self->in_transit_payments;
2574 foreach my $cust_bill ($self->open_cust_bill) {
2575 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2576 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2577 'invnum' => $cust_bill->invnum,
2578 'paybatchnum' => $cust_pay_batch->paybatchnum,
2579 'amount' => $cust_bill->owed,
2582 if ($unapplied >= $cust_bill_pay_batch->amount){
2583 $unapplied -= $cust_bill_pay_batch->amount;
2586 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2587 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2589 $error = $cust_bill_pay_batch->insert;
2591 $dbh->rollback if $oldAutoCommit;
2596 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2602 Returns the total owed for this customer on all invoices
2603 (see L<FS::cust_bill/owed>).
2609 $self->total_owed_date(2145859200); #12/31/2037
2612 =item total_owed_date TIME
2614 Returns the total owed for this customer on all invoices with date earlier than
2615 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2616 see L<Time::Local> and L<Date::Parse> for conversion functions.
2620 sub total_owed_date {
2624 my $custnum = $self->custnum;
2626 my $owed_sql = FS::cust_bill->owed_sql;
2629 SELECT SUM($owed_sql) FROM cust_bill
2630 WHERE custnum = $custnum
2634 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2638 =item total_owed_pkgnum PKGNUM
2640 Returns the total owed on all invoices for this customer's specific package
2641 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2645 sub total_owed_pkgnum {
2646 my( $self, $pkgnum ) = @_;
2647 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2650 =item total_owed_date_pkgnum TIME PKGNUM
2652 Returns the total owed for this customer's specific package when using
2653 experimental package balances on all invoices with date earlier than
2654 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2655 see L<Time::Local> and L<Date::Parse> for conversion functions.
2659 sub total_owed_date_pkgnum {
2660 my( $self, $time, $pkgnum ) = @_;
2663 foreach my $cust_bill (
2664 grep { $_->_date <= $time }
2665 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2667 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2669 sprintf( "%.2f", $total_bill );
2675 Returns the total amount of all payments.
2682 $total += $_->paid foreach $self->cust_pay;
2683 sprintf( "%.2f", $total );
2686 =item total_unapplied_credits
2688 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2689 customer. See L<FS::cust_credit/credited>.
2691 =item total_credited
2693 Old name for total_unapplied_credits. Don't use.
2697 sub total_credited {
2698 #carp "total_credited deprecated, use total_unapplied_credits";
2699 shift->total_unapplied_credits(@_);
2702 sub total_unapplied_credits {
2705 my $custnum = $self->custnum;
2707 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2710 SELECT SUM($unapplied_sql) FROM cust_credit
2711 WHERE custnum = $custnum
2714 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2718 =item total_unapplied_credits_pkgnum PKGNUM
2720 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2721 customer. See L<FS::cust_credit/credited>.
2725 sub total_unapplied_credits_pkgnum {
2726 my( $self, $pkgnum ) = @_;
2727 my $total_credit = 0;
2728 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2729 sprintf( "%.2f", $total_credit );
2733 =item total_unapplied_payments
2735 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2736 See L<FS::cust_pay/unapplied>.
2740 sub total_unapplied_payments {
2743 my $custnum = $self->custnum;
2745 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2748 SELECT SUM($unapplied_sql) FROM cust_pay
2749 WHERE custnum = $custnum
2752 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2756 =item total_unapplied_payments_pkgnum PKGNUM
2758 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2759 specific package when using experimental package balances. See
2760 L<FS::cust_pay/unapplied>.
2764 sub total_unapplied_payments_pkgnum {
2765 my( $self, $pkgnum ) = @_;
2766 my $total_unapplied = 0;
2767 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2768 sprintf( "%.2f", $total_unapplied );
2772 =item total_unapplied_refunds
2774 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2775 customer. See L<FS::cust_refund/unapplied>.
2779 sub total_unapplied_refunds {
2781 my $custnum = $self->custnum;
2783 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2786 SELECT SUM($unapplied_sql) FROM cust_refund
2787 WHERE custnum = $custnum
2790 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2796 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2797 total_unapplied_credits minus total_unapplied_payments).
2803 $self->balance_date_range;
2806 =item balance_date TIME
2808 Returns the balance for this customer, only considering invoices with date
2809 earlier than TIME (total_owed_date minus total_credited minus
2810 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2811 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2818 $self->balance_date_range(shift);
2821 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2823 Returns the balance for this customer, optionally considering invoices with
2824 date earlier than START_TIME, and not later than END_TIME
2825 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2827 Times are specified as SQL fragments or numeric
2828 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2829 L<Date::Parse> for conversion functions. The empty string can be passed
2830 to disable that time constraint completely.
2832 Available options are:
2836 =item unapplied_date
2838 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)
2844 sub balance_date_range {
2846 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2847 ') FROM cust_main WHERE custnum='. $self->custnum;
2848 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2851 =item balance_pkgnum PKGNUM
2853 Returns the balance for this customer's specific package when using
2854 experimental package balances (total_owed plus total_unrefunded, minus
2855 total_unapplied_credits minus total_unapplied_payments)
2859 sub balance_pkgnum {
2860 my( $self, $pkgnum ) = @_;
2863 $self->total_owed_pkgnum($pkgnum)
2864 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2865 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2866 - $self->total_unapplied_credits_pkgnum($pkgnum)
2867 - $self->total_unapplied_payments_pkgnum($pkgnum)
2871 =item in_transit_payments
2873 Returns the total of requests for payments for this customer pending in
2874 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
2878 sub in_transit_payments {
2880 my $in_transit_payments = 0;
2881 foreach my $pay_batch ( qsearch('pay_batch', {
2884 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2885 'batchnum' => $pay_batch->batchnum,
2886 'custnum' => $self->custnum,
2888 $in_transit_payments += $cust_pay_batch->amount;
2891 sprintf( "%.2f", $in_transit_payments );
2896 Returns a hash of useful information for making a payment.
2906 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2907 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2908 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2912 For credit card transactions:
2924 For electronic check transactions:
2939 $return{balance} = $self->balance;
2941 $return{payname} = $self->payname
2942 || ( $self->first. ' '. $self->get('last') );
2944 $return{$_} = $self->bill_location->$_
2945 for qw(address1 address2 city state zip);
2947 $return{payby} = $self->payby;
2948 $return{stateid_state} = $self->stateid_state;
2950 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2951 $return{card_type} = cardtype($self->payinfo);
2952 $return{payinfo} = $self->paymask;
2954 @return{'month', 'year'} = $self->paydate_monthyear;
2958 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2959 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2960 $return{payinfo1} = $payinfo1;
2961 $return{payinfo2} = $payinfo2;
2962 $return{paytype} = $self->paytype;
2963 $return{paystate} = $self->paystate;
2967 #doubleclick protection
2969 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2975 =item paydate_monthyear
2977 Returns a two-element list consisting of the month and year of this customer's
2978 paydate (credit card expiration date for CARD customers)
2982 sub paydate_monthyear {
2984 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2986 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2995 Returns the exact time in seconds corresponding to the payment method
2996 expiration date. For CARD/DCRD customers this is the end of the month;
2997 for others (COMP is the only other payby that uses paydate) it's the start.
2998 Returns 0 if the paydate is empty or set to the far future.
3004 my ($month, $year) = $self->paydate_monthyear;
3005 return 0 if !$year or $year >= 2037;
3006 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3008 if ( $month == 13 ) {
3012 return timelocal(0,0,0,1,$month-1,$year) - 1;
3015 return timelocal(0,0,0,1,$month-1,$year);
3019 =item paydate_epoch_sql
3021 Class method. Returns an SQL expression to obtain the payment expiration date
3022 as a number of seconds.
3026 # Special expiration date behavior for non-CARD/DCRD customers has been
3027 # carefully preserved. Do we really use that?
3028 sub paydate_epoch_sql {
3030 my $table = shift || 'cust_main';
3031 my ($case1, $case2);
3032 if ( driver_name eq 'Pg' ) {
3033 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3034 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3036 elsif ( lc(driver_name) eq 'mysql' ) {
3037 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3038 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3041 return "CASE WHEN $table.payby IN('CARD','DCRD')
3047 =item tax_exemption TAXNAME
3052 my( $self, $taxname ) = @_;
3054 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3055 'taxname' => $taxname,
3060 =item cust_main_exemption
3064 sub cust_main_exemption {
3066 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3069 =item invoicing_list [ ARRAYREF ]
3071 If an arguement is given, sets these email addresses as invoice recipients
3072 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3073 (except as warnings), so use check_invoicing_list first.
3075 Returns a list of email addresses (with svcnum entries expanded).
3077 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3078 check it without disturbing anything by passing nothing.
3080 This interface may change in the future.
3084 sub invoicing_list {
3085 my( $self, $arrayref ) = @_;
3088 my @cust_main_invoice;
3089 if ( $self->custnum ) {
3090 @cust_main_invoice =
3091 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3093 @cust_main_invoice = ();
3095 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3096 #warn $cust_main_invoice->destnum;
3097 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3098 #warn $cust_main_invoice->destnum;
3099 my $error = $cust_main_invoice->delete;
3100 warn $error if $error;
3103 if ( $self->custnum ) {
3104 @cust_main_invoice =
3105 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3107 @cust_main_invoice = ();
3109 my %seen = map { $_->address => 1 } @cust_main_invoice;
3110 foreach my $address ( @{$arrayref} ) {
3111 next if exists $seen{$address} && $seen{$address};
3112 $seen{$address} = 1;
3113 my $cust_main_invoice = new FS::cust_main_invoice ( {
3114 'custnum' => $self->custnum,
3117 my $error = $cust_main_invoice->insert;
3118 warn $error if $error;
3122 if ( $self->custnum ) {
3124 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3131 =item check_invoicing_list ARRAYREF
3133 Checks these arguements as valid input for the invoicing_list method. If there
3134 is an error, returns the error, otherwise returns false.
3138 sub check_invoicing_list {
3139 my( $self, $arrayref ) = @_;
3141 foreach my $address ( @$arrayref ) {
3143 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3144 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3147 my $cust_main_invoice = new FS::cust_main_invoice ( {
3148 'custnum' => $self->custnum,
3151 my $error = $self->custnum
3152 ? $cust_main_invoice->check
3153 : $cust_main_invoice->checkdest
3155 return $error if $error;
3159 return "Email address required"
3160 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3161 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3166 =item set_default_invoicing_list
3168 Sets the invoicing list to all accounts associated with this customer,
3169 overwriting any previous invoicing list.
3173 sub set_default_invoicing_list {
3175 $self->invoicing_list($self->all_emails);
3180 Returns the email addresses of all accounts provisioned for this customer.
3187 foreach my $cust_pkg ( $self->all_pkgs ) {
3188 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3190 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3191 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3193 $list{$_}=1 foreach map { $_->email } @svc_acct;
3198 =item invoicing_list_addpost
3200 Adds postal invoicing to this customer. If this customer is already configured
3201 to receive postal invoices, does nothing.
3205 sub invoicing_list_addpost {
3207 return if grep { $_ eq 'POST' } $self->invoicing_list;
3208 my @invoicing_list = $self->invoicing_list;
3209 push @invoicing_list, 'POST';
3210 $self->invoicing_list(\@invoicing_list);
3213 =item invoicing_list_emailonly
3215 Returns the list of email invoice recipients (invoicing_list without non-email
3216 destinations such as POST and FAX).
3220 sub invoicing_list_emailonly {
3222 warn "$me invoicing_list_emailonly called"
3224 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3227 =item invoicing_list_emailonly_scalar
3229 Returns the list of email invoice recipients (invoicing_list without non-email
3230 destinations such as POST and FAX) as a comma-separated scalar.
3234 sub invoicing_list_emailonly_scalar {
3236 warn "$me invoicing_list_emailonly_scalar called"
3238 join(', ', $self->invoicing_list_emailonly);
3241 =item referral_custnum_cust_main
3243 Returns the customer who referred this customer (or the empty string, if
3244 this customer was not referred).
3246 Note the difference with referral_cust_main method: This method,
3247 referral_custnum_cust_main returns the single customer (if any) who referred
3248 this customer, while referral_cust_main returns an array of customers referred
3253 sub referral_custnum_cust_main {
3255 return '' unless $self->referral_custnum;
3256 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3259 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3261 Returns an array of customers referred by this customer (referral_custnum set
3262 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3263 customers referred by customers referred by this customer and so on, inclusive.
3264 The default behavior is DEPTH 1 (no recursion).
3266 Note the difference with referral_custnum_cust_main method: This method,
3267 referral_cust_main, returns an array of customers referred BY this customer,
3268 while referral_custnum_cust_main returns the single customer (if any) who
3269 referred this customer.
3273 sub referral_cust_main {
3275 my $depth = @_ ? shift : 1;
3276 my $exclude = @_ ? shift : {};
3279 map { $exclude->{$_->custnum}++; $_; }
3280 grep { ! $exclude->{ $_->custnum } }
3281 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3285 map { $_->referral_cust_main($depth-1, $exclude) }
3292 =item referral_cust_main_ncancelled
3294 Same as referral_cust_main, except only returns customers with uncancelled
3299 sub referral_cust_main_ncancelled {
3301 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3304 =item referral_cust_pkg [ DEPTH ]
3306 Like referral_cust_main, except returns a flat list of all unsuspended (and
3307 uncancelled) packages for each customer. The number of items in this list may
3308 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3312 sub referral_cust_pkg {
3314 my $depth = @_ ? shift : 1;
3316 map { $_->unsuspended_pkgs }
3317 grep { $_->unsuspended_pkgs }
3318 $self->referral_cust_main($depth);
3321 =item referring_cust_main
3323 Returns the single cust_main record for the customer who referred this customer
3324 (referral_custnum), or false.
3328 sub referring_cust_main {
3330 return '' unless $self->referral_custnum;
3331 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3334 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3336 Applies a credit to this customer. If there is an error, returns the error,
3337 otherwise returns false.
3339 REASON can be a text string, an FS::reason object, or a scalar reference to
3340 a reasonnum. If a text string, it will be automatically inserted as a new
3341 reason, and a 'reason_type' option must be passed to indicate the
3342 FS::reason_type for the new reason.
3344 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3345 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3346 I<commission_pkgnum>.
3348 Any other options are passed to FS::cust_credit::insert.
3353 my( $self, $amount, $reason, %options ) = @_;
3355 my $cust_credit = new FS::cust_credit {
3356 'custnum' => $self->custnum,
3357 'amount' => $amount,
3360 if ( ref($reason) ) {
3362 if ( ref($reason) eq 'SCALAR' ) {
3363 $cust_credit->reasonnum( $$reason );
3365 $cust_credit->reasonnum( $reason->reasonnum );
3369 $cust_credit->set('reason', $reason)
3372 $cust_credit->$_( delete $options{$_} )
3373 foreach grep exists($options{$_}),
3374 qw( addlinfo eventnum ),
3375 map "commission_$_", qw( agentnum salesnum pkgnum );
3377 $cust_credit->insert(%options);
3381 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3383 Creates a one-time charge for this customer. If there is an error, returns
3384 the error, otherwise returns false.
3386 New-style, with a hashref of options:
3388 my $error = $cust_main->charge(
3392 'start_date' => str2time('7/4/2009'),
3393 'pkg' => 'Description',
3394 'comment' => 'Comment',
3395 'additional' => [], #extra invoice detail
3396 'classnum' => 1, #pkg_class
3398 'setuptax' => '', # or 'Y' for tax exempt
3400 'locationnum'=> 1234, # optional
3403 'taxclass' => 'Tax class',
3406 'taxproduct' => 2, #part_pkg_taxproduct
3407 'override' => {}, #XXX describe
3409 #will be filled in with the new object
3410 'cust_pkg_ref' => \$cust_pkg,
3412 #generate an invoice immediately
3414 'invoice_terms' => '', #with these terms
3420 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3426 my ( $amount, $quantity, $start_date, $classnum );
3427 my ( $pkg, $comment, $additional );
3428 my ( $setuptax, $taxclass ); #internal taxes
3429 my ( $taxproduct, $override ); #vendor (CCH) taxes
3431 my $cust_pkg_ref = '';
3432 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3434 if ( ref( $_[0] ) ) {
3435 $amount = $_[0]->{amount};
3436 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3437 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3438 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3439 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3440 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3441 : '$'. sprintf("%.2f",$amount);
3442 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3443 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3444 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3445 $additional = $_[0]->{additional} || [];
3446 $taxproduct = $_[0]->{taxproductnum};
3447 $override = { '' => $_[0]->{tax_override} };
3448 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3449 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3450 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3451 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3456 $pkg = @_ ? shift : 'One-time charge';
3457 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3459 $taxclass = @_ ? shift : '';
3463 local $SIG{HUP} = 'IGNORE';
3464 local $SIG{INT} = 'IGNORE';
3465 local $SIG{QUIT} = 'IGNORE';
3466 local $SIG{TERM} = 'IGNORE';
3467 local $SIG{TSTP} = 'IGNORE';
3468 local $SIG{PIPE} = 'IGNORE';
3470 my $oldAutoCommit = $FS::UID::AutoCommit;
3471 local $FS::UID::AutoCommit = 0;
3474 my $part_pkg = new FS::part_pkg ( {
3476 'comment' => $comment,
3480 'classnum' => ( $classnum ? $classnum : '' ),
3481 'setuptax' => $setuptax,
3482 'taxclass' => $taxclass,
3483 'taxproductnum' => $taxproduct,
3486 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3487 ( 0 .. @$additional - 1 )
3489 'additional_count' => scalar(@$additional),
3490 'setup_fee' => $amount,
3493 my $error = $part_pkg->insert( options => \%options,
3494 tax_overrides => $override,
3497 $dbh->rollback if $oldAutoCommit;
3501 my $pkgpart = $part_pkg->pkgpart;
3502 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3503 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3504 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3505 $error = $type_pkgs->insert;
3507 $dbh->rollback if $oldAutoCommit;
3512 my $cust_pkg = new FS::cust_pkg ( {
3513 'custnum' => $self->custnum,
3514 'pkgpart' => $pkgpart,
3515 'quantity' => $quantity,
3516 'start_date' => $start_date,
3517 'no_auto' => $no_auto,
3518 'locationnum'=> $locationnum,
3521 $error = $cust_pkg->insert;
3523 $dbh->rollback if $oldAutoCommit;
3525 } elsif ( $cust_pkg_ref ) {
3526 ${$cust_pkg_ref} = $cust_pkg;
3530 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3531 'pkg_list' => [ $cust_pkg ],
3534 $dbh->rollback if $oldAutoCommit;
3539 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3544 #=item charge_postal_fee
3546 #Applies a one time charge this customer. If there is an error,
3547 #returns the error, returns the cust_pkg charge object or false
3548 #if there was no charge.
3552 # This should be a customer event. For that to work requires that bill
3553 # also be a customer event.
3555 sub charge_postal_fee {
3558 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3559 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3561 my $cust_pkg = new FS::cust_pkg ( {
3562 'custnum' => $self->custnum,
3563 'pkgpart' => $pkgpart,
3567 my $error = $cust_pkg->insert;
3568 $error ? $error : $cust_pkg;
3571 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3573 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3575 Optionally, a list or hashref of additional arguments to the qsearch call can
3582 my $opt = ref($_[0]) ? shift : { @_ };
3584 #return $self->num_cust_bill unless wantarray || keys %$opt;
3586 $opt->{'table'} = 'cust_bill';
3587 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3588 $opt->{'hashref'}{'custnum'} = $self->custnum;
3589 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3591 map { $_ } #behavior of sort undefined in scalar context
3592 sort { $a->_date <=> $b->_date }
3596 =item open_cust_bill
3598 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3603 sub open_cust_bill {
3607 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3613 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3615 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3619 sub legacy_cust_bill {
3622 #return $self->num_legacy_cust_bill unless wantarray;
3624 map { $_ } #behavior of sort undefined in scalar context
3625 sort { $a->_date <=> $b->_date }
3626 qsearch({ 'table' => 'legacy_cust_bill',
3627 'hashref' => { 'custnum' => $self->custnum, },
3628 'order_by' => 'ORDER BY _date ASC',
3632 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3634 Returns all the statements (see L<FS::cust_statement>) for this customer.
3636 Optionally, a list or hashref of additional arguments to the qsearch call can
3641 =item cust_bill_void
3643 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3647 sub cust_bill_void {
3650 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3651 sort { $a->_date <=> $b->_date }
3652 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3655 sub cust_statement {
3657 my $opt = ref($_[0]) ? shift : { @_ };
3659 #return $self->num_cust_statement unless wantarray || keys %$opt;
3661 $opt->{'table'} = 'cust_statement';
3662 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3663 $opt->{'hashref'}{'custnum'} = $self->custnum;
3664 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3666 map { $_ } #behavior of sort undefined in scalar context
3667 sort { $a->_date <=> $b->_date }
3671 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3673 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3675 Optionally, a list or hashref of additional arguments to the qsearch call can
3676 be passed following the SVCDB.
3683 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3684 warn "$me svc_x requires a svcdb";
3687 my $opt = ref($_[0]) ? shift : { @_ };
3689 $opt->{'table'} = $svcdb;
3690 $opt->{'addl_from'} =
3691 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3692 ($opt->{'addl_from'} || '');
3694 my $custnum = $self->custnum;
3695 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3696 my $where = "cust_pkg.custnum = $custnum";
3698 my $extra_sql = $opt->{'extra_sql'} || '';
3699 if ( keys %{ $opt->{'hashref'} } ) {
3700 $extra_sql = " AND $where $extra_sql";
3703 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3704 $extra_sql = "WHERE $where AND $1";
3707 $extra_sql = "WHERE $where $extra_sql";
3710 $opt->{'extra_sql'} = $extra_sql;
3715 # required for use as an eventtable;
3718 $self->svc_x('svc_acct', @_);
3723 Returns all the credits (see L<FS::cust_credit>) for this customer.
3729 map { $_ } #return $self->num_cust_credit unless wantarray;
3730 sort { $a->_date <=> $b->_date }
3731 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3734 =item cust_credit_pkgnum
3736 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3737 package when using experimental package balances.
3741 sub cust_credit_pkgnum {
3742 my( $self, $pkgnum ) = @_;
3743 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3744 sort { $a->_date <=> $b->_date }
3745 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3746 'pkgnum' => $pkgnum,
3751 =item cust_credit_void
3753 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3757 sub cust_credit_void {
3760 sort { $a->_date <=> $b->_date }
3761 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3766 Returns all the payments (see L<FS::cust_pay>) for this customer.
3772 return $self->num_cust_pay unless wantarray;
3773 sort { $a->_date <=> $b->_date }
3774 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3779 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3780 called automatically when the cust_pay method is used in a scalar context.
3786 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3787 my $sth = dbh->prepare($sql) or die dbh->errstr;
3788 $sth->execute($self->custnum) or die $sth->errstr;
3789 $sth->fetchrow_arrayref->[0];
3792 =item cust_pay_pkgnum
3794 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3795 package when using experimental package balances.
3799 sub cust_pay_pkgnum {
3800 my( $self, $pkgnum ) = @_;
3801 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3802 sort { $a->_date <=> $b->_date }
3803 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3804 'pkgnum' => $pkgnum,
3811 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3817 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3818 sort { $a->_date <=> $b->_date }
3819 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3822 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3824 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3826 Optionally, a list or hashref of additional arguments to the qsearch call can
3831 sub cust_pay_batch {
3833 my $opt = ref($_[0]) ? shift : { @_ };
3835 #return $self->num_cust_statement unless wantarray || keys %$opt;
3837 $opt->{'table'} = 'cust_pay_batch';
3838 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3839 $opt->{'hashref'}{'custnum'} = $self->custnum;
3840 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3842 map { $_ } #behavior of sort undefined in scalar context
3843 sort { $a->paybatchnum <=> $b->paybatchnum }
3847 =item cust_pay_pending
3849 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3850 (without status "done").
3854 sub cust_pay_pending {
3856 return $self->num_cust_pay_pending unless wantarray;
3857 sort { $a->_date <=> $b->_date }
3858 qsearch( 'cust_pay_pending', {
3859 'custnum' => $self->custnum,
3860 'status' => { op=>'!=', value=>'done' },
3865 =item cust_pay_pending_attempt
3867 Returns all payment attempts / declined payments for this customer, as pending
3868 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3869 a corresponding payment (see L<FS::cust_pay>).
3873 sub cust_pay_pending_attempt {
3875 return $self->num_cust_pay_pending_attempt unless wantarray;
3876 sort { $a->_date <=> $b->_date }
3877 qsearch( 'cust_pay_pending', {
3878 'custnum' => $self->custnum,
3885 =item num_cust_pay_pending
3887 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3888 customer (without status "done"). Also called automatically when the
3889 cust_pay_pending method is used in a scalar context.
3893 sub num_cust_pay_pending {
3896 " SELECT COUNT(*) FROM cust_pay_pending ".
3897 " WHERE custnum = ? AND status != 'done' ",
3902 =item num_cust_pay_pending_attempt
3904 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3905 customer, with status "done" but without a corresp. Also called automatically when the
3906 cust_pay_pending method is used in a scalar context.
3910 sub num_cust_pay_pending_attempt {
3913 " SELECT COUNT(*) FROM cust_pay_pending ".
3914 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3921 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3927 map { $_ } #return $self->num_cust_refund unless wantarray;
3928 sort { $a->_date <=> $b->_date }
3929 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3932 =item display_custnum
3934 Returns the displayed customer number for this customer: agent_custid if
3935 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3939 sub display_custnum {
3942 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3943 if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3944 if ( $special eq 'CoStAg' ) {
3945 $prefix = uc( join('',
3947 ($self->state =~ /^(..)/),
3948 $prefix || ($self->agent->agent =~ /^(..)/)
3951 elsif ( $special eq 'CoStCl' ) {
3952 $prefix = uc( join('',
3954 ($self->state =~ /^(..)/),
3955 ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3958 # add any others here if needed
3961 my $length = $conf->config('cust_main-custnum-display_length');
3962 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3963 return $self->agent_custid;
3964 } elsif ( $prefix ) {
3965 $length = 8 if !defined($length);
3967 sprintf('%0'.$length.'d', $self->custnum)
3968 } elsif ( $length ) {
3969 return sprintf('%0'.$length.'d', $self->custnum);
3971 return $self->custnum;
3977 Returns a name string for this customer, either "Company (Last, First)" or
3984 my $name = $self->contact;
3985 $name = $self->company. " ($name)" if $self->company;
3989 =item service_contact
3991 Returns the L<FS::contact> object for this customer that has the 'Service'
3992 contact class, or undef if there is no such contact. Deprecated; don't use
3997 sub service_contact {
3999 if ( !exists($self->{service_contact}) ) {
4000 my $classnum = $self->scalar_sql(
4001 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4002 ) || 0; #if it's zero, qsearchs will return nothing
4003 $self->{service_contact} = qsearchs('contact', {
4004 'classnum' => $classnum, 'custnum' => $self->custnum
4007 $self->{service_contact};
4012 Returns a name string for this (service/shipping) contact, either
4013 "Company (Last, First)" or "Last, First".
4020 my $name = $self->ship_contact;
4021 $name = $self->company. " ($name)" if $self->company;
4027 Returns a name string for this customer, either "Company" or "First Last".
4033 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4036 =item ship_name_short
4038 Returns a name string for this (service/shipping) contact, either "Company"
4043 sub ship_name_short {
4045 $self->service_contact
4046 ? $self->ship_contact_firstlast
4052 Returns this customer's full (billing) contact name only, "Last, First"
4058 $self->get('last'). ', '. $self->first;
4063 Returns this customer's full (shipping) contact name only, "Last, First"
4069 my $contact = $self->service_contact || $self;
4070 $contact->get('last') . ', ' . $contact->get('first');
4073 =item contact_firstlast
4075 Returns this customers full (billing) contact name only, "First Last".
4079 sub contact_firstlast {
4081 $self->first. ' '. $self->get('last');
4084 =item ship_contact_firstlast
4086 Returns this customer's full (shipping) contact name only, "First Last".
4090 sub ship_contact_firstlast {
4092 my $contact = $self->service_contact || $self;
4093 $contact->get('first') . ' '. $contact->get('last');
4096 #XXX this doesn't work in 3.x+
4099 #Returns this customer's full country name
4105 # code2country($self->country);
4108 sub bill_country_full {
4110 code2country($self->bill_location->country);
4113 sub ship_country_full {
4115 code2country($self->ship_location->country);
4118 =item county_state_county [ PREFIX ]
4120 Returns a string consisting of just the county, state and country.
4124 sub county_state_country {
4127 if ( @_ && $_[0] && $self->has_ship_address ) {
4128 $locationnum = $self->ship_locationnum;
4130 $locationnum = $self->bill_locationnum;
4132 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4133 $cust_location->county_state_country;
4136 =item geocode DATA_VENDOR
4138 Returns a value for the customer location as encoded by DATA_VENDOR.
4139 Currently this only makes sense for "CCH" as DATA_VENDOR.
4147 Returns a status string for this customer, currently:
4151 =item prospect - No packages have ever been ordered
4153 =item ordered - Recurring packages all are new (not yet billed).
4155 =item active - One or more recurring packages is active
4157 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4159 =item suspended - All non-cancelled recurring packages are suspended
4161 =item cancelled - All recurring packages are cancelled
4165 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4166 cust_main-status_module configuration option.
4170 sub status { shift->cust_status(@_); }
4174 for my $status ( FS::cust_main->statuses() ) {
4175 my $method = $status.'_sql';
4176 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4177 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4178 $sth->execute( ($self->custnum) x $numnum )
4179 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4180 return $status if $sth->fetchrow_arrayref->[0];
4184 =item ucfirst_cust_status
4186 =item ucfirst_status
4188 Returns the status with the first character capitalized.
4192 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4194 sub ucfirst_cust_status {
4196 ucfirst($self->cust_status);
4201 Returns a hex triplet color string for this customer's status.
4205 sub statuscolor { shift->cust_statuscolor(@_); }
4207 sub cust_statuscolor {
4209 __PACKAGE__->statuscolors->{$self->cust_status};
4212 =item tickets [ STATUS ]
4214 Returns an array of hashes representing the customer's RT tickets.
4216 An optional status (or arrayref or hashref of statuses) may be specified.
4222 my $status = ( @_ && $_[0] ) ? shift : '';
4224 my $num = $conf->config('cust_main-max_tickets') || 10;
4227 if ( $conf->config('ticket_system') ) {
4228 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4230 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4239 foreach my $priority (
4240 $conf->config('ticket_system-custom_priority_field-values'), ''
4242 last if scalar(@tickets) >= $num;
4244 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4245 $num - scalar(@tickets),
4256 # Return services representing svc_accts in customer support packages
4257 sub support_services {
4259 my %packages = map { $_ => 1 } $conf->config('support_packages');
4261 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4262 grep { $_->part_svc->svcdb eq 'svc_acct' }
4263 map { $_->cust_svc }
4264 grep { exists $packages{ $_->pkgpart } }
4265 $self->ncancelled_pkgs;
4269 # Return a list of latitude/longitude for one of the services (if any)
4270 sub service_coordinates {
4274 grep { $_->latitude && $_->longitude }
4276 map { $_->cust_svc }
4277 $self->ncancelled_pkgs;
4279 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4284 Returns a masked version of the named field
4289 my ($self,$field) = @_;
4293 'x'x(length($self->getfield($field))-4).
4294 substr($self->getfield($field), (length($self->getfield($field))-4));
4300 =head1 CLASS METHODS
4306 Class method that returns the list of possible status strings for customers
4307 (see L<the status method|/status>). For example:
4309 @statuses = FS::cust_main->statuses();
4315 keys %{ $self->statuscolors };
4318 =item cust_status_sql
4320 Returns an SQL fragment to determine the status of a cust_main record, as a
4325 sub cust_status_sql {
4327 for my $status ( FS::cust_main->statuses() ) {
4328 my $method = $status.'_sql';
4329 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4338 Returns an SQL expression identifying prospective cust_main records (customers
4339 with no packages ever ordered)
4343 use vars qw($select_count_pkgs);
4344 $select_count_pkgs =
4345 "SELECT COUNT(*) FROM cust_pkg
4346 WHERE cust_pkg.custnum = cust_main.custnum";
4348 sub select_count_pkgs_sql {
4353 " 0 = ( $select_count_pkgs ) ";
4358 Returns an SQL expression identifying ordered cust_main records (customers with
4359 no active packages, but recurring packages not yet setup or one time charges
4365 FS::cust_main->none_active_sql.
4366 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4371 Returns an SQL expression identifying active cust_main records (customers with
4372 active recurring packages).
4377 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4380 =item none_active_sql
4382 Returns an SQL expression identifying cust_main records with no active
4383 recurring packages. This includes customers of status prospect, ordered,
4384 inactive, and suspended.
4388 sub none_active_sql {
4389 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4394 Returns an SQL expression identifying inactive cust_main records (customers with
4395 no active recurring packages, but otherwise unsuspended/uncancelled).
4400 FS::cust_main->none_active_sql.
4401 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4407 Returns an SQL expression identifying suspended cust_main records.
4412 sub suspended_sql { susp_sql(@_); }
4414 FS::cust_main->none_active_sql.
4415 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4421 Returns an SQL expression identifying cancelled cust_main records.
4425 sub cancel_sql { shift->cancelled_sql(@_); }
4428 =item uncancelled_sql
4430 Returns an SQL expression identifying un-cancelled cust_main records.
4434 sub uncancelled_sql { uncancel_sql(@_); }
4435 sub uncancel_sql { "
4436 ( 0 < ( $select_count_pkgs
4437 AND ( cust_pkg.cancel IS NULL
4438 OR cust_pkg.cancel = 0
4441 OR 0 = ( $select_count_pkgs )
4447 Returns an SQL fragment to retreive the balance.
4452 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4453 WHERE cust_bill.custnum = cust_main.custnum )
4454 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4455 WHERE cust_pay.custnum = cust_main.custnum )
4456 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4457 WHERE cust_credit.custnum = cust_main.custnum )
4458 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4459 WHERE cust_refund.custnum = cust_main.custnum )
4462 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4464 Returns an SQL fragment to retreive the balance for this customer, optionally
4465 considering invoices with date earlier than START_TIME, and not
4466 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4467 total_unapplied_payments).
4469 Times are specified as SQL fragments or numeric
4470 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4471 L<Date::Parse> for conversion functions. The empty string can be passed
4472 to disable that time constraint completely.
4474 Available options are:
4478 =item unapplied_date
4480 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)
4485 set to true to remove all customer comparison clauses, for totals
4490 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4495 JOIN clause (typically used with the total option)
4499 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4500 time will be ignored. Note that START_TIME and END_TIME only limit the date
4501 range for invoices and I<unapplied> payments, credits, and refunds.
4507 sub balance_date_sql {
4508 my( $class, $start, $end, %opt ) = @_;
4510 my $cutoff = $opt{'cutoff'};
4512 my $owed = FS::cust_bill->owed_sql($cutoff);
4513 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4514 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4515 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4517 my $j = $opt{'join'} || '';
4519 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4520 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4521 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4522 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4524 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4525 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4526 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4527 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4532 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4534 Returns an SQL fragment to retreive the total unapplied payments for this
4535 customer, only considering payments with date earlier than START_TIME, and
4536 optionally not later than END_TIME.
4538 Times are specified as SQL fragments or numeric
4539 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4540 L<Date::Parse> for conversion functions. The empty string can be passed
4541 to disable that time constraint completely.
4543 Available options are:
4547 sub unapplied_payments_date_sql {
4548 my( $class, $start, $end, %opt ) = @_;
4550 my $cutoff = $opt{'cutoff'};
4552 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4554 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4555 'unapplied_date'=>1 );
4557 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4560 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4562 Helper method for balance_date_sql; name (and usage) subject to change
4563 (suggestions welcome).
4565 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4566 cust_refund, cust_credit or cust_pay).
4568 If TABLE is "cust_bill" or the unapplied_date option is true, only
4569 considers records with date earlier than START_TIME, and optionally not
4570 later than END_TIME .
4574 sub _money_table_where {
4575 my( $class, $table, $start, $end, %opt ) = @_;
4578 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4579 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4580 push @where, "$table._date <= $start" if defined($start) && length($start);
4581 push @where, "$table._date > $end" if defined($end) && length($end);
4583 push @where, @{$opt{'where'}} if $opt{'where'};
4584 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4590 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4591 use FS::cust_main::Search;
4594 FS::cust_main::Search->search(@_);
4609 #warn join('-',keys %$param);
4610 my $fh = $param->{filehandle};
4611 my $agentnum = $param->{agentnum};
4612 my $format = $param->{format};
4614 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4617 if ( $format eq 'simple' ) {
4618 @fields = qw( custnum agent_custid amount pkg );
4620 die "unknown format $format";
4623 eval "use Text::CSV_XS;";
4626 my $csv = new Text::CSV_XS;
4633 local $SIG{HUP} = 'IGNORE';
4634 local $SIG{INT} = 'IGNORE';
4635 local $SIG{QUIT} = 'IGNORE';
4636 local $SIG{TERM} = 'IGNORE';
4637 local $SIG{TSTP} = 'IGNORE';
4638 local $SIG{PIPE} = 'IGNORE';
4640 my $oldAutoCommit = $FS::UID::AutoCommit;
4641 local $FS::UID::AutoCommit = 0;
4644 #while ( $columns = $csv->getline($fh) ) {
4646 while ( defined($line=<$fh>) ) {
4648 $csv->parse($line) or do {
4649 $dbh->rollback if $oldAutoCommit;
4650 return "can't parse: ". $csv->error_input();
4653 my @columns = $csv->fields();
4654 #warn join('-',@columns);
4657 foreach my $field ( @fields ) {
4658 $row{$field} = shift @columns;
4661 if ( $row{custnum} && $row{agent_custid} ) {
4662 dbh->rollback if $oldAutoCommit;
4663 return "can't specify custnum with agent_custid $row{agent_custid}";
4667 if ( $row{agent_custid} && $agentnum ) {
4668 %hash = ( 'agent_custid' => $row{agent_custid},
4669 'agentnum' => $agentnum,
4673 if ( $row{custnum} ) {
4674 %hash = ( 'custnum' => $row{custnum} );
4677 unless ( scalar(keys %hash) ) {
4678 $dbh->rollback if $oldAutoCommit;
4679 return "can't find customer without custnum or agent_custid and agentnum";
4682 my $cust_main = qsearchs('cust_main', { %hash } );
4683 unless ( $cust_main ) {
4684 $dbh->rollback if $oldAutoCommit;
4685 my $custnum = $row{custnum} || $row{agent_custid};
4686 return "unknown custnum $custnum";
4689 if ( $row{'amount'} > 0 ) {
4690 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4692 $dbh->rollback if $oldAutoCommit;
4696 } elsif ( $row{'amount'} < 0 ) {
4697 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4700 $dbh->rollback if $oldAutoCommit;
4710 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4712 return "Empty file!" unless $imported;
4718 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4720 Deprecated. Use event notification and message templates
4721 (L<FS::msg_template>) instead.
4723 Sends a templated email notification to the customer (see L<Text::Template>).
4725 OPTIONS is a hash and may include
4727 I<from> - the email sender (default is invoice_from)
4729 I<to> - comma-separated scalar or arrayref of recipients
4730 (default is invoicing_list)
4732 I<subject> - The subject line of the sent email notification
4733 (default is "Notice from company_name")
4735 I<extra_fields> - a hashref of name/value pairs which will be substituted
4738 The following variables are vavailable in the template.
4740 I<$first> - the customer first name
4741 I<$last> - the customer last name
4742 I<$company> - the customer company
4743 I<$payby> - a description of the method of payment for the customer
4744 # would be nice to use FS::payby::shortname
4745 I<$payinfo> - the account information used to collect for this customer
4746 I<$expdate> - the expiration of the customer payment in seconds from epoch
4751 my ($self, $template, %options) = @_;
4753 return unless $conf->exists($template);
4755 my $from = $conf->config('invoice_from', $self->agentnum)
4756 if $conf->exists('invoice_from', $self->agentnum);
4757 $from = $options{from} if exists($options{from});
4759 my $to = join(',', $self->invoicing_list_emailonly);
4760 $to = $options{to} if exists($options{to});
4762 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4763 if $conf->exists('company_name', $self->agentnum);
4764 $subject = $options{subject} if exists($options{subject});
4766 my $notify_template = new Text::Template (TYPE => 'ARRAY',
4767 SOURCE => [ map "$_\n",
4768 $conf->config($template)]
4770 or die "can't create new Text::Template object: Text::Template::ERROR";
4771 $notify_template->compile()
4772 or die "can't compile template: Text::Template::ERROR";
4774 $FS::notify_template::_template::company_name =
4775 $conf->config('company_name', $self->agentnum);
4776 $FS::notify_template::_template::company_address =
4777 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4779 my $paydate = $self->paydate || '2037-12-31';
4780 $FS::notify_template::_template::first = $self->first;
4781 $FS::notify_template::_template::last = $self->last;
4782 $FS::notify_template::_template::company = $self->company;
4783 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4784 my $payby = $self->payby;
4785 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4786 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4788 #credit cards expire at the end of the month/year of their exp date
4789 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4790 $FS::notify_template::_template::payby = 'credit card';
4791 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4792 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4794 }elsif ($payby eq 'COMP') {
4795 $FS::notify_template::_template::payby = 'complimentary account';
4797 $FS::notify_template::_template::payby = 'current method';
4799 $FS::notify_template::_template::expdate = $expire_time;
4801 for (keys %{$options{extra_fields}}){
4803 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4806 send_email(from => $from,
4808 subject => $subject,
4809 body => $notify_template->fill_in( PACKAGE =>
4810 'FS::notify_template::_template' ),
4815 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4817 Generates a templated notification to the customer (see L<Text::Template>).
4819 OPTIONS is a hash and may include
4821 I<extra_fields> - a hashref of name/value pairs which will be substituted
4822 into the template. These values may override values mentioned below
4823 and those from the customer record.
4825 The following variables are available in the template instead of or in addition
4826 to the fields of the customer record.
4828 I<$payby> - a description of the method of payment for the customer
4829 # would be nice to use FS::payby::shortname
4830 I<$payinfo> - the masked account information used to collect for this customer
4831 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4832 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4836 # a lot like cust_bill::print_latex
4837 sub generate_letter {
4838 my ($self, $template, %options) = @_;
4840 return unless $conf->exists($template);
4842 my $letter_template = new Text::Template
4844 SOURCE => [ map "$_\n", $conf->config($template)],
4845 DELIMITERS => [ '[@--', '--@]' ],
4847 or die "can't create new Text::Template object: Text::Template::ERROR";
4849 $letter_template->compile()
4850 or die "can't compile template: Text::Template::ERROR";
4852 my %letter_data = map { $_ => $self->$_ } $self->fields;
4853 $letter_data{payinfo} = $self->mask_payinfo;
4855 #my $paydate = $self->paydate || '2037-12-31';
4856 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4858 my $payby = $self->payby;
4859 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4860 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4862 #credit cards expire at the end of the month/year of their exp date
4863 if ($payby eq 'CARD' || $payby eq 'DCRD') {
4864 $letter_data{payby} = 'credit card';
4865 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4866 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4868 }elsif ($payby eq 'COMP') {
4869 $letter_data{payby} = 'complimentary account';
4871 $letter_data{payby} = 'current method';
4873 $letter_data{expdate} = $expire_time;
4875 for (keys %{$options{extra_fields}}){
4876 $letter_data{$_} = $options{extra_fields}->{$_};
4879 unless(exists($letter_data{returnaddress})){
4880 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4881 $self->agent_template)
4883 if ( length($retadd) ) {
4884 $letter_data{returnaddress} = $retadd;
4885 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4886 $letter_data{returnaddress} =
4887 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4891 ( $conf->config('company_name', $self->agentnum),
4892 $conf->config('company_address', $self->agentnum),
4896 $letter_data{returnaddress} = '~';
4900 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4902 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4904 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4906 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4910 ) or die "can't open temp file: $!\n";
4911 print $lh $conf->config_binary('logo.eps', $self->agentnum)
4912 or die "can't write temp file: $!\n";
4914 $letter_data{'logo_file'} = $lh->filename;
4916 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4920 ) or die "can't open temp file: $!\n";
4922 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4924 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4925 return ($1, $letter_data{'logo_file'});
4929 =item print_ps TEMPLATE
4931 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4937 my($file, $lfile) = $self->generate_letter(@_);
4938 my $ps = FS::Misc::generate_ps($file);
4939 unlink($file.'.tex');
4945 =item print TEMPLATE
4947 Prints the filled in template.
4949 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4953 sub queueable_print {
4956 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4957 or die "invalid customer number: " . $opt{custnum};
4959 my $error = $self->print( { 'template' => $opt{template} } );
4960 die $error if $error;
4964 my ($self, $template) = (shift, shift);
4966 [ $self->print_ps($template) ],
4967 'agentnum' => $self->agentnum,
4971 #these three subs should just go away once agent stuff is all config overrides
4973 sub agent_template {
4975 $self->_agent_plandata('agent_templatename');
4978 sub agent_invoice_from {
4980 $self->_agent_plandata('agent_invoice_from');
4983 sub _agent_plandata {
4984 my( $self, $option ) = @_;
4986 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
4987 #agent-specific Conf
4989 use FS::part_event::Condition;
4991 my $agentnum = $self->agentnum;
4993 my $regexp = regexp_sql();
4995 my $part_event_option =
4997 'select' => 'part_event_option.*',
4998 'table' => 'part_event_option',
5000 LEFT JOIN part_event USING ( eventpart )
5001 LEFT JOIN part_event_option AS peo_agentnum
5002 ON ( part_event.eventpart = peo_agentnum.eventpart
5003 AND peo_agentnum.optionname = 'agentnum'
5004 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5006 LEFT JOIN part_event_condition
5007 ON ( part_event.eventpart = part_event_condition.eventpart
5008 AND part_event_condition.conditionname = 'cust_bill_age'
5010 LEFT JOIN part_event_condition_option
5011 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5012 AND part_event_condition_option.optionname = 'age'
5015 #'hashref' => { 'optionname' => $option },
5016 #'hashref' => { 'part_event_option.optionname' => $option },
5018 " WHERE part_event_option.optionname = ". dbh->quote($option).
5019 " AND action = 'cust_bill_send_agent' ".
5020 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5021 " AND peo_agentnum.optionname = 'agentnum' ".
5022 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5024 CASE WHEN part_event_condition_option.optionname IS NULL
5026 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5028 , part_event.weight".
5032 unless ( $part_event_option ) {
5033 return $self->agent->invoice_template || ''
5034 if $option eq 'agent_templatename';
5038 $part_event_option->optionvalue;
5042 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5044 Subroutine (not a method), designed to be called from the queue.
5046 Takes a list of options and values.
5048 Pulls up the customer record via the custnum option and calls bill_and_collect.
5053 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5055 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5056 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5058 $cust_main->bill_and_collect( %args );
5061 sub process_bill_and_collect {
5063 my $param = thaw(decode_base64(shift));
5064 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5065 or die "custnum '$param->{custnum}' not found!\n";
5066 $param->{'job'} = $job;
5067 $param->{'fatal'} = 1; # runs from job queue, will be caught
5068 $param->{'retry'} = 1;
5070 $cust_main->bill_and_collect( %$param );
5073 #starting to take quite a while for big dbs
5074 # (JRNL: journaled so it only happens once per database)
5075 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5076 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5077 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5078 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5079 # JRNL leading/trailing spaces in first, last, company
5080 # JRNL migrate to cust_payby
5081 # - otaker upgrade? journal and call it good? (double check to make sure
5082 # we're not still setting otaker here)
5084 #only going to get worse with new location stuff...
5086 sub _upgrade_data { #class method
5087 my ($class, %opts) = @_;
5090 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5093 #this seems to be the only expensive one.. why does it take so long?
5094 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5096 'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE signupdate IS NOT NULL AND h_cust_main.custnum = cust_main.custnum ORDER BY historynum DESC LIMIT 1) WHERE signupdate IS NULL';
5097 FS::upgrade_journal->set_done('cust_main__signupdate');
5100 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5102 # fix yyyy-m-dd formatted paydates
5103 if ( driver_name =~ /^mysql/i ) {
5105 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5106 } else { # the SQL standard
5108 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5110 FS::upgrade_journal->set_done('cust_main__paydate');
5113 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5115 push @statements, #fix the weird BILL with a cc# in payinfo problem
5117 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5119 FS::upgrade_journal->set_done('cust_main__payinfo');
5124 foreach my $sql ( @statements ) {
5125 my $sth = dbh->prepare($sql) or die dbh->errstr;
5126 $sth->execute or die $sth->errstr;
5127 #warn ( (time - $t). " seconds\n" );
5131 local($ignore_expired_card) = 1;
5132 local($ignore_banned_card) = 1;
5133 local($skip_fuzzyfiles) = 1;
5134 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5136 FS::cust_main::Location->_upgrade_data(%opts);
5138 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5140 foreach my $cust_main ( qsearch({
5141 'table' => 'cust_main',
5143 'extra_sql' => 'WHERE '.
5145 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5146 qw( first last company )
5149 my $error = $cust_main->replace;
5150 die $error if $error;
5153 FS::upgrade_journal->set_done('cust_main__trimspaces');
5157 unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5159 #we don't want to decrypt them, just stuff them as-is into cust_payby
5160 local(@encrypted_fields) = ();
5162 local($FS::cust_payby::ignore_expired_card) = 1;
5163 local($FS::cust_payby::ignore_banned_card) = 1;
5165 my @payfields = qw( payby payinfo paycvv paymask
5166 paydate paystart_month paystart_year payissue
5167 payname paystate paytype payip
5170 my $search = new FS::Cursor {
5171 'table' => 'cust_main',
5172 'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5175 while (my $cust_main = $search->fetch) {
5177 my $cust_payby = new FS::cust_payby {
5178 'custnum' => $cust_main->custnum,
5180 map { $_ => $cust_main->$_(); } @payfields
5183 my $error = $cust_payby->insert;
5184 die $error if $error;
5186 $cust_main->setfield($_, '') foreach @payfields;
5187 $error = $cust_main->replace;
5188 die $error if $error;
5192 FS::upgrade_journal->set_done('cust_main__cust_payby');
5195 $class->_upgrade_otaker(%opts);
5205 The delete method should possibly take an FS::cust_main object reference
5206 instead of a scalar customer number.
5208 Bill and collect options should probably be passed as references instead of a
5211 There should probably be a configuration file with a list of allowed credit
5214 No multiple currency support (probably a larger project than just this module).
5216 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5218 Birthdates rely on negative epoch values.
5220 The payby for card/check batches is broken. With mixed batching, bad
5223 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5227 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5228 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5229 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.