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::cust_main::Credit_Limit
12 FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
13 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
17 use vars qw( $DEBUG $me $conf $default_agent_custid $custnum_display_length
20 $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;
36 use FS::UID qw( getotaker dbh driver_name );
37 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
38 use FS::Misc qw( generate_email send_email generate_ps do_print money_pretty card_types );
39 use FS::Msgcat qw(gettext);
46 use FS::cust_bill_void;
47 use FS::legacy_cust_bill;
49 use FS::cust_pay_pending;
50 use FS::cust_pay_void;
51 use FS::cust_pay_batch;
54 use FS::part_referral;
55 use FS::cust_main_county;
56 use FS::cust_location;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
62 use FS::cust_main_invoice;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
79 # 1 is mostly method/subroutine entry and options
80 # 2 traces progress of some operations
81 # 3 is even more information including possibly sensitive data
83 $me = '[FS::cust_main]';
86 $ignore_expired_card = 0;
87 $ignore_banned_card = 0;
91 @encrypted_fields = ('payinfo', 'paycvv');
92 sub nohistory_fields { ('payinfo', 'paycvv'); }
94 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
96 #ask FS::UID to run this stuff for us later
97 #$FS::UID::callback{'FS::cust_main'} = sub {
98 install_callback FS::UID sub {
100 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
101 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
106 my ( $hashref, $cache ) = @_;
107 if ( exists $hashref->{'pkgnum'} ) {
108 #@{ $self->{'_pkgnum'} } = ();
109 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
110 $self->{'_pkgnum'} = $subcache;
111 #push @{ $self->{'_pkgnum'} },
112 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
118 FS::cust_main - Object methods for cust_main records
124 $record = new FS::cust_main \%hash;
125 $record = new FS::cust_main { 'column' => 'value' };
127 $error = $record->insert;
129 $error = $new_record->replace($old_record);
131 $error = $record->delete;
133 $error = $record->check;
135 @cust_pkg = $record->all_pkgs;
137 @cust_pkg = $record->ncancelled_pkgs;
139 @cust_pkg = $record->suspended_pkgs;
141 $error = $record->bill;
142 $error = $record->bill %options;
143 $error = $record->bill 'time' => $time;
145 $error = $record->collect;
146 $error = $record->collect %options;
147 $error = $record->collect 'invoice_time' => $time,
152 An FS::cust_main object represents a customer. FS::cust_main inherits from
153 FS::Record. The following fields are currently supported:
159 Primary key (assigned automatically for new customers)
163 Agent (see L<FS::agent>)
167 Advertising source (see L<FS::part_referral>)
179 Cocial security number (optional)
203 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
207 Payment Information (See L<FS::payinfo_Mixin> for data format)
211 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
215 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
219 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
223 Start date month (maestro/solo cards only)
227 Start date year (maestro/solo cards only)
231 Issue number (maestro/solo cards only)
235 Name on card or billing name
239 IP address from which payment information was received
243 Tax exempt, empty or `Y'
247 Order taker (see L<FS::access_user>)
253 =item referral_custnum
255 Referring customer number
259 Enable individual CDR spooling, empty or `Y'
263 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
267 Discourage individual CDR printing, empty or `Y'
271 Allow self-service editing of ticket subjects, empty or 'Y'
273 =item calling_list_exempt
275 Do not call, empty or 'Y'
277 =item invoice_ship_address
279 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
289 Creates a new customer. To add the customer to the database, see L<"insert">.
291 Note that this stores the hash reference, not a distinct copy of the hash it
292 points to. You can ask the object for a copy with the I<hash> method.
296 sub table { 'cust_main'; }
298 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
300 Adds this customer to the database. If there is an error, returns the error,
301 otherwise returns false.
303 Usually the customer's location will not yet exist in the database, and
304 the C<bill_location> and C<ship_location> pseudo-fields must be set to
305 uninserted L<FS::cust_location> objects. These will be inserted and linked
306 (in both directions) to the new customer record. If they're references
307 to the same object, they will become the same location.
309 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
310 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
311 are inserted atomicly, or the transaction is rolled back. Passing an empty
312 hash reference is equivalent to not supplying this parameter. There should be
313 a better explanation of this, but until then, here's an example:
316 tie %hash, 'Tie::RefHash'; #this part is important
318 $cust_pkg => [ $svc_acct ],
321 $cust_main->insert( \%hash );
323 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
324 be set as the invoicing list (see L<"invoicing_list">). Errors return as
325 expected and rollback the entire transaction; it is not necessary to call
326 check_invoicing_list first. The invoicing_list is set after the records in the
327 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
328 invoicing_list destination to the newly-created svc_acct. Here's an example:
330 $cust_main->insert( {}, [ $email, 'POST' ] );
332 Currently available options are: I<depend_jobnum>, I<noexport>,
333 I<tax_exemption> and I<prospectnum>.
335 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
336 on the supplied jobnum (they will not run until the specific job completes).
337 This can be used to defer provisioning until some action completes (such
338 as running the customer's credit card successfully).
340 The I<noexport> option is deprecated. If I<noexport> is set true, no
341 provisioning jobs (exports) are scheduled. (You can schedule them later with
342 the B<reexport> method.)
344 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
345 of tax names and exemption numbers. FS::cust_main_exemption records will be
346 created and inserted.
348 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 my $cust_pkgs = @_ ? shift : {};
355 my $invoicing_list = @_ ? shift : '';
357 warn "$me insert called with options ".
358 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
361 local $SIG{HUP} = 'IGNORE';
362 local $SIG{INT} = 'IGNORE';
363 local $SIG{QUIT} = 'IGNORE';
364 local $SIG{TERM} = 'IGNORE';
365 local $SIG{TSTP} = 'IGNORE';
366 local $SIG{PIPE} = 'IGNORE';
368 my $oldAutoCommit = $FS::UID::AutoCommit;
369 local $FS::UID::AutoCommit = 0;
372 my $prepay_identifier = '';
373 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
375 if ( $self->payby eq 'PREPAY' ) {
377 $self->payby('BILL');
378 $prepay_identifier = $self->payinfo;
381 warn " looking up prepaid card $prepay_identifier\n"
384 my $error = $self->get_prepay( $prepay_identifier,
385 'amount_ref' => \$amount,
386 'seconds_ref' => \$seconds,
387 'upbytes_ref' => \$upbytes,
388 'downbytes_ref' => \$downbytes,
389 'totalbytes_ref' => \$totalbytes,
392 $dbh->rollback if $oldAutoCommit;
393 #return "error applying prepaid card (transaction rolled back): $error";
397 $payby = 'PREP' if $amount;
399 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
402 $self->payby('BILL');
403 $amount = $self->paid;
408 foreach my $l (qw(bill_location ship_location)) {
410 my $loc = delete $self->hashref->{$l} or return "$l not set";
412 if ( !$loc->locationnum ) {
413 # warn the location that we're going to insert it with no custnum
414 $loc->set(custnum_pending => 1);
415 warn " inserting $l\n"
417 my $error = $loc->insert;
419 $dbh->rollback if $oldAutoCommit;
420 my $label = $l eq 'ship_location' ? 'service' : 'billing';
421 return "$error (in $label location)";
424 } elsif ( $loc->prospectnum ) {
426 $loc->prospectnum('');
427 $loc->set(custnum_pending => 1);
428 my $error = $loc->replace;
430 $dbh->rollback if $oldAutoCommit;
431 my $label = $l eq 'ship_location' ? 'service' : 'billing';
432 return "$error (moving $label location)";
435 } elsif ( ($loc->custnum || 0) > 0 ) {
436 # then it somehow belongs to another customer--shouldn't happen
437 $dbh->rollback if $oldAutoCommit;
438 return "$l belongs to customer ".$loc->custnum;
440 # else it already belongs to this customer
441 # (happens when ship_location is identical to bill_location)
443 $self->set($l.'num', $loc->locationnum);
445 if ( $self->get($l.'num') eq '' ) {
446 $dbh->rollback if $oldAutoCommit;
451 warn " inserting $self\n"
454 $self->signupdate(time) unless $self->signupdate;
456 $self->auto_agent_custid()
457 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
459 my $error = $self->check_payinfo_cardtype
460 || $self->SUPER::insert;
462 $dbh->rollback if $oldAutoCommit;
463 #return "inserting cust_main record (transaction rolled back): $error";
467 # now set cust_location.custnum
468 foreach my $l (qw(bill_location ship_location)) {
469 warn " setting $l.custnum\n"
472 unless ( $loc->custnum ) {
473 $loc->set(custnum => $self->custnum);
474 $error ||= $loc->replace;
478 $dbh->rollback if $oldAutoCommit;
479 return "error setting $l custnum: $error";
483 warn " setting invoicing list\n"
486 if ( $invoicing_list ) {
487 $error = $self->check_invoicing_list( $invoicing_list );
489 $dbh->rollback if $oldAutoCommit;
490 #return "checking invoicing_list (transaction rolled back): $error";
493 $self->invoicing_list( $invoicing_list );
496 warn " setting customer tags\n"
499 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
500 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
501 'custnum' => $self->custnum };
502 my $error = $cust_tag->insert;
504 $dbh->rollback if $oldAutoCommit;
509 my $prospectnum = delete $options{'prospectnum'};
510 if ( $prospectnum ) {
512 warn " moving contacts and locations from prospect $prospectnum\n"
516 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
517 unless ( $prospect_main ) {
518 $dbh->rollback if $oldAutoCommit;
519 return "Unknown prospectnum $prospectnum";
521 $prospect_main->custnum($self->custnum);
522 $prospect_main->disabled('Y');
523 my $error = $prospect_main->replace;
525 $dbh->rollback if $oldAutoCommit;
529 my @contact = $prospect_main->contact;
530 my @cust_location = $prospect_main->cust_location;
531 my @qual = $prospect_main->qual;
533 foreach my $r ( @contact, @cust_location, @qual ) {
535 $r->custnum($self->custnum);
536 my $error = $r->replace;
538 $dbh->rollback if $oldAutoCommit;
545 warn " setting contacts\n"
548 if ( my $contact = delete $options{'contact'} ) {
550 foreach my $c ( @$contact ) {
551 $c->custnum($self->custnum);
552 my $error = $c->insert;
554 $dbh->rollback if $oldAutoCommit;
560 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
562 my $error = $self->process_o2m( 'table' => 'contact',
563 'fields' => FS::contact->cgi_contact_fields,
564 'params' => $contact_params,
567 $dbh->rollback if $oldAutoCommit;
572 warn " setting cust_main_exemption\n"
575 my $tax_exemption = delete $options{'tax_exemption'};
576 if ( $tax_exemption ) {
578 $tax_exemption = { map { $_ => '' } @$tax_exemption }
579 if ref($tax_exemption) eq 'ARRAY';
581 foreach my $taxname ( keys %$tax_exemption ) {
582 my $cust_main_exemption = new FS::cust_main_exemption {
583 'custnum' => $self->custnum,
584 'taxname' => $taxname,
585 'exempt_number' => $tax_exemption->{$taxname},
587 my $error = $cust_main_exemption->insert;
589 $dbh->rollback if $oldAutoCommit;
590 return "inserting cust_main_exemption (transaction rolled back): $error";
595 warn " ordering packages\n"
598 $error = $self->order_pkgs( $cust_pkgs,
600 'seconds_ref' => \$seconds,
601 'upbytes_ref' => \$upbytes,
602 'downbytes_ref' => \$downbytes,
603 'totalbytes_ref' => \$totalbytes,
606 $dbh->rollback if $oldAutoCommit;
611 $dbh->rollback if $oldAutoCommit;
612 return "No svc_acct record to apply pre-paid time";
614 if ( $upbytes || $downbytes || $totalbytes ) {
615 $dbh->rollback if $oldAutoCommit;
616 return "No svc_acct record to apply pre-paid data";
620 warn " inserting initial $payby payment of $amount\n"
622 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
624 $dbh->rollback if $oldAutoCommit;
625 return "inserting payment (transaction rolled back): $error";
629 unless ( $import || $skip_fuzzyfiles ) {
630 warn " queueing fuzzyfiles update\n"
632 $error = $self->queue_fuzzyfiles_update;
634 $dbh->rollback if $oldAutoCommit;
635 return "updating fuzzy search cache: $error";
639 # FS::geocode_Mixin::after_insert or something?
640 if ( $conf->config('tax_district_method') and !$import ) {
641 # if anything non-empty, try to look it up
642 my $queue = new FS::queue {
643 'job' => 'FS::geocode_Mixin::process_district_update',
644 'custnum' => $self->custnum,
646 my $error = $queue->insert( ref($self), $self->custnum );
648 $dbh->rollback if $oldAutoCommit;
649 return "queueing tax district update: $error";
654 warn " exporting\n" if $DEBUG > 1;
656 my $export_args = $options{'export_args'} || [];
659 map qsearch( 'part_export', {exportnum=>$_} ),
660 $conf->config('cust_main-exports'); #, $agentnum
662 foreach my $part_export ( @part_export ) {
663 my $error = $part_export->export_insert($self, @$export_args);
665 $dbh->rollback if $oldAutoCommit;
666 return "exporting to ". $part_export->exporttype.
667 " (transaction rolled back): $error";
671 #foreach my $depend_jobnum ( @$depend_jobnums ) {
672 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
674 # foreach my $jobnum ( @jobnums ) {
675 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
676 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
678 # my $error = $queue->depend_insert($depend_jobnum);
680 # $dbh->rollback if $oldAutoCommit;
681 # return "error queuing job dependancy: $error";
688 #if ( exists $options{'jobnums'} ) {
689 # push @{ $options{'jobnums'} }, @jobnums;
692 warn " insert complete; committing transaction\n"
695 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
700 use File::CounterFile;
701 sub auto_agent_custid {
704 my $format = $conf->config('cust_main-auto_agent_custid');
706 if ( $format eq '1YMMXXXXXXXX' ) {
708 my $counter = new File::CounterFile 'cust_main.agent_custid';
711 my $ym = 100000000000 + time2str('%y%m00000000', time);
712 if ( $ym > $counter->value ) {
713 $counter->{'value'} = $agent_custid = $ym;
714 $counter->{'updated'} = 1;
716 $agent_custid = $counter->inc;
722 die "Unknown cust_main-auto_agent_custid format: $format";
725 $self->agent_custid($agent_custid);
729 =item PACKAGE METHODS
731 Documentation on customer package methods has been moved to
732 L<FS::cust_main::Packages>.
734 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
736 Recharges this (existing) customer with the specified prepaid card (see
737 L<FS::prepay_credit>), specified either by I<identifier> or as an
738 FS::prepay_credit object. If there is an error, returns the error, otherwise
741 Optionally, five scalar references can be passed as well. They will have their
742 values filled in with the amount, number of seconds, and number of upload,
743 download, and total bytes applied by this prepaid card.
747 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
748 #the only place that uses these args
749 sub recharge_prepay {
750 my( $self, $prepay_credit, $amountref, $secondsref,
751 $upbytesref, $downbytesref, $totalbytesref ) = @_;
753 local $SIG{HUP} = 'IGNORE';
754 local $SIG{INT} = 'IGNORE';
755 local $SIG{QUIT} = 'IGNORE';
756 local $SIG{TERM} = 'IGNORE';
757 local $SIG{TSTP} = 'IGNORE';
758 local $SIG{PIPE} = 'IGNORE';
760 my $oldAutoCommit = $FS::UID::AutoCommit;
761 local $FS::UID::AutoCommit = 0;
764 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
766 my $error = $self->get_prepay( $prepay_credit,
767 'amount_ref' => \$amount,
768 'seconds_ref' => \$seconds,
769 'upbytes_ref' => \$upbytes,
770 'downbytes_ref' => \$downbytes,
771 'totalbytes_ref' => \$totalbytes,
773 || $self->increment_seconds($seconds)
774 || $self->increment_upbytes($upbytes)
775 || $self->increment_downbytes($downbytes)
776 || $self->increment_totalbytes($totalbytes)
777 || $self->insert_cust_pay_prepay( $amount,
779 ? $prepay_credit->identifier
784 $dbh->rollback if $oldAutoCommit;
788 if ( defined($amountref) ) { $$amountref = $amount; }
789 if ( defined($secondsref) ) { $$secondsref = $seconds; }
790 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
791 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
792 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
794 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
799 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
801 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
802 specified either by I<identifier> or as an FS::prepay_credit object.
804 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
805 incremented by the values of the prepaid card.
807 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
808 check or set this customer's I<agentnum>.
810 If there is an error, returns the error, otherwise returns false.
816 my( $self, $prepay_credit, %opt ) = @_;
818 local $SIG{HUP} = 'IGNORE';
819 local $SIG{INT} = 'IGNORE';
820 local $SIG{QUIT} = 'IGNORE';
821 local $SIG{TERM} = 'IGNORE';
822 local $SIG{TSTP} = 'IGNORE';
823 local $SIG{PIPE} = 'IGNORE';
825 my $oldAutoCommit = $FS::UID::AutoCommit;
826 local $FS::UID::AutoCommit = 0;
829 unless ( ref($prepay_credit) ) {
831 my $identifier = $prepay_credit;
833 $prepay_credit = qsearchs(
835 { 'identifier' => $identifier },
840 unless ( $prepay_credit ) {
841 $dbh->rollback if $oldAutoCommit;
842 return "Invalid prepaid card: ". $identifier;
847 if ( $prepay_credit->agentnum ) {
848 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
849 $dbh->rollback if $oldAutoCommit;
850 return "prepaid card not valid for agent ". $self->agentnum;
852 $self->agentnum($prepay_credit->agentnum);
855 my $error = $prepay_credit->delete;
857 $dbh->rollback if $oldAutoCommit;
858 return "removing prepay_credit (transaction rolled back): $error";
861 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
862 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
864 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
869 =item increment_upbytes SECONDS
871 Updates this customer's single or primary account (see L<FS::svc_acct>) by
872 the specified number of upbytes. If there is an error, returns the error,
873 otherwise returns false.
877 sub increment_upbytes {
878 _increment_column( shift, 'upbytes', @_);
881 =item increment_downbytes SECONDS
883 Updates this customer's single or primary account (see L<FS::svc_acct>) by
884 the specified number of downbytes. If there is an error, returns the error,
885 otherwise returns false.
889 sub increment_downbytes {
890 _increment_column( shift, 'downbytes', @_);
893 =item increment_totalbytes SECONDS
895 Updates this customer's single or primary account (see L<FS::svc_acct>) by
896 the specified number of totalbytes. If there is an error, returns the error,
897 otherwise returns false.
901 sub increment_totalbytes {
902 _increment_column( shift, 'totalbytes', @_);
905 =item increment_seconds SECONDS
907 Updates this customer's single or primary account (see L<FS::svc_acct>) by
908 the specified number of seconds. If there is an error, returns the error,
909 otherwise returns false.
913 sub increment_seconds {
914 _increment_column( shift, 'seconds', @_);
917 =item _increment_column AMOUNT
919 Updates this customer's single or primary account (see L<FS::svc_acct>) by
920 the specified number of seconds or bytes. If there is an error, returns
921 the error, otherwise returns false.
925 sub _increment_column {
926 my( $self, $column, $amount ) = @_;
927 warn "$me increment_column called: $column, $amount\n"
930 return '' unless $amount;
932 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
933 $self->ncancelled_pkgs;
936 return 'No packages with primary or single services found'.
937 ' to apply pre-paid time';
938 } elsif ( scalar(@cust_pkg) > 1 ) {
939 #maybe have a way to specify the package/account?
940 return 'Multiple packages found to apply pre-paid time';
943 my $cust_pkg = $cust_pkg[0];
944 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
948 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
951 return 'No account found to apply pre-paid time';
952 } elsif ( scalar(@cust_svc) > 1 ) {
953 return 'Multiple accounts found to apply pre-paid time';
956 my $svc_acct = $cust_svc[0]->svc_x;
957 warn " found service svcnum ". $svc_acct->pkgnum.
958 ' ('. $svc_acct->email. ")\n"
961 $column = "increment_$column";
962 $svc_acct->$column($amount);
966 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
968 Inserts a prepayment in the specified amount for this customer. An optional
969 second argument can specify the prepayment identifier for tracking purposes.
970 If there is an error, returns the error, otherwise returns false.
974 sub insert_cust_pay_prepay {
975 shift->insert_cust_pay('PREP', @_);
978 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
980 Inserts a cash payment in the specified amount for this customer. An optional
981 second argument can specify the payment identifier for tracking purposes.
982 If there is an error, returns the error, otherwise returns false.
986 sub insert_cust_pay_cash {
987 shift->insert_cust_pay('CASH', @_);
990 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
992 Inserts a Western Union payment in the specified amount for this customer. An
993 optional second argument can specify the prepayment identifier for tracking
994 purposes. If there is an error, returns the error, otherwise returns false.
998 sub insert_cust_pay_west {
999 shift->insert_cust_pay('WEST', @_);
1002 sub insert_cust_pay {
1003 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1004 my $payinfo = scalar(@_) ? shift : '';
1006 my $cust_pay = new FS::cust_pay {
1007 'custnum' => $self->custnum,
1008 'paid' => sprintf('%.2f', $amount),
1009 #'_date' => #date the prepaid card was purchased???
1011 'payinfo' => $payinfo,
1019 This method is deprecated. See the I<depend_jobnum> option to the insert and
1020 order_pkgs methods for a better way to defer provisioning.
1022 Re-schedules all exports by calling the B<reexport> method of all associated
1023 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1024 otherwise returns false.
1031 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1032 "use the depend_jobnum option to insert or order_pkgs to delay export";
1034 local $SIG{HUP} = 'IGNORE';
1035 local $SIG{INT} = 'IGNORE';
1036 local $SIG{QUIT} = 'IGNORE';
1037 local $SIG{TERM} = 'IGNORE';
1038 local $SIG{TSTP} = 'IGNORE';
1039 local $SIG{PIPE} = 'IGNORE';
1041 my $oldAutoCommit = $FS::UID::AutoCommit;
1042 local $FS::UID::AutoCommit = 0;
1045 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1046 my $error = $cust_pkg->reexport;
1048 $dbh->rollback if $oldAutoCommit;
1053 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1058 =item delete [ OPTION => VALUE ... ]
1060 This deletes the customer. If there is an error, returns the error, otherwise
1063 This will completely remove all traces of the customer record. This is not
1064 what you want when a customer cancels service; for that, cancel all of the
1065 customer's packages (see L</cancel>).
1067 If the customer has any uncancelled packages, you need to pass a new (valid)
1068 customer number for those packages to be transferred to, as the "new_customer"
1069 option. Cancelled packages will be deleted. Did I mention that this is NOT
1070 what you want when a customer cancels service and that you really should be
1071 looking at L<FS::cust_pkg/cancel>?
1073 You can't delete a customer with invoices (see L<FS::cust_bill>),
1074 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1075 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1076 set the "delete_financials" option to a true value.
1081 my( $self, %opt ) = @_;
1083 local $SIG{HUP} = 'IGNORE';
1084 local $SIG{INT} = 'IGNORE';
1085 local $SIG{QUIT} = 'IGNORE';
1086 local $SIG{TERM} = 'IGNORE';
1087 local $SIG{TSTP} = 'IGNORE';
1088 local $SIG{PIPE} = 'IGNORE';
1090 my $oldAutoCommit = $FS::UID::AutoCommit;
1091 local $FS::UID::AutoCommit = 0;
1094 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1095 $dbh->rollback if $oldAutoCommit;
1096 return "Can't delete a master agent customer";
1099 #use FS::access_user
1100 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1101 $dbh->rollback if $oldAutoCommit;
1102 return "Can't delete a master employee customer";
1105 tie my %financial_tables, 'Tie::IxHash',
1106 'cust_bill' => 'invoices',
1107 'cust_statement' => 'statements',
1108 'cust_credit' => 'credits',
1109 'cust_pay' => 'payments',
1110 'cust_refund' => 'refunds',
1113 foreach my $table ( keys %financial_tables ) {
1115 my @records = $self->$table();
1117 if ( @records && ! $opt{'delete_financials'} ) {
1118 $dbh->rollback if $oldAutoCommit;
1119 return "Can't delete a customer with ". $financial_tables{$table};
1122 foreach my $record ( @records ) {
1123 my $error = $record->delete;
1125 $dbh->rollback if $oldAutoCommit;
1126 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1132 my @cust_pkg = $self->ncancelled_pkgs;
1134 my $new_custnum = $opt{'new_custnum'};
1135 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1136 $dbh->rollback if $oldAutoCommit;
1137 return "Invalid new customer number: $new_custnum";
1139 foreach my $cust_pkg ( @cust_pkg ) {
1140 my %hash = $cust_pkg->hash;
1141 $hash{'custnum'} = $new_custnum;
1142 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1143 my $error = $new_cust_pkg->replace($cust_pkg,
1144 options => { $cust_pkg->options },
1147 $dbh->rollback if $oldAutoCommit;
1152 my @cancelled_cust_pkg = $self->all_pkgs;
1153 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1154 my $error = $cust_pkg->delete;
1156 $dbh->rollback if $oldAutoCommit;
1161 #cust_tax_adjustment in financials?
1162 #cust_pay_pending? ouch
1164 foreach my $table (qw(
1165 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1166 cust_location cust_main_note cust_tax_adjustment
1167 cust_pay_void cust_pay_batch queue cust_tax_exempt
1169 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1170 my $error = $record->delete;
1172 $dbh->rollback if $oldAutoCommit;
1178 my $sth = $dbh->prepare(
1179 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1181 my $errstr = $dbh->errstr;
1182 $dbh->rollback if $oldAutoCommit;
1185 $sth->execute($self->custnum) or do {
1186 my $errstr = $sth->errstr;
1187 $dbh->rollback if $oldAutoCommit;
1193 my $ticket_dbh = '';
1194 if ($conf->config('ticket_system') eq 'RT_Internal') {
1196 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1197 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1198 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1199 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1202 if ( $ticket_dbh ) {
1204 my $ticket_sth = $ticket_dbh->prepare(
1205 'DELETE FROM Links WHERE Target = ?'
1207 my $errstr = $ticket_dbh->errstr;
1208 $dbh->rollback if $oldAutoCommit;
1211 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1213 my $errstr = $ticket_sth->errstr;
1214 $dbh->rollback if $oldAutoCommit;
1218 #check and see if the customer is the only link on the ticket, and
1219 #if so, set the ticket to deleted status in RT?
1220 #maybe someday, for now this will at least fix tickets not displaying
1224 #delete the customer record
1226 my $error = $self->SUPER::delete;
1228 $dbh->rollback if $oldAutoCommit;
1232 # cust_main exports!
1234 #my $export_args = $options{'export_args'} || [];
1237 map qsearch( 'part_export', {exportnum=>$_} ),
1238 $conf->config('cust_main-exports'); #, $agentnum
1240 foreach my $part_export ( @part_export ) {
1241 my $error = $part_export->export_delete( $self ); #, @$export_args);
1243 $dbh->rollback if $oldAutoCommit;
1244 return "exporting to ". $part_export->exporttype.
1245 " (transaction rolled back): $error";
1249 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1254 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1256 This merges this customer into the provided new custnum, and then deletes the
1257 customer. If there is an error, returns the error, otherwise returns false.
1259 The source customer's name, company name, phone numbers, agent,
1260 referring customer, customer class, advertising source, order taker, and
1261 billing information (except balance) are discarded.
1263 All packages are moved to the target customer. Packages with package locations
1264 are preserved. Packages without package locations are moved to a new package
1265 location with the source customer's service/shipping address.
1267 All invoices, statements, payments, credits and refunds are moved to the target
1268 customer. The source customer's balance is added to the target customer.
1270 All notes, attachments, tickets and customer tags are moved to the target
1273 Change history is not currently moved.
1278 my( $self, $new_custnum, %opt ) = @_;
1280 return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1282 my $new_cust_main = qsearchs( 'cust_main', { 'custnum' => $new_custnum } )
1283 or return "Invalid new customer number: $new_custnum";
1285 return 'Access denied: "Merge customer across agents" access right required to merge into a customer of a different agent'
1286 if $self->agentnum != $new_cust_main->agentnum
1287 && ! $FS::CurrentUser::CurrentUser->access_right('Merge customer across agents');
1289 local $SIG{HUP} = 'IGNORE';
1290 local $SIG{INT} = 'IGNORE';
1291 local $SIG{QUIT} = 'IGNORE';
1292 local $SIG{TERM} = 'IGNORE';
1293 local $SIG{TSTP} = 'IGNORE';
1294 local $SIG{PIPE} = 'IGNORE';
1296 my $oldAutoCommit = $FS::UID::AutoCommit;
1297 local $FS::UID::AutoCommit = 0;
1300 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1301 $dbh->rollback if $oldAutoCommit;
1302 return "Can't merge a master agent customer";
1305 #use FS::access_user
1306 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1307 $dbh->rollback if $oldAutoCommit;
1308 return "Can't merge a master employee customer";
1311 if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1312 'status' => { op=>'!=', value=>'done' },
1316 $dbh->rollback if $oldAutoCommit;
1317 return "Can't merge a customer with pending payments";
1320 tie my %financial_tables, 'Tie::IxHash',
1321 'cust_bill' => 'invoices',
1322 'cust_bill_void' => 'voided invoices',
1323 'cust_statement' => 'statements',
1324 'cust_credit' => 'credits',
1325 'cust_credit_void' => 'voided credits',
1326 'cust_pay' => 'payments',
1327 'cust_pay_void' => 'voided payments',
1328 'cust_refund' => 'refunds',
1331 foreach my $table ( keys %financial_tables ) {
1333 my @records = $self->$table();
1335 foreach my $record ( @records ) {
1336 $record->custnum($new_custnum);
1337 my $error = $record->replace;
1339 $dbh->rollback if $oldAutoCommit;
1340 return "Error merging ". $financial_tables{$table}. ": $error\n";
1346 my $name = $self->ship_name; #?
1348 my $locationnum = '';
1349 foreach my $cust_pkg ( $self->all_pkgs ) {
1350 $cust_pkg->custnum($new_custnum);
1352 unless ( $cust_pkg->locationnum ) {
1353 unless ( $locationnum ) {
1354 my $cust_location = new FS::cust_location {
1355 $self->location_hash,
1356 'custnum' => $new_custnum,
1358 my $error = $cust_location->insert;
1360 $dbh->rollback if $oldAutoCommit;
1363 $locationnum = $cust_location->locationnum;
1365 $cust_pkg->locationnum($locationnum);
1368 my $error = $cust_pkg->replace;
1370 $dbh->rollback if $oldAutoCommit;
1374 # add customer (ship) name to svc_phone.phone_name if blank
1375 my @cust_svc = $cust_pkg->cust_svc;
1376 foreach my $cust_svc (@cust_svc) {
1377 my($label, $value, $svcdb) = $cust_svc->label;
1378 next unless $svcdb eq 'svc_phone';
1379 my $svc_phone = $cust_svc->svc_x;
1380 next if $svc_phone->phone_name;
1381 $svc_phone->phone_name($name);
1382 my $error = $svc_phone->replace;
1384 $dbh->rollback if $oldAutoCommit;
1392 # cust_tax_exempt (texas tax exemptions)
1393 # cust_recon (some sort of not-well understood thing for OnPac)
1395 #these are moved over
1396 foreach my $table (qw(
1397 cust_tag cust_location contact cust_attachment cust_main_note
1398 cust_tax_adjustment cust_pay_batch queue
1400 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1401 $record->custnum($new_custnum);
1402 my $error = $record->replace;
1404 $dbh->rollback if $oldAutoCommit;
1410 #these aren't preserved
1411 foreach my $table (qw(
1412 cust_main_exemption cust_main_invoice
1414 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1415 my $error = $record->delete;
1417 $dbh->rollback if $oldAutoCommit;
1424 my $sth = $dbh->prepare(
1425 'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1427 my $errstr = $dbh->errstr;
1428 $dbh->rollback if $oldAutoCommit;
1431 $sth->execute($new_custnum, $self->custnum) or do {
1432 my $errstr = $sth->errstr;
1433 $dbh->rollback if $oldAutoCommit;
1439 my $ticket_dbh = '';
1440 if ($conf->config('ticket_system') eq 'RT_Internal') {
1442 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1443 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1444 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1445 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1448 if ( $ticket_dbh ) {
1450 my $ticket_sth = $ticket_dbh->prepare(
1451 'UPDATE Links SET Target = ? WHERE Target = ?'
1453 my $errstr = $ticket_dbh->errstr;
1454 $dbh->rollback if $oldAutoCommit;
1457 $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1458 'freeside://freeside/cust_main/'.$self->custnum)
1460 my $errstr = $ticket_sth->errstr;
1461 $dbh->rollback if $oldAutoCommit;
1467 #delete the customer record
1469 my $error = $self->delete;
1471 $dbh->rollback if $oldAutoCommit;
1475 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1480 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1482 Replaces the OLD_RECORD with this one in the database. If there is an error,
1483 returns the error, otherwise returns false.
1485 To change the customer's address, set the pseudo-fields C<bill_location> and
1486 C<ship_location>. The address will still only change if at least one of the
1487 address fields differs from the existing values.
1489 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1490 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1491 expected and rollback the entire transaction; it is not necessary to call
1492 check_invoicing_list first. Here's an example:
1494 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1496 Currently available options are: I<tax_exemption>.
1498 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1499 of tax names and exemption numbers. FS::cust_main_exemption records will be
1500 deleted and inserted as appropriate.
1507 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1509 : $self->replace_old;
1513 warn "$me replace called\n"
1516 my $curuser = $FS::CurrentUser::CurrentUser;
1517 if ( $self->payby eq 'COMP'
1518 && $self->payby ne $old->payby
1519 && ! $curuser->access_right('Complimentary customer')
1522 return "You are not permitted to create complimentary accounts.";
1525 local($ignore_expired_card) = 1
1526 if $old->payby =~ /^(CARD|DCRD)$/
1527 && $self->payby =~ /^(CARD|DCRD)$/
1528 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1530 local($ignore_banned_card) = 1
1531 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1532 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1533 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1535 if ( $self->payby =~ /^(CARD|DCRD)$/
1536 && $old->payinfo ne $self->payinfo
1537 && $old->paymask ne $self->paymask )
1539 my $error = $self->check_payinfo_cardtype;
1540 return $error if $error;
1543 return "Invoicing locale is required"
1546 && $conf->exists('cust_main-require_locale');
1548 local $SIG{HUP} = 'IGNORE';
1549 local $SIG{INT} = 'IGNORE';
1550 local $SIG{QUIT} = 'IGNORE';
1551 local $SIG{TERM} = 'IGNORE';
1552 local $SIG{TSTP} = 'IGNORE';
1553 local $SIG{PIPE} = 'IGNORE';
1555 my $oldAutoCommit = $FS::UID::AutoCommit;
1556 local $FS::UID::AutoCommit = 0;
1559 for my $l (qw(bill_location ship_location)) {
1560 my $old_loc = $old->$l;
1561 my $new_loc = $self->$l;
1563 # find the existing location if there is one
1564 $new_loc->set('custnum' => $self->custnum);
1565 my $error = $new_loc->find_or_insert;
1567 $dbh->rollback if $oldAutoCommit;
1570 $self->set($l.'num', $new_loc->locationnum);
1573 # replace the customer record
1574 my $error = $self->SUPER::replace($old);
1577 $dbh->rollback if $oldAutoCommit;
1581 # now move packages to the new service location
1582 $self->set('ship_location', ''); #flush cache
1583 if ( $old->ship_locationnum and # should only be null during upgrade...
1584 $old->ship_locationnum != $self->ship_locationnum ) {
1585 $error = $old->ship_location->move_to($self->ship_location);
1587 $dbh->rollback if $oldAutoCommit;
1591 # don't move packages based on the billing location, but
1592 # disable it if it's no longer in use
1593 if ( $old->bill_locationnum and
1594 $old->bill_locationnum != $self->bill_locationnum ) {
1595 $error = $old->bill_location->disable_if_unused;
1597 $dbh->rollback if $oldAutoCommit;
1602 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1603 my $invoicing_list = shift @param;
1604 $error = $self->check_invoicing_list( $invoicing_list );
1606 $dbh->rollback if $oldAutoCommit;
1609 $self->invoicing_list( $invoicing_list );
1612 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1614 #this could be more efficient than deleting and re-inserting, if it matters
1615 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1616 my $error = $cust_tag->delete;
1618 $dbh->rollback if $oldAutoCommit;
1622 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1623 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1624 'custnum' => $self->custnum };
1625 my $error = $cust_tag->insert;
1627 $dbh->rollback if $oldAutoCommit;
1634 my %options = @param;
1636 my $tax_exemption = delete $options{'tax_exemption'};
1637 if ( $tax_exemption ) {
1639 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1640 if ref($tax_exemption) eq 'ARRAY';
1642 my %cust_main_exemption =
1643 map { $_->taxname => $_ }
1644 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1646 foreach my $taxname ( keys %$tax_exemption ) {
1648 if ( $cust_main_exemption{$taxname} &&
1649 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1652 delete $cust_main_exemption{$taxname};
1656 my $cust_main_exemption = new FS::cust_main_exemption {
1657 'custnum' => $self->custnum,
1658 'taxname' => $taxname,
1659 'exempt_number' => $tax_exemption->{$taxname},
1661 my $error = $cust_main_exemption->insert;
1663 $dbh->rollback if $oldAutoCommit;
1664 return "inserting cust_main_exemption (transaction rolled back): $error";
1668 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1669 my $error = $cust_main_exemption->delete;
1671 $dbh->rollback if $oldAutoCommit;
1672 return "deleting cust_main_exemption (transaction rolled back): $error";
1678 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1679 && ( ( $self->get('payinfo') ne $old->get('payinfo')
1680 && $self->get('payinfo') !~ /^99\d{14}$/
1682 || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1687 # card/check/lec info has changed, want to retry realtime_ invoice events
1688 my $error = $self->retry_realtime;
1690 $dbh->rollback if $oldAutoCommit;
1695 unless ( $import || $skip_fuzzyfiles ) {
1696 $error = $self->queue_fuzzyfiles_update;
1698 $dbh->rollback if $oldAutoCommit;
1699 return "updating fuzzy search cache: $error";
1703 # tax district update in cust_location
1705 # cust_main exports!
1707 my $export_args = $options{'export_args'} || [];
1710 map qsearch( 'part_export', {exportnum=>$_} ),
1711 $conf->config('cust_main-exports'); #, $agentnum
1713 foreach my $part_export ( @part_export ) {
1714 my $error = $part_export->export_replace( $self, $old, @$export_args);
1716 $dbh->rollback if $oldAutoCommit;
1717 return "exporting to ". $part_export->exporttype.
1718 " (transaction rolled back): $error";
1722 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1727 =item queue_fuzzyfiles_update
1729 Used by insert & replace to update the fuzzy search cache
1733 use FS::cust_main::Search;
1734 sub queue_fuzzyfiles_update {
1737 local $SIG{HUP} = 'IGNORE';
1738 local $SIG{INT} = 'IGNORE';
1739 local $SIG{QUIT} = 'IGNORE';
1740 local $SIG{TERM} = 'IGNORE';
1741 local $SIG{TSTP} = 'IGNORE';
1742 local $SIG{PIPE} = 'IGNORE';
1744 my $oldAutoCommit = $FS::UID::AutoCommit;
1745 local $FS::UID::AutoCommit = 0;
1748 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1749 my $queue = new FS::queue {
1750 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1752 my @args = "cust_main.$field", $self->get($field);
1753 my $error = $queue->insert( @args );
1755 $dbh->rollback if $oldAutoCommit;
1756 return "queueing job (transaction rolled back): $error";
1760 my @locations = $self->bill_location;
1761 push @locations, $self->ship_location if $self->has_ship_address;
1762 foreach my $location (@locations) {
1763 my $queue = new FS::queue {
1764 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1766 my @args = 'cust_location.address1', $location->address1;
1767 my $error = $queue->insert( @args );
1769 $dbh->rollback if $oldAutoCommit;
1770 return "queueing job (transaction rolled back): $error";
1774 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1781 Checks all fields to make sure this is a valid customer record. If there is
1782 an error, returns the error, otherwise returns false. Called by the insert
1783 and replace methods.
1790 warn "$me check BEFORE: \n". $self->_dump
1794 $self->ut_numbern('custnum')
1795 || $self->ut_number('agentnum')
1796 || $self->ut_textn('agent_custid')
1797 || $self->ut_number('refnum')
1798 || $self->ut_foreign_key('bill_locationnum', 'cust_location','locationnum')
1799 || $self->ut_foreign_key('ship_locationnum', 'cust_location','locationnum')
1800 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1801 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1802 || $self->ut_textn('custbatch')
1803 || $self->ut_name('last')
1804 || $self->ut_name('first')
1805 || $self->ut_snumbern('signupdate')
1806 || $self->ut_snumbern('birthdate')
1807 || $self->ut_namen('spouse_last')
1808 || $self->ut_namen('spouse_first')
1809 || $self->ut_snumbern('spouse_birthdate')
1810 || $self->ut_snumbern('anniversary_date')
1811 || $self->ut_textn('company')
1812 || $self->ut_textn('ship_company')
1813 || $self->ut_anything('comments')
1814 || $self->ut_numbern('referral_custnum')
1815 || $self->ut_textn('stateid')
1816 || $self->ut_textn('stateid_state')
1817 || $self->ut_textn('invoice_terms')
1818 || $self->ut_floatn('cdr_termination_percentage')
1819 || $self->ut_floatn('credit_limit')
1820 || $self->ut_numbern('billday')
1821 || $self->ut_numbern('prorate_day')
1822 || $self->ut_flag('edit_subject')
1823 || $self->ut_flag('calling_list_exempt')
1824 || $self->ut_flag('invoice_noemail')
1825 || $self->ut_flag('message_noemail')
1826 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1827 || $self->ut_flag('invoice_ship_address')
1830 foreach (qw(company ship_company)) {
1831 my $company = $self->get($_);
1832 $company =~ s/^\s+//;
1833 $company =~ s/\s+$//;
1834 $company =~ s/\s+/ /g;
1835 $self->set($_, $company);
1838 #barf. need message catalogs. i18n. etc.
1839 $error .= "Please select an advertising source."
1840 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1841 return $error if $error;
1843 return "Unknown agent"
1844 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1846 return "Unknown refnum"
1847 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1849 return "Unknown referring custnum: ". $self->referral_custnum
1850 unless ! $self->referral_custnum
1851 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1853 if ( $self->ss eq '' ) {
1858 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1859 or return "Illegal social security number: ". $self->ss;
1860 $self->ss("$1-$2-$3");
1863 #turn off invoice_ship_address if ship & bill are the same
1864 if ($self->bill_locationnum eq $self->ship_locationnum) {
1865 $self->invoice_ship_address('');
1868 # cust_main_county verification now handled by cust_location check
1871 $self->ut_phonen('daytime', $self->country)
1872 || $self->ut_phonen('night', $self->country)
1873 || $self->ut_phonen('fax', $self->country)
1874 || $self->ut_phonen('mobile', $self->country)
1876 return $error if $error;
1878 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1880 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1883 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1885 : FS::Msgcat::_gettext('daytime');
1886 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1888 : FS::Msgcat::_gettext('night');
1890 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1892 : FS::Msgcat::_gettext('mobile');
1894 return "$daytime_label, $night_label or $mobile_label is required"
1898 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1899 # or return "Illegal payby: ". $self->payby;
1901 FS::payby->can_payby($self->table, $self->payby)
1902 or return "Illegal payby: ". $self->payby;
1904 $error = $self->ut_numbern('paystart_month')
1905 || $self->ut_numbern('paystart_year')
1906 || $self->ut_numbern('payissue')
1907 || $self->ut_textn('paytype')
1909 return $error if $error;
1911 if ( $self->payip eq '' ) {
1914 $error = $self->ut_ip('payip');
1915 return $error if $error;
1918 # If it is encrypted and the private key is not availaible then we can't
1919 # check the credit card.
1920 my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1922 # Need some kind of global flag to accept invalid cards, for testing
1924 if ( !$import && $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1926 my $payinfo = $self->payinfo;
1927 $payinfo =~ s/\D//g;
1928 $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1929 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1931 $self->payinfo($payinfo);
1933 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1935 return gettext('unknown_card_type')
1936 if $self->payinfo !~ /^99\d{14}$/ #token
1937 && cardtype($self->payinfo) eq "Unknown";
1939 unless ( $ignore_banned_card ) {
1940 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1942 if ( $ban->bantype eq 'warn' ) {
1943 #or others depending on value of $ban->reason ?
1944 return '_duplicate_card'.
1945 ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1946 ' until '. time2str('%a %h %o at %r', $ban->_end_date).
1947 ' (ban# '. $ban->bannum. ')'
1948 unless $self->override_ban_warn;
1950 return 'Banned credit card: banned on '.
1951 time2str('%a %h %o at %r', $ban->_date).
1952 ' by '. $ban->otaker.
1953 ' (ban# '. $ban->bannum. ')';
1958 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1959 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1960 $self->paycvv =~ /^(\d{4})$/
1961 or return "CVV2 (CID) for American Express cards is four digits.";
1964 $self->paycvv =~ /^(\d{3})$/
1965 or return "CVV2 (CVC2/CID) is three digits.";
1972 my $cardtype = cardtype($payinfo);
1973 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1975 return "Start date or issue number is required for $cardtype cards"
1976 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1978 return "Start month must be between 1 and 12"
1979 if $self->paystart_month
1980 and $self->paystart_month < 1 || $self->paystart_month > 12;
1982 return "Start year must be 1990 or later"
1983 if $self->paystart_year
1984 and $self->paystart_year < 1990;
1986 return "Issue number must be beween 1 and 99"
1988 and $self->payissue < 1 || $self->payissue > 99;
1991 $self->paystart_month('');
1992 $self->paystart_year('');
1993 $self->payissue('');
1996 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1998 my $payinfo = $self->payinfo;
1999 $payinfo =~ s/[^\d\@\.]//g;
2000 if ( $conf->config('echeck-country') eq 'CA' ) {
2001 $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
2002 or return 'invalid echeck account@branch.bank';
2003 $payinfo = "$1\@$2.$3";
2004 } elsif ( $conf->config('echeck-country') eq 'US' ) {
2005 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2006 $payinfo = "$1\@$2";
2008 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
2009 $payinfo = "$1\@$2";
2011 $self->payinfo($payinfo);
2014 unless ( $ignore_banned_card ) {
2015 my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2017 if ( $ban->bantype eq 'warn' ) {
2018 #or others depending on value of $ban->reason ?
2019 return '_duplicate_ach' unless $self->override_ban_warn;
2021 return 'Banned ACH account: banned on '.
2022 time2str('%a %h %o at %r', $ban->_date).
2023 ' by '. $ban->otaker.
2024 ' (ban# '. $ban->bannum. ')';
2029 } elsif ( $self->payby eq 'LECB' ) {
2031 my $payinfo = $self->payinfo;
2032 $payinfo =~ s/\D//g;
2033 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2035 $self->payinfo($payinfo);
2038 } elsif ( $self->payby eq 'BILL' ) {
2040 $error = $self->ut_textn('payinfo');
2041 return "Illegal P.O. number: ". $self->payinfo if $error;
2044 } elsif ( $self->payby eq 'COMP' ) {
2046 my $curuser = $FS::CurrentUser::CurrentUser;
2047 if ( ! $self->custnum
2048 && ! $curuser->access_right('Complimentary customer')
2051 return "You are not permitted to create complimentary accounts."
2054 $error = $self->ut_textn('payinfo');
2055 return "Illegal comp account issuer: ". $self->payinfo if $error;
2058 } elsif ( $self->payby eq 'PREPAY' ) {
2060 my $payinfo = $self->payinfo;
2061 $payinfo =~ s/\W//g; #anything else would just confuse things
2062 $self->payinfo($payinfo);
2063 $error = $self->ut_alpha('payinfo');
2064 return "Illegal prepayment identifier: ". $self->payinfo if $error;
2065 return "Unknown prepayment identifier"
2066 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2071 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2072 return "Expiration date required"
2073 # shouldn't payinfo_check do this?
2074 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2078 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2079 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2080 } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2081 ( $m, $y ) = ( $2, "19$1" );
2082 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2083 ( $m, $y ) = ( $3, "20$2" );
2085 return "Illegal expiration date: ". $self->paydate;
2087 $m = sprintf('%02d',$m);
2088 $self->paydate("$y-$m-01");
2089 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2090 return gettext('expired_card')
2092 && !$ignore_expired_card
2093 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2096 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2097 ( ! $conf->exists('require_cardname')
2098 || $self->payby !~ /^(CARD|DCRD)$/ )
2100 $self->payname( $self->first. " ". $self->getfield('last') );
2103 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2104 $self->payname =~ /^([\w \,\.\-\']*)$/
2105 or return gettext('illegal_name'). " payname: ". $self->payname;
2108 $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2109 or return gettext('illegal_name'). " payname: ". $self->payname;
2115 return "Please select an invoicing locale"
2118 && $conf->exists('cust_main-require_locale');
2120 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2121 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2125 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2127 warn "$me check AFTER: \n". $self->_dump
2130 $self->SUPER::check;
2133 sub check_payinfo_cardtype {
2136 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2138 my $payinfo = $self->payinfo;
2139 $payinfo =~ s/\D//g;
2141 return '' if $payinfo =~ /^99\d{14}$/; #token
2143 my %bop_card_types = map { $_=>1 } values %{ card_types() };
2144 my $cardtype = cardtype($payinfo);
2146 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2154 Additional checks for replace only.
2159 my ($new,$old) = @_;
2160 #preserve old value if global config is set
2161 if ($old && $conf->exists('invoice-ship_address')) {
2162 $new->invoice_ship_address($old->invoice_ship_address);
2169 Returns a list of fields which have ship_ duplicates.
2174 qw( last first company
2176 address1 address2 city county state zip country
2178 daytime night fax mobile
2182 =item has_ship_address
2184 Returns true if this customer record has a separate shipping address.
2188 sub has_ship_address {
2190 $self->bill_locationnum != $self->ship_locationnum;
2195 Returns a list of key/value pairs, with the following keys: address1,
2196 adddress2, city, county, state, zip, country, district, and geocode. The
2197 shipping address is used if present.
2203 $self->ship_location->location_hash;
2208 Returns all locations (see L<FS::cust_location>) for this customer.
2214 qsearch('cust_location', { 'custnum' => $self->custnum,
2215 'prospectnum' => '' } );
2220 Returns all contacts (see L<FS::contact>) for this customer.
2224 #already used :/ sub contact {
2227 qsearch('contact', { 'custnum' => $self->custnum } );
2232 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2233 and L<FS::cust_pkg>) for this customer, except those on hold.
2235 Returns a list: an empty list on success or a list of errors.
2241 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2246 Unsuspends all suspended packages in the on-hold state (those without setup
2247 dates) for this customer.
2253 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2258 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2260 Returns a list: an empty list on success or a list of errors.
2266 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2269 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2271 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2272 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2273 of a list of pkgparts; the hashref has the following keys:
2277 =item pkgparts - listref of pkgparts
2279 =item (other options are passed to the suspend method)
2284 Returns a list: an empty list on success or a list of errors.
2288 sub suspend_if_pkgpart {
2290 my (@pkgparts, %opt);
2291 if (ref($_[0]) eq 'HASH'){
2292 @pkgparts = @{$_[0]{pkgparts}};
2297 grep { $_->suspend(%opt) }
2298 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2299 $self->unsuspended_pkgs;
2302 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2304 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2305 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2306 instead of a list of pkgparts; the hashref has the following keys:
2310 =item pkgparts - listref of pkgparts
2312 =item (other options are passed to the suspend method)
2316 Returns a list: an empty list on success or a list of errors.
2320 sub suspend_unless_pkgpart {
2322 my (@pkgparts, %opt);
2323 if (ref($_[0]) eq 'HASH'){
2324 @pkgparts = @{$_[0]{pkgparts}};
2329 grep { $_->suspend(%opt) }
2330 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2331 $self->unsuspended_pkgs;
2334 =item cancel [ OPTION => VALUE ... ]
2336 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2338 Available options are:
2342 =item quiet - can be set true to supress email cancellation notices.
2344 =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.
2346 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2348 =item nobill - can be set true to skip billing if it might otherwise be done.
2352 Always returns a list: an empty list on success or a list of errors.
2356 # nb that dates are not specified as valid options to this method
2359 my( $self, %opt ) = @_;
2361 warn "$me cancel called on customer ". $self->custnum. " with options ".
2362 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2365 return ( 'access denied' )
2366 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2368 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2370 #should try decryption (we might have the private key)
2371 # and if not maybe queue a job for the server that does?
2372 return ( "Can't (yet) ban encrypted credit cards" )
2373 if $self->is_encrypted($self->payinfo);
2375 my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2376 my $error = $ban->insert;
2377 return ( $error ) if $error;
2381 my @pkgs = $self->ncancelled_pkgs;
2383 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2385 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2386 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2390 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2391 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2394 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2397 sub _banned_pay_hashref {
2408 'payby' => $payby2ban{$self->payby},
2409 'payinfo' => $self->payinfo,
2410 #don't ever *search* on reason! #'reason' =>
2414 sub _new_banned_pay_hashref {
2416 my $hr = $self->_banned_pay_hashref;
2417 $hr->{payinfo} = md5_base64($hr->{payinfo});
2423 Returns all notes (see L<FS::cust_main_note>) for this customer.
2428 my($self,$orderby_classnum) = (shift,shift);
2429 my $orderby = "sticky DESC, _date DESC";
2430 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2431 qsearch( 'cust_main_note',
2432 { 'custnum' => $self->custnum },
2434 "ORDER BY $orderby",
2440 Returns the agent (see L<FS::agent>) for this customer.
2446 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2451 Returns the agent name (see L<FS::agent>) for this customer.
2457 $self->agent->agent;
2462 Returns any tags associated with this customer, as FS::cust_tag objects,
2463 or an empty list if there are no tags.
2469 qsearch('cust_tag', { 'custnum' => $self->custnum } );
2474 Returns any tags associated with this customer, as FS::part_tag objects,
2475 or an empty list if there are no tags.
2481 map $_->part_tag, $self->cust_tag;
2487 Returns the customer class, as an FS::cust_class object, or the empty string
2488 if there is no customer class.
2494 if ( $self->classnum ) {
2495 qsearchs('cust_class', { 'classnum' => $self->classnum } );
2503 Returns the customer category name, or the empty string if there is no customer
2510 my $cust_class = $self->cust_class;
2512 ? $cust_class->categoryname
2518 Returns the customer class name, or the empty string if there is no customer
2525 my $cust_class = $self->cust_class;
2527 ? $cust_class->classname
2531 =item BILLING METHODS
2533 Documentation on billing methods has been moved to
2534 L<FS::cust_main::Billing>.
2536 =item REALTIME BILLING METHODS
2538 Documentation on realtime billing methods has been moved to
2539 L<FS::cust_main::Billing_Realtime>.
2543 Removes the I<paycvv> field from the database directly.
2545 If there is an error, returns the error, otherwise returns false.
2551 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2552 or return dbh->errstr;
2553 $sth->execute($self->custnum)
2554 or return $sth->errstr;
2559 =item batch_card OPTION => VALUE...
2561 Adds a payment for this invoice to the pending credit card batch (see
2562 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2563 runs the payment using a realtime gateway.
2565 Options may include:
2567 B<amount>: the amount to be paid; defaults to the customer's balance minus
2568 any payments in transit.
2570 B<payby>: the payment method; defaults to cust_main.payby
2572 B<realtime>: runs this as a realtime payment instead of adding it to a
2575 B<invnum>: sets cust_pay_batch.invnum.
2577 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2578 the billing address for the payment; defaults to the customer's billing
2581 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2582 date, and name; defaults to those fields in cust_main.
2587 my ($self, %options) = @_;
2590 if (exists($options{amount})) {
2591 $amount = $options{amount};
2593 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2596 warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
2598 $self->in_transit_payments
2603 my $invnum = delete $options{invnum};
2604 my $payby = $options{payby} || $self->payby; #still dubious
2606 if ($options{'realtime'}) {
2607 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2613 my $oldAutoCommit = $FS::UID::AutoCommit;
2614 local $FS::UID::AutoCommit = 0;
2617 #this needs to handle mysql as well as Pg, like svc_acct.pm
2618 #(make it into a common function if folks need to do batching with mysql)
2619 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2620 or return "Cannot lock pay_batch: " . $dbh->errstr;
2624 'payby' => FS::payby->payby2payment($payby),
2626 $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2628 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2630 unless ( $pay_batch ) {
2631 $pay_batch = new FS::pay_batch \%pay_batch;
2632 my $error = $pay_batch->insert;
2634 $dbh->rollback if $oldAutoCommit;
2635 die "error creating new batch: $error\n";
2639 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2640 'batchnum' => $pay_batch->batchnum,
2641 'custnum' => $self->custnum,
2644 foreach (qw( address1 address2 city state zip country latitude longitude
2645 payby payinfo paydate payname ))
2647 $options{$_} = '' unless exists($options{$_});
2650 my $loc = $self->bill_location;
2652 my $cust_pay_batch = new FS::cust_pay_batch ( {
2653 'batchnum' => $pay_batch->batchnum,
2654 'invnum' => $invnum || 0, # is there a better value?
2655 # this field should be
2657 # cust_bill_pay_batch now
2658 'custnum' => $self->custnum,
2659 'last' => $self->getfield('last'),
2660 'first' => $self->getfield('first'),
2661 'address1' => $options{address1} || $loc->address1,
2662 'address2' => $options{address2} || $loc->address2,
2663 'city' => $options{city} || $loc->city,
2664 'state' => $options{state} || $loc->state,
2665 'zip' => $options{zip} || $loc->zip,
2666 'country' => $options{country} || $loc->country,
2667 'payby' => $options{payby} || $self->payby,
2668 'payinfo' => $options{payinfo} || $self->payinfo,
2669 'exp' => $options{paydate} || $self->paydate,
2670 'payname' => $options{payname} || $self->payname,
2671 'amount' => $amount, # consolidating
2674 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2675 if $old_cust_pay_batch;
2678 if ($old_cust_pay_batch) {
2679 $error = $cust_pay_batch->replace($old_cust_pay_batch)
2681 $error = $cust_pay_batch->insert;
2685 $dbh->rollback if $oldAutoCommit;
2689 my $unapplied = $self->total_unapplied_credits
2690 + $self->total_unapplied_payments
2691 + $self->in_transit_payments;
2692 foreach my $cust_bill ($self->open_cust_bill) {
2693 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2694 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2695 'invnum' => $cust_bill->invnum,
2696 'paybatchnum' => $cust_pay_batch->paybatchnum,
2697 'amount' => $cust_bill->owed,
2700 if ($unapplied >= $cust_bill_pay_batch->amount){
2701 $unapplied -= $cust_bill_pay_batch->amount;
2704 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2705 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
2707 $error = $cust_bill_pay_batch->insert;
2709 $dbh->rollback if $oldAutoCommit;
2714 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2720 Returns the total owed for this customer on all invoices
2721 (see L<FS::cust_bill/owed>).
2727 $self->total_owed_date(2145859200); #12/31/2037
2730 =item total_owed_date TIME
2732 Returns the total owed for this customer on all invoices with date earlier than
2733 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2734 see L<Time::Local> and L<Date::Parse> for conversion functions.
2738 sub total_owed_date {
2742 my $custnum = $self->custnum;
2744 my $owed_sql = FS::cust_bill->owed_sql;
2747 SELECT SUM($owed_sql) FROM cust_bill
2748 WHERE custnum = $custnum
2752 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2756 =item total_owed_pkgnum PKGNUM
2758 Returns the total owed on all invoices for this customer's specific package
2759 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2763 sub total_owed_pkgnum {
2764 my( $self, $pkgnum ) = @_;
2765 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2768 =item total_owed_date_pkgnum TIME PKGNUM
2770 Returns the total owed for this customer's specific package when using
2771 experimental package balances on all invoices with date earlier than
2772 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2773 see L<Time::Local> and L<Date::Parse> for conversion functions.
2777 sub total_owed_date_pkgnum {
2778 my( $self, $time, $pkgnum ) = @_;
2781 foreach my $cust_bill (
2782 grep { $_->_date <= $time }
2783 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2785 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2787 sprintf( "%.2f", $total_bill );
2793 Returns the total amount of all payments.
2800 $total += $_->paid foreach $self->cust_pay;
2801 sprintf( "%.2f", $total );
2804 =item total_unapplied_credits
2806 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2807 customer. See L<FS::cust_credit/credited>.
2809 =item total_credited
2811 Old name for total_unapplied_credits. Don't use.
2815 sub total_credited {
2816 #carp "total_credited deprecated, use total_unapplied_credits";
2817 shift->total_unapplied_credits(@_);
2820 sub total_unapplied_credits {
2823 my $custnum = $self->custnum;
2825 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2828 SELECT SUM($unapplied_sql) FROM cust_credit
2829 WHERE custnum = $custnum
2832 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2836 =item total_unapplied_credits_pkgnum PKGNUM
2838 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2839 customer. See L<FS::cust_credit/credited>.
2843 sub total_unapplied_credits_pkgnum {
2844 my( $self, $pkgnum ) = @_;
2845 my $total_credit = 0;
2846 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2847 sprintf( "%.2f", $total_credit );
2851 =item total_unapplied_payments
2853 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2854 See L<FS::cust_pay/unapplied>.
2858 sub total_unapplied_payments {
2861 my $custnum = $self->custnum;
2863 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2866 SELECT SUM($unapplied_sql) FROM cust_pay
2867 WHERE custnum = $custnum
2870 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2874 =item total_unapplied_payments_pkgnum PKGNUM
2876 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2877 specific package when using experimental package balances. See
2878 L<FS::cust_pay/unapplied>.
2882 sub total_unapplied_payments_pkgnum {
2883 my( $self, $pkgnum ) = @_;
2884 my $total_unapplied = 0;
2885 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2886 sprintf( "%.2f", $total_unapplied );
2890 =item total_unapplied_refunds
2892 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2893 customer. See L<FS::cust_refund/unapplied>.
2897 sub total_unapplied_refunds {
2899 my $custnum = $self->custnum;
2901 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2904 SELECT SUM($unapplied_sql) FROM cust_refund
2905 WHERE custnum = $custnum
2908 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2914 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2915 total_unapplied_credits minus total_unapplied_payments).
2921 $self->balance_date_range;
2924 =item balance_date TIME
2926 Returns the balance for this customer, only considering invoices with date
2927 earlier than TIME (total_owed_date minus total_credited minus
2928 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2929 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2936 $self->balance_date_range(shift);
2939 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2941 Returns the balance for this customer, optionally considering invoices with
2942 date earlier than START_TIME, and not later than END_TIME
2943 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2945 Times are specified as SQL fragments or numeric
2946 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2947 L<Date::Parse> for conversion functions. The empty string can be passed
2948 to disable that time constraint completely.
2950 Accepts the same options as L<balance_date_sql>:
2954 =item unapplied_date
2956 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)
2960 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2961 time will be ignored. Note that START_TIME and END_TIME only limit the date
2962 range for invoices and I<unapplied> payments, credits, and refunds.
2968 sub balance_date_range {
2970 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2971 ') FROM cust_main WHERE custnum='. $self->custnum;
2972 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2975 =item balance_pkgnum PKGNUM
2977 Returns the balance for this customer's specific package when using
2978 experimental package balances (total_owed plus total_unrefunded, minus
2979 total_unapplied_credits minus total_unapplied_payments)
2983 sub balance_pkgnum {
2984 my( $self, $pkgnum ) = @_;
2987 $self->total_owed_pkgnum($pkgnum)
2988 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2989 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2990 - $self->total_unapplied_credits_pkgnum($pkgnum)
2991 - $self->total_unapplied_payments_pkgnum($pkgnum)
2995 =item in_transit_payments
2997 Returns the total of requests for payments for this customer pending in
2998 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
3002 sub in_transit_payments {
3004 my $in_transit_payments = 0;
3005 foreach my $pay_batch ( qsearch('pay_batch', {
3008 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3009 'batchnum' => $pay_batch->batchnum,
3010 'custnum' => $self->custnum,
3013 $in_transit_payments += $cust_pay_batch->amount;
3016 sprintf( "%.2f", $in_transit_payments );
3021 Returns a hash of useful information for making a payment.
3031 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3032 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3033 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3037 For credit card transactions:
3049 For electronic check transactions:
3064 $return{balance} = $self->balance;
3066 $return{payname} = $self->payname
3067 || ( $self->first. ' '. $self->get('last') );
3069 $return{$_} = $self->bill_location->$_
3070 for qw(address1 address2 city state zip);
3072 $return{payby} = $self->payby;
3073 $return{stateid_state} = $self->stateid_state;
3075 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3076 $return{card_type} = cardtype($self->payinfo);
3077 $return{payinfo} = $self->paymask;
3079 @return{'month', 'year'} = $self->paydate_monthyear;
3083 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3084 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3085 $return{payinfo1} = $payinfo1;
3086 $return{payinfo2} = $payinfo2;
3087 $return{paytype} = $self->paytype;
3088 $return{paystate} = $self->paystate;
3092 #doubleclick protection
3094 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3100 =item paydate_monthyear
3102 Returns a two-element list consisting of the month and year of this customer's
3103 paydate (credit card expiration date for CARD customers)
3107 sub paydate_monthyear {
3109 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3111 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3120 Returns the exact time in seconds corresponding to the payment method
3121 expiration date. For CARD/DCRD customers this is the end of the month;
3122 for others (COMP is the only other payby that uses paydate) it's the start.
3123 Returns 0 if the paydate is empty or set to the far future.
3129 my ($month, $year) = $self->paydate_monthyear;
3130 return 0 if !$year or $year >= 2037;
3131 if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3133 if ( $month == 13 ) {
3137 return timelocal(0,0,0,1,$month-1,$year) - 1;
3140 return timelocal(0,0,0,1,$month-1,$year);
3144 =item paydate_epoch_sql
3146 Class method. Returns an SQL expression to obtain the payment expiration date
3147 as a number of seconds.
3151 # Special expiration date behavior for non-CARD/DCRD customers has been
3152 # carefully preserved. Do we really use that?
3153 sub paydate_epoch_sql {
3155 my $table = shift || 'cust_main';
3156 my ($case1, $case2);
3157 if ( driver_name eq 'Pg' ) {
3158 $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3159 $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3161 elsif ( lc(driver_name) eq 'mysql' ) {
3162 $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3163 $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3166 return "CASE WHEN $table.payby IN('CARD','DCRD')
3172 =item tax_exemption TAXNAME
3177 my( $self, $taxname ) = @_;
3179 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3180 'taxname' => $taxname,
3185 =item cust_main_exemption
3189 sub cust_main_exemption {
3191 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3194 =item invoicing_list [ ARRAYREF ]
3196 If an arguement is given, sets these email addresses as invoice recipients
3197 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3198 (except as warnings), so use check_invoicing_list first.
3200 Returns a list of email addresses (with svcnum entries expanded).
3202 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3203 check it without disturbing anything by passing nothing.
3205 This interface may change in the future.
3209 sub invoicing_list {
3210 my( $self, $arrayref ) = @_;
3213 my @cust_main_invoice;
3214 if ( $self->custnum ) {
3215 @cust_main_invoice =
3216 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3218 @cust_main_invoice = ();
3220 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3221 #warn $cust_main_invoice->destnum;
3222 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3223 #warn $cust_main_invoice->destnum;
3224 my $error = $cust_main_invoice->delete;
3225 warn $error if $error;
3228 if ( $self->custnum ) {
3229 @cust_main_invoice =
3230 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3232 @cust_main_invoice = ();
3234 my %seen = map { $_->address => 1 } @cust_main_invoice;
3235 foreach my $address ( @{$arrayref} ) {
3236 next if exists $seen{$address} && $seen{$address};
3237 $seen{$address} = 1;
3238 my $cust_main_invoice = new FS::cust_main_invoice ( {
3239 'custnum' => $self->custnum,
3242 my $error = $cust_main_invoice->insert;
3243 warn $error if $error;
3247 if ( $self->custnum ) {
3249 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3256 =item check_invoicing_list ARRAYREF
3258 Checks these arguements as valid input for the invoicing_list method. If there
3259 is an error, returns the error, otherwise returns false.
3263 sub check_invoicing_list {
3264 my( $self, $arrayref ) = @_;
3266 foreach my $address ( @$arrayref ) {
3268 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3269 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3272 my $cust_main_invoice = new FS::cust_main_invoice ( {
3273 'custnum' => $self->custnum,
3276 my $error = $self->custnum
3277 ? $cust_main_invoice->check
3278 : $cust_main_invoice->checkdest
3280 return $error if $error;
3284 return "Email address required"
3285 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3286 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3291 =item set_default_invoicing_list
3293 Sets the invoicing list to all accounts associated with this customer,
3294 overwriting any previous invoicing list.
3298 sub set_default_invoicing_list {
3300 $self->invoicing_list($self->all_emails);
3305 Returns the email addresses of all accounts provisioned for this customer.
3312 foreach my $cust_pkg ( $self->all_pkgs ) {
3313 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3315 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3316 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3318 $list{$_}=1 foreach map { $_->email } @svc_acct;
3323 =item invoicing_list_addpost
3325 Adds postal invoicing to this customer. If this customer is already configured
3326 to receive postal invoices, does nothing.
3330 sub invoicing_list_addpost {
3332 return if grep { $_ eq 'POST' } $self->invoicing_list;
3333 my @invoicing_list = $self->invoicing_list;
3334 push @invoicing_list, 'POST';
3335 $self->invoicing_list(\@invoicing_list);
3338 =item invoicing_list_emailonly
3340 Returns the list of email invoice recipients (invoicing_list without non-email
3341 destinations such as POST and FAX).
3345 sub invoicing_list_emailonly {
3347 warn "$me invoicing_list_emailonly called"
3349 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3352 =item invoicing_list_emailonly_scalar
3354 Returns the list of email invoice recipients (invoicing_list without non-email
3355 destinations such as POST and FAX) as a comma-separated scalar.
3359 sub invoicing_list_emailonly_scalar {
3361 warn "$me invoicing_list_emailonly_scalar called"
3363 join(', ', $self->invoicing_list_emailonly);
3366 =item referral_custnum_cust_main
3368 Returns the customer who referred this customer (or the empty string, if
3369 this customer was not referred).
3371 Note the difference with referral_cust_main method: This method,
3372 referral_custnum_cust_main returns the single customer (if any) who referred
3373 this customer, while referral_cust_main returns an array of customers referred
3378 sub referral_custnum_cust_main {
3380 return '' unless $self->referral_custnum;
3381 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3384 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3386 Returns an array of customers referred by this customer (referral_custnum set
3387 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3388 customers referred by customers referred by this customer and so on, inclusive.
3389 The default behavior is DEPTH 1 (no recursion).
3391 Note the difference with referral_custnum_cust_main method: This method,
3392 referral_cust_main, returns an array of customers referred BY this customer,
3393 while referral_custnum_cust_main returns the single customer (if any) who
3394 referred this customer.
3398 sub referral_cust_main {
3400 my $depth = @_ ? shift : 1;
3401 my $exclude = @_ ? shift : {};
3404 map { $exclude->{$_->custnum}++; $_; }
3405 grep { ! $exclude->{ $_->custnum } }
3406 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3410 map { $_->referral_cust_main($depth-1, $exclude) }
3417 =item referral_cust_main_ncancelled
3419 Same as referral_cust_main, except only returns customers with uncancelled
3424 sub referral_cust_main_ncancelled {
3426 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3429 =item referral_cust_pkg [ DEPTH ]
3431 Like referral_cust_main, except returns a flat list of all unsuspended (and
3432 uncancelled) packages for each customer. The number of items in this list may
3433 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3437 sub referral_cust_pkg {
3439 my $depth = @_ ? shift : 1;
3441 map { $_->unsuspended_pkgs }
3442 grep { $_->unsuspended_pkgs }
3443 $self->referral_cust_main($depth);
3446 =item referring_cust_main
3448 Returns the single cust_main record for the customer who referred this customer
3449 (referral_custnum), or false.
3453 sub referring_cust_main {
3455 return '' unless $self->referral_custnum;
3456 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3459 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3461 Applies a credit to this customer. If there is an error, returns the error,
3462 otherwise returns false.
3464 REASON can be a text string, an FS::reason object, or a scalar reference to
3465 a reasonnum. If a text string, it will be automatically inserted as a new
3466 reason, and a 'reason_type' option must be passed to indicate the
3467 FS::reason_type for the new reason.
3469 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3470 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3471 I<commission_pkgnum>.
3473 Any other options are passed to FS::cust_credit::insert.
3478 my( $self, $amount, $reason, %options ) = @_;
3480 my $cust_credit = new FS::cust_credit {
3481 'custnum' => $self->custnum,
3482 'amount' => $amount,
3485 if ( ref($reason) ) {
3487 if ( ref($reason) eq 'SCALAR' ) {
3488 $cust_credit->reasonnum( $$reason );
3490 $cust_credit->reasonnum( $reason->reasonnum );
3494 $cust_credit->set('reason', $reason)
3497 $cust_credit->$_( delete $options{$_} )
3498 foreach grep exists($options{$_}),
3499 qw( addlinfo eventnum ),
3500 map "commission_$_", qw( agentnum salesnum pkgnum );
3502 $cust_credit->insert(%options);
3506 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3508 Creates a one-time charge for this customer. If there is an error, returns
3509 the error, otherwise returns false.
3511 New-style, with a hashref of options:
3513 my $error = $cust_main->charge(
3517 'start_date' => str2time('7/4/2009'),
3518 'pkg' => 'Description',
3519 'comment' => 'Comment',
3520 'additional' => [], #extra invoice detail
3521 'classnum' => 1, #pkg_class
3523 'setuptax' => '', # or 'Y' for tax exempt
3525 'locationnum'=> 1234, # optional
3528 'taxclass' => 'Tax class',
3531 'taxproduct' => 2, #part_pkg_taxproduct
3532 'override' => {}, #XXX describe
3534 #will be filled in with the new object
3535 'cust_pkg_ref' => \$cust_pkg,
3537 #generate an invoice immediately
3539 'invoice_terms' => '', #with these terms
3545 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3549 #super false laziness w/quotation::charge
3552 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3553 my ( $pkg, $comment, $additional );
3554 my ( $setuptax, $taxclass ); #internal taxes
3555 my ( $taxproduct, $override ); #vendor (CCH) taxes
3557 my $separate_bill = '';
3558 my $cust_pkg_ref = '';
3559 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3561 if ( ref( $_[0] ) ) {
3562 $amount = $_[0]->{amount};
3563 $setup_cost = $_[0]->{setup_cost};
3564 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3565 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3566 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3567 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3568 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3569 : '$'. sprintf("%.2f",$amount);
3570 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3571 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3572 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3573 $additional = $_[0]->{additional} || [];
3574 $taxproduct = $_[0]->{taxproductnum};
3575 $override = { '' => $_[0]->{tax_override} };
3576 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3577 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3578 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3579 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3580 $separate_bill = $_[0]->{separate_bill} || '';
3586 $pkg = @_ ? shift : 'One-time charge';
3587 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3589 $taxclass = @_ ? shift : '';
3593 local $SIG{HUP} = 'IGNORE';
3594 local $SIG{INT} = 'IGNORE';
3595 local $SIG{QUIT} = 'IGNORE';
3596 local $SIG{TERM} = 'IGNORE';
3597 local $SIG{TSTP} = 'IGNORE';
3598 local $SIG{PIPE} = 'IGNORE';
3600 my $oldAutoCommit = $FS::UID::AutoCommit;
3601 local $FS::UID::AutoCommit = 0;
3604 my $part_pkg = new FS::part_pkg ( {
3606 'comment' => $comment,
3610 'classnum' => ( $classnum ? $classnum : '' ),
3611 'setuptax' => $setuptax,
3612 'taxclass' => $taxclass,
3613 'taxproductnum' => $taxproduct,
3614 'setup_cost' => $setup_cost,
3617 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3618 ( 0 .. @$additional - 1 )
3620 'additional_count' => scalar(@$additional),
3621 'setup_fee' => $amount,
3624 my $error = $part_pkg->insert( options => \%options,
3625 tax_overrides => $override,
3628 $dbh->rollback if $oldAutoCommit;
3632 my $pkgpart = $part_pkg->pkgpart;
3633 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3634 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3635 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3636 $error = $type_pkgs->insert;
3638 $dbh->rollback if $oldAutoCommit;
3643 my $cust_pkg = new FS::cust_pkg ( {
3644 'custnum' => $self->custnum,
3645 'pkgpart' => $pkgpart,
3646 'quantity' => $quantity,
3647 'start_date' => $start_date,
3648 'no_auto' => $no_auto,
3649 'separate_bill' => $separate_bill,
3650 'locationnum'=> $locationnum,
3653 $error = $cust_pkg->insert;
3655 $dbh->rollback if $oldAutoCommit;
3657 } elsif ( $cust_pkg_ref ) {
3658 ${$cust_pkg_ref} = $cust_pkg;
3662 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3663 'pkg_list' => [ $cust_pkg ],
3666 $dbh->rollback if $oldAutoCommit;
3671 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3676 #=item charge_postal_fee
3678 #Applies a one time charge this customer. If there is an error,
3679 #returns the error, returns the cust_pkg charge object or false
3680 #if there was no charge.
3684 # This should be a customer event. For that to work requires that bill
3685 # also be a customer event.
3687 sub charge_postal_fee {
3690 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3691 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3693 my $cust_pkg = new FS::cust_pkg ( {
3694 'custnum' => $self->custnum,
3695 'pkgpart' => $pkgpart,
3699 my $error = $cust_pkg->insert;
3700 $error ? $error : $cust_pkg;
3703 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3705 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3707 Optionally, a list or hashref of additional arguments to the qsearch call can
3714 my $opt = ref($_[0]) ? shift : { @_ };
3716 #return $self->num_cust_bill unless wantarray || keys %$opt;
3718 $opt->{'table'} = 'cust_bill';
3719 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3720 $opt->{'hashref'}{'custnum'} = $self->custnum;
3721 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3723 map { $_ } #behavior of sort undefined in scalar context
3724 sort { $a->_date <=> $b->_date }
3728 =item open_cust_bill
3730 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3735 sub open_cust_bill {
3739 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3745 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3747 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3751 sub legacy_cust_bill {
3754 #return $self->num_legacy_cust_bill unless wantarray;
3756 map { $_ } #behavior of sort undefined in scalar context
3757 sort { $a->_date <=> $b->_date }
3758 qsearch({ 'table' => 'legacy_cust_bill',
3759 'hashref' => { 'custnum' => $self->custnum, },
3760 'order_by' => 'ORDER BY _date ASC',
3764 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3766 Returns all the statements (see L<FS::cust_statement>) for this customer.
3768 Optionally, a list or hashref of additional arguments to the qsearch call can
3773 =item cust_bill_void
3775 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3779 sub cust_bill_void {
3782 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3783 sort { $a->_date <=> $b->_date }
3784 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3787 sub cust_statement {
3789 my $opt = ref($_[0]) ? shift : { @_ };
3791 #return $self->num_cust_statement unless wantarray || keys %$opt;
3793 $opt->{'table'} = 'cust_statement';
3794 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3795 $opt->{'hashref'}{'custnum'} = $self->custnum;
3796 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3798 map { $_ } #behavior of sort undefined in scalar context
3799 sort { $a->_date <=> $b->_date }
3803 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3805 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3807 Optionally, a list or hashref of additional arguments to the qsearch call can
3808 be passed following the SVCDB.
3815 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3816 warn "$me svc_x requires a svcdb";
3819 my $opt = ref($_[0]) ? shift : { @_ };
3821 $opt->{'table'} = $svcdb;
3822 $opt->{'addl_from'} =
3823 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3824 ($opt->{'addl_from'} || '');
3826 my $custnum = $self->custnum;
3827 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3828 my $where = "cust_pkg.custnum = $custnum";
3830 my $extra_sql = $opt->{'extra_sql'} || '';
3831 if ( keys %{ $opt->{'hashref'} } ) {
3832 $extra_sql = " AND $where $extra_sql";
3835 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3836 $extra_sql = "WHERE $where AND $1";
3839 $extra_sql = "WHERE $where $extra_sql";
3842 $opt->{'extra_sql'} = $extra_sql;
3847 # required for use as an eventtable;
3850 $self->svc_x('svc_acct', @_);
3855 Returns all the credits (see L<FS::cust_credit>) for this customer.
3861 map { $_ } #return $self->num_cust_credit unless wantarray;
3862 sort { $a->_date <=> $b->_date }
3863 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3866 =item cust_credit_pkgnum
3868 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3869 package when using experimental package balances.
3873 sub cust_credit_pkgnum {
3874 my( $self, $pkgnum ) = @_;
3875 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3876 sort { $a->_date <=> $b->_date }
3877 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3878 'pkgnum' => $pkgnum,
3883 =item cust_credit_void
3885 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3889 sub cust_credit_void {
3892 sort { $a->_date <=> $b->_date }
3893 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3898 Returns all the payments (see L<FS::cust_pay>) for this customer.
3904 my $opt = ref($_[0]) ? shift : { @_ };
3906 return $self->num_cust_pay unless wantarray || keys %$opt;
3908 $opt->{'table'} = 'cust_pay';
3909 $opt->{'hashref'}{'custnum'} = $self->custnum;
3911 map { $_ } #behavior of sort undefined in scalar context
3912 sort { $a->_date <=> $b->_date }
3919 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3920 called automatically when the cust_pay method is used in a scalar context.
3926 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3927 my $sth = dbh->prepare($sql) or die dbh->errstr;
3928 $sth->execute($self->custnum) or die $sth->errstr;
3929 $sth->fetchrow_arrayref->[0];
3932 =item unapplied_cust_pay
3934 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3938 sub unapplied_cust_pay {
3942 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3948 =item cust_pay_pkgnum
3950 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3951 package when using experimental package balances.
3955 sub cust_pay_pkgnum {
3956 my( $self, $pkgnum ) = @_;
3957 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3958 sort { $a->_date <=> $b->_date }
3959 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3960 'pkgnum' => $pkgnum,
3967 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3973 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3974 sort { $a->_date <=> $b->_date }
3975 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3978 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3980 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3982 Optionally, a list or hashref of additional arguments to the qsearch call can
3987 sub cust_pay_batch {
3989 my $opt = ref($_[0]) ? shift : { @_ };
3991 #return $self->num_cust_statement unless wantarray || keys %$opt;
3993 $opt->{'table'} = 'cust_pay_batch';
3994 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3995 $opt->{'hashref'}{'custnum'} = $self->custnum;
3996 $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3998 map { $_ } #behavior of sort undefined in scalar context
3999 sort { $a->paybatchnum <=> $b->paybatchnum }
4003 =item cust_pay_pending
4005 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4006 (without status "done").
4010 sub cust_pay_pending {
4012 return $self->num_cust_pay_pending unless wantarray;
4013 sort { $a->_date <=> $b->_date }
4014 qsearch( 'cust_pay_pending', {
4015 'custnum' => $self->custnum,
4016 'status' => { op=>'!=', value=>'done' },
4021 =item cust_pay_pending_attempt
4023 Returns all payment attempts / declined payments for this customer, as pending
4024 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4025 a corresponding payment (see L<FS::cust_pay>).
4029 sub cust_pay_pending_attempt {
4031 return $self->num_cust_pay_pending_attempt unless wantarray;
4032 sort { $a->_date <=> $b->_date }
4033 qsearch( 'cust_pay_pending', {
4034 'custnum' => $self->custnum,
4041 =item num_cust_pay_pending
4043 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4044 customer (without status "done"). Also called automatically when the
4045 cust_pay_pending method is used in a scalar context.
4049 sub num_cust_pay_pending {
4052 " SELECT COUNT(*) FROM cust_pay_pending ".
4053 " WHERE custnum = ? AND status != 'done' ",
4058 =item num_cust_pay_pending_attempt
4060 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4061 customer, with status "done" but without a corresp. Also called automatically when the
4062 cust_pay_pending method is used in a scalar context.
4066 sub num_cust_pay_pending_attempt {
4069 " SELECT COUNT(*) FROM cust_pay_pending ".
4070 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4077 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4083 map { $_ } #return $self->num_cust_refund unless wantarray;
4084 sort { $a->_date <=> $b->_date }
4085 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4088 =item display_custnum
4090 Returns the displayed customer number for this customer: agent_custid if
4091 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4095 sub display_custnum {
4098 return $self->agent_custid
4099 if $default_agent_custid && $self->agent_custid;
4101 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4105 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4106 } elsif ( $custnum_display_length ) {
4107 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4109 return $self->custnum;
4115 Returns a name string for this customer, either "Company (Last, First)" or
4122 my $name = $self->contact;
4123 $name = $self->company. " ($name)" if $self->company;
4127 =item service_contact
4129 Returns the L<FS::contact> object for this customer that has the 'Service'
4130 contact class, or undef if there is no such contact. Deprecated; don't use
4135 sub service_contact {
4137 if ( !exists($self->{service_contact}) ) {
4138 my $classnum = $self->scalar_sql(
4139 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4140 ) || 0; #if it's zero, qsearchs will return nothing
4141 $self->{service_contact} = qsearchs('contact', {
4142 'classnum' => $classnum, 'custnum' => $self->custnum
4145 $self->{service_contact};
4150 Returns a name string for this (service/shipping) contact, either
4151 "Company (Last, First)" or "Last, First".
4158 my $name = $self->ship_contact;
4159 $name = $self->company. " ($name)" if $self->company;
4165 Returns a name string for this customer, either "Company" or "First Last".
4171 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4174 =item ship_name_short
4176 Returns a name string for this (service/shipping) contact, either "Company"
4181 sub ship_name_short {
4183 $self->service_contact
4184 ? $self->ship_contact_firstlast
4190 Returns this customer's full (billing) contact name only, "Last, First"
4196 $self->get('last'). ', '. $self->first;
4201 Returns this customer's full (shipping) contact name only, "Last, First"
4207 my $contact = $self->service_contact || $self;
4208 $contact->get('last') . ', ' . $contact->get('first');
4211 =item contact_firstlast
4213 Returns this customers full (billing) contact name only, "First Last".
4217 sub contact_firstlast {
4219 $self->first. ' '. $self->get('last');
4222 =item ship_contact_firstlast
4224 Returns this customer's full (shipping) contact name only, "First Last".
4228 sub ship_contact_firstlast {
4230 my $contact = $self->service_contact || $self;
4231 $contact->get('first') . ' '. $contact->get('last');
4234 sub bill_country_full {
4236 $self->bill_location->country_full;
4239 sub ship_country_full {
4241 $self->ship_location->country_full;
4244 =item county_state_county [ PREFIX ]
4246 Returns a string consisting of just the county, state and country.
4250 sub county_state_country {
4253 if ( @_ && $_[0] && $self->has_ship_address ) {
4254 $locationnum = $self->ship_locationnum;
4256 $locationnum = $self->bill_locationnum;
4258 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4259 $cust_location->county_state_country;
4262 =item geocode DATA_VENDOR
4264 Returns a value for the customer location as encoded by DATA_VENDOR.
4265 Currently this only makes sense for "CCH" as DATA_VENDOR.
4273 Returns a status string for this customer, currently:
4277 =item prospect - No packages have ever been ordered
4279 =item ordered - Recurring packages all are new (not yet billed).
4281 =item active - One or more recurring packages is active
4283 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4285 =item suspended - All non-cancelled recurring packages are suspended
4287 =item cancelled - All recurring packages are cancelled
4291 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4292 cust_main-status_module configuration option.
4296 sub status { shift->cust_status(@_); }
4300 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4301 for my $status ( FS::cust_main->statuses() ) {
4302 my $method = $status.'_sql';
4303 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4304 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4305 $sth->execute( ($self->custnum) x $numnum )
4306 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4307 if ( $sth->fetchrow_arrayref->[0] ) {
4308 $self->hashref->{cust_status} = $status;
4314 =item is_status_delay_cancel
4316 Returns true if customer status is 'suspended'
4317 and all suspended cust_pkg return true for
4318 cust_pkg->is_status_delay_cancel.
4320 This is not a real status, this only meant for hacking display
4321 values, because otherwise treating the customer as suspended is
4322 really the whole point of the delay_cancel option.
4326 sub is_status_delay_cancel {
4328 return 0 unless $self->status eq 'suspended';
4329 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4330 return 0 unless $cust_pkg->is_status_delay_cancel;
4335 =item ucfirst_cust_status
4337 =item ucfirst_status
4339 Returns the status with the first character capitalized.
4343 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4345 sub ucfirst_cust_status {
4347 ucfirst($self->cust_status);
4352 Returns a hex triplet color string for this customer's status.
4356 sub statuscolor { shift->cust_statuscolor(@_); }
4358 sub cust_statuscolor {
4360 __PACKAGE__->statuscolors->{$self->cust_status};
4363 =item tickets [ STATUS ]
4365 Returns an array of hashes representing the customer's RT tickets.
4367 An optional status (or arrayref or hashref of statuses) may be specified.
4373 my $status = ( @_ && $_[0] ) ? shift : '';
4375 my $num = $conf->config('cust_main-max_tickets') || 10;
4378 if ( $conf->config('ticket_system') ) {
4379 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4381 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4390 foreach my $priority (
4391 $conf->config('ticket_system-custom_priority_field-values'), ''
4393 last if scalar(@tickets) >= $num;
4395 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4396 $num - scalar(@tickets),
4407 =item appointments [ STATUS ]
4409 Returns an array of hashes representing the customer's RT tickets which
4416 my $status = ( @_ && $_[0] ) ? shift : '';
4418 return () unless $conf->config('ticket_system');
4420 my $queueid = $conf->config('ticket_system-appointment-queueid');
4422 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4431 # Return services representing svc_accts in customer support packages
4432 sub support_services {
4434 my %packages = map { $_ => 1 } $conf->config('support_packages');
4436 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4437 grep { $_->part_svc->svcdb eq 'svc_acct' }
4438 map { $_->cust_svc }
4439 grep { exists $packages{ $_->pkgpart } }
4440 $self->ncancelled_pkgs;
4444 # Return a list of latitude/longitude for one of the services (if any)
4445 sub service_coordinates {
4449 grep { $_->latitude && $_->longitude }
4451 map { $_->cust_svc }
4452 $self->ncancelled_pkgs;
4454 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4459 Returns a masked version of the named field
4464 my ($self,$field) = @_;
4468 'x'x(length($self->getfield($field))-4).
4469 substr($self->getfield($field), (length($self->getfield($field))-4));
4473 =item payment_history
4475 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4476 cust_credit and cust_refund objects. Each hashref has the following fields:
4478 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4480 I<date> - value of _date field, unix timestamp
4482 I<date_pretty> - user-friendly date
4484 I<description> - user-friendly description of item
4486 I<amount> - impact of item on user's balance
4487 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4488 Not to be confused with the native 'amount' field in cust_credit, see below.
4490 I<amount_pretty> - includes money char
4492 I<balance> - customer balance, chronologically as of this item
4494 I<balance_pretty> - includes money char
4496 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4498 I<paid> - amount paid for cust_pay records, undef for other types
4500 I<credit> - amount credited for cust_credit records, undef for other types.
4501 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4503 I<refund> - amount refunded for cust_refund records, undef for other types
4505 The four table-specific keys always have positive values, whether they reflect charges or payments.
4507 The following options may be passed to this method:
4509 I<line_items> - if true, returns charges ('Line item') rather than invoices
4511 I<start_date> - unix timestamp, only include records on or after.
4512 If specified, an item of type 'Previous' will also be included.
4513 It does not have table-specific fields.
4515 I<end_date> - unix timestamp, only include records before
4517 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4519 I<conf> - optional already-loaded FS::Conf object.
4523 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4524 # and also for sending customer statements, which should both be kept customer-friendly.
4525 # If you add anything that shouldn't be passed on through the API or exposed
4526 # to customers, add a new option to include it, don't include it by default
4527 sub payment_history {
4529 my $opt = ref($_[0]) ? $_[0] : { @_ };
4531 my $conf = $$opt{'conf'} || new FS::Conf;
4532 my $money_char = $conf->config("money_char") || '$',
4534 #first load entire history,
4535 #need previous to calculate previous balance
4536 #loading after end_date shouldn't hurt too much?
4538 if ( $$opt{'line_items'} ) {
4540 foreach my $cust_bill ( $self->cust_bill ) {
4543 'type' => 'Line item',
4544 'description' => $_->desc( $self->locale ).
4545 ( $_->sdate && $_->edate
4546 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4547 ' To '. time2str('%d-%b-%Y', $_->edate)
4550 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4551 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4552 'date' => $cust_bill->_date,
4553 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4555 foreach $cust_bill->cust_bill_pkg;
4562 'type' => 'Invoice',
4563 'description' => 'Invoice #'. $_->display_invnum,
4564 'amount' => sprintf('%.2f', $_->charged ),
4565 'charged' => sprintf('%.2f', $_->charged ),
4566 'date' => $_->_date,
4567 'date_pretty' => $self->time2str_local('short', $_->_date ),
4569 foreach $self->cust_bill;
4574 'type' => 'Payment',
4575 'description' => 'Payment', #XXX type
4576 'amount' => sprintf('%.2f', 0 - $_->paid ),
4577 'paid' => sprintf('%.2f', $_->paid ),
4578 'date' => $_->_date,
4579 'date_pretty' => $self->time2str_local('short', $_->_date ),
4581 foreach $self->cust_pay;
4585 'description' => 'Credit', #more info?
4586 'amount' => sprintf('%.2f', 0 -$_->amount ),
4587 'credit' => sprintf('%.2f', $_->amount ),
4588 'date' => $_->_date,
4589 'date_pretty' => $self->time2str_local('short', $_->_date ),
4591 foreach $self->cust_credit;
4595 'description' => 'Refund', #more info? type, like payment?
4596 'amount' => $_->refund,
4597 'refund' => $_->refund,
4598 'date' => $_->_date,
4599 'date_pretty' => $self->time2str_local('short', $_->_date ),
4601 foreach $self->cust_refund;
4603 #put it all in chronological order
4604 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4606 #calculate balance, filter items outside date range
4610 foreach my $item (@history) {
4611 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4612 $balance += $$item{'amount'};
4613 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4614 $previous += $$item{'amount'};
4617 $$item{'balance'} = sprintf("%.2f",$balance);
4618 foreach my $key ( qw(amount balance) ) {
4619 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4624 # start with previous balance, if there was one
4627 'type' => 'Previous',
4628 'description' => 'Previous balance',
4629 'amount' => sprintf("%.2f",$previous),
4630 'balance' => sprintf("%.2f",$previous),
4631 'date' => $$opt{'start_date'},
4632 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4634 #false laziness with above
4635 foreach my $key ( qw(amount balance) ) {
4636 $$item{$key.'_pretty'} = $$item{$key};
4637 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4639 unshift(@out,$item);
4642 @out = reverse @history if $$opt{'reverse_sort'};
4649 =head1 CLASS METHODS
4655 Class method that returns the list of possible status strings for customers
4656 (see L<the status method|/status>). For example:
4658 @statuses = FS::cust_main->statuses();
4664 keys %{ $self->statuscolors };
4667 =item cust_status_sql
4669 Returns an SQL fragment to determine the status of a cust_main record, as a
4674 sub cust_status_sql {
4676 for my $status ( FS::cust_main->statuses() ) {
4677 my $method = $status.'_sql';
4678 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4687 Returns an SQL expression identifying prospective cust_main records (customers
4688 with no packages ever ordered)
4692 use vars qw($select_count_pkgs);
4693 $select_count_pkgs =
4694 "SELECT COUNT(*) FROM cust_pkg
4695 WHERE cust_pkg.custnum = cust_main.custnum";
4697 sub select_count_pkgs_sql {
4702 " 0 = ( $select_count_pkgs ) ";
4707 Returns an SQL expression identifying ordered cust_main records (customers with
4708 no active packages, but recurring packages not yet setup or one time charges
4714 FS::cust_main->none_active_sql.
4715 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4720 Returns an SQL expression identifying active cust_main records (customers with
4721 active recurring packages).
4726 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4729 =item none_active_sql
4731 Returns an SQL expression identifying cust_main records with no active
4732 recurring packages. This includes customers of status prospect, ordered,
4733 inactive, and suspended.
4737 sub none_active_sql {
4738 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4743 Returns an SQL expression identifying inactive cust_main records (customers with
4744 no active recurring packages, but otherwise unsuspended/uncancelled).
4749 FS::cust_main->none_active_sql.
4750 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4756 Returns an SQL expression identifying suspended cust_main records.
4761 sub suspended_sql { susp_sql(@_); }
4763 FS::cust_main->none_active_sql.
4764 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4770 Returns an SQL expression identifying cancelled cust_main records.
4774 sub cancel_sql { shift->cancelled_sql(@_); }
4777 =item uncancelled_sql
4779 Returns an SQL expression identifying un-cancelled cust_main records.
4783 sub uncancelled_sql { uncancel_sql(@_); }
4784 sub uncancel_sql { "
4785 ( 0 < ( $select_count_pkgs
4786 AND ( cust_pkg.cancel IS NULL
4787 OR cust_pkg.cancel = 0
4790 OR 0 = ( $select_count_pkgs )
4796 Returns an SQL fragment to retreive the balance.
4801 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4802 WHERE cust_bill.custnum = cust_main.custnum )
4803 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4804 WHERE cust_pay.custnum = cust_main.custnum )
4805 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4806 WHERE cust_credit.custnum = cust_main.custnum )
4807 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4808 WHERE cust_refund.custnum = cust_main.custnum )
4811 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4813 Returns an SQL fragment to retreive the balance for this customer, optionally
4814 considering invoices with date earlier than START_TIME, and not
4815 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4816 total_unapplied_payments).
4818 Times are specified as SQL fragments or numeric
4819 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4820 L<Date::Parse> for conversion functions. The empty string can be passed
4821 to disable that time constraint completely.
4823 Available options are:
4827 =item unapplied_date
4829 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)
4834 set to true to remove all customer comparison clauses, for totals
4839 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4844 JOIN clause (typically used with the total option)
4848 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
4849 time will be ignored. Note that START_TIME and END_TIME only limit the date
4850 range for invoices and I<unapplied> payments, credits, and refunds.
4856 sub balance_date_sql {
4857 my( $class, $start, $end, %opt ) = @_;
4859 my $cutoff = $opt{'cutoff'};
4861 my $owed = FS::cust_bill->owed_sql($cutoff);
4862 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4863 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4864 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4866 my $j = $opt{'join'} || '';
4868 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
4869 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4870 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4871 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
4873 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
4874 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4875 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4876 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
4881 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4883 Returns an SQL fragment to retreive the total unapplied payments for this
4884 customer, only considering payments with date earlier than START_TIME, and
4885 optionally not later than END_TIME.
4887 Times are specified as SQL fragments or numeric
4888 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4889 L<Date::Parse> for conversion functions. The empty string can be passed
4890 to disable that time constraint completely.
4892 Available options are:
4896 sub unapplied_payments_date_sql {
4897 my( $class, $start, $end, %opt ) = @_;
4899 my $cutoff = $opt{'cutoff'};
4901 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
4903 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4904 'unapplied_date'=>1 );
4906 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4909 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4911 Helper method for balance_date_sql; name (and usage) subject to change
4912 (suggestions welcome).
4914 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4915 cust_refund, cust_credit or cust_pay).
4917 If TABLE is "cust_bill" or the unapplied_date option is true, only
4918 considers records with date earlier than START_TIME, and optionally not
4919 later than END_TIME .
4923 sub _money_table_where {
4924 my( $class, $table, $start, $end, %opt ) = @_;
4927 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4928 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4929 push @where, "$table._date <= $start" if defined($start) && length($start);
4930 push @where, "$table._date > $end" if defined($end) && length($end);
4932 push @where, @{$opt{'where'}} if $opt{'where'};
4933 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4939 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4940 use FS::cust_main::Search;
4943 FS::cust_main::Search->search(@_);
4958 #warn join('-',keys %$param);
4959 my $fh = $param->{filehandle};
4960 my $agentnum = $param->{agentnum};
4961 my $format = $param->{format};
4963 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4966 if ( $format eq 'simple' ) {
4967 @fields = qw( custnum agent_custid amount pkg );
4969 die "unknown format $format";
4972 eval "use Text::CSV_XS;";
4975 my $csv = new Text::CSV_XS;
4982 local $SIG{HUP} = 'IGNORE';
4983 local $SIG{INT} = 'IGNORE';
4984 local $SIG{QUIT} = 'IGNORE';
4985 local $SIG{TERM} = 'IGNORE';
4986 local $SIG{TSTP} = 'IGNORE';
4987 local $SIG{PIPE} = 'IGNORE';
4989 my $oldAutoCommit = $FS::UID::AutoCommit;
4990 local $FS::UID::AutoCommit = 0;
4993 #while ( $columns = $csv->getline($fh) ) {
4995 while ( defined($line=<$fh>) ) {
4997 $csv->parse($line) or do {
4998 $dbh->rollback if $oldAutoCommit;
4999 return "can't parse: ". $csv->error_input();
5002 my @columns = $csv->fields();
5003 #warn join('-',@columns);
5006 foreach my $field ( @fields ) {
5007 $row{$field} = shift @columns;
5010 if ( $row{custnum} && $row{agent_custid} ) {
5011 dbh->rollback if $oldAutoCommit;
5012 return "can't specify custnum with agent_custid $row{agent_custid}";
5016 if ( $row{agent_custid} && $agentnum ) {
5017 %hash = ( 'agent_custid' => $row{agent_custid},
5018 'agentnum' => $agentnum,
5022 if ( $row{custnum} ) {
5023 %hash = ( 'custnum' => $row{custnum} );
5026 unless ( scalar(keys %hash) ) {
5027 $dbh->rollback if $oldAutoCommit;
5028 return "can't find customer without custnum or agent_custid and agentnum";
5031 my $cust_main = qsearchs('cust_main', { %hash } );
5032 unless ( $cust_main ) {
5033 $dbh->rollback if $oldAutoCommit;
5034 my $custnum = $row{custnum} || $row{agent_custid};
5035 return "unknown custnum $custnum";
5038 if ( $row{'amount'} > 0 ) {
5039 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5041 $dbh->rollback if $oldAutoCommit;
5045 } elsif ( $row{'amount'} < 0 ) {
5046 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5049 $dbh->rollback if $oldAutoCommit;
5059 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5061 return "Empty file!" unless $imported;
5067 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5069 Deprecated. Use event notification and message templates
5070 (L<FS::msg_template>) instead.
5072 Sends a templated email notification to the customer (see L<Text::Template>).
5074 OPTIONS is a hash and may include
5076 I<from> - the email sender (default is invoice_from)
5078 I<to> - comma-separated scalar or arrayref of recipients
5079 (default is invoicing_list)
5081 I<subject> - The subject line of the sent email notification
5082 (default is "Notice from company_name")
5084 I<extra_fields> - a hashref of name/value pairs which will be substituted
5087 The following variables are vavailable in the template.
5089 I<$first> - the customer first name
5090 I<$last> - the customer last name
5091 I<$company> - the customer company
5092 I<$payby> - a description of the method of payment for the customer
5093 # would be nice to use FS::payby::shortname
5094 I<$payinfo> - the account information used to collect for this customer
5095 I<$expdate> - the expiration of the customer payment in seconds from epoch
5100 my ($self, $template, %options) = @_;
5102 return unless $conf->exists($template);
5104 my $from = $conf->invoice_from_full($self->agentnum)
5105 if $conf->exists('invoice_from', $self->agentnum);
5106 $from = $options{from} if exists($options{from});
5108 my $to = join(',', $self->invoicing_list_emailonly);
5109 $to = $options{to} if exists($options{to});
5111 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5112 if $conf->exists('company_name', $self->agentnum);
5113 $subject = $options{subject} if exists($options{subject});
5115 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5116 SOURCE => [ map "$_\n",
5117 $conf->config($template)]
5119 or die "can't create new Text::Template object: Text::Template::ERROR";
5120 $notify_template->compile()
5121 or die "can't compile template: Text::Template::ERROR";
5123 $FS::notify_template::_template::company_name =
5124 $conf->config('company_name', $self->agentnum);
5125 $FS::notify_template::_template::company_address =
5126 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5128 my $paydate = $self->paydate || '2037-12-31';
5129 $FS::notify_template::_template::first = $self->first;
5130 $FS::notify_template::_template::last = $self->last;
5131 $FS::notify_template::_template::company = $self->company;
5132 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5133 my $payby = $self->payby;
5134 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5135 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5137 #credit cards expire at the end of the month/year of their exp date
5138 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5139 $FS::notify_template::_template::payby = 'credit card';
5140 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5141 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5143 }elsif ($payby eq 'COMP') {
5144 $FS::notify_template::_template::payby = 'complimentary account';
5146 $FS::notify_template::_template::payby = 'current method';
5148 $FS::notify_template::_template::expdate = $expire_time;
5150 for (keys %{$options{extra_fields}}){
5152 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5155 send_email(from => $from,
5157 subject => $subject,
5158 body => $notify_template->fill_in( PACKAGE =>
5159 'FS::notify_template::_template' ),
5164 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5166 Generates a templated notification to the customer (see L<Text::Template>).
5168 OPTIONS is a hash and may include
5170 I<extra_fields> - a hashref of name/value pairs which will be substituted
5171 into the template. These values may override values mentioned below
5172 and those from the customer record.
5174 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5176 The following variables are available in the template instead of or in addition
5177 to the fields of the customer record.
5179 I<$payby> - a description of the method of payment for the customer
5180 # would be nice to use FS::payby::shortname
5181 I<$payinfo> - the masked account information used to collect for this customer
5182 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5183 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5187 # a lot like cust_bill::print_latex
5188 sub generate_letter {
5189 my ($self, $template, %options) = @_;
5191 warn "Template $template does not exist" && return
5192 unless $conf->exists($template) || $options{'template_text'};
5194 my $template_source = $options{'template_text'}
5195 ? [ $options{'template_text'} ]
5196 : [ map "$_\n", $conf->config($template) ];
5198 my $letter_template = new Text::Template
5200 SOURCE => $template_source,
5201 DELIMITERS => [ '[@--', '--@]' ],
5203 or die "can't create new Text::Template object: Text::Template::ERROR";
5205 $letter_template->compile()
5206 or die "can't compile template: Text::Template::ERROR";
5208 my %letter_data = map { $_ => $self->$_ } $self->fields;
5209 $letter_data{payinfo} = $self->mask_payinfo;
5211 #my $paydate = $self->paydate || '2037-12-31';
5212 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5214 my $payby = $self->payby;
5215 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5216 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5218 #credit cards expire at the end of the month/year of their exp date
5219 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5220 $letter_data{payby} = 'credit card';
5221 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5222 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5224 }elsif ($payby eq 'COMP') {
5225 $letter_data{payby} = 'complimentary account';
5227 $letter_data{payby} = 'current method';
5229 $letter_data{expdate} = $expire_time;
5231 for (keys %{$options{extra_fields}}){
5232 $letter_data{$_} = $options{extra_fields}->{$_};
5235 unless(exists($letter_data{returnaddress})){
5236 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5237 $self->agent_template)
5239 if ( length($retadd) ) {
5240 $letter_data{returnaddress} = $retadd;
5241 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5242 $letter_data{returnaddress} =
5243 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5247 ( $conf->config('company_name', $self->agentnum),
5248 $conf->config('company_address', $self->agentnum),
5252 $letter_data{returnaddress} = '~';
5256 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5258 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5260 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5262 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5266 ) or die "can't open temp file: $!\n";
5267 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5268 or die "can't write temp file: $!\n";
5270 $letter_data{'logo_file'} = $lh->filename;
5272 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5276 ) or die "can't open temp file: $!\n";
5278 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5280 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5281 return ($1, $letter_data{'logo_file'});
5285 =item print_ps TEMPLATE
5287 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5293 my($file, $lfile) = $self->generate_letter(@_);
5294 my $ps = FS::Misc::generate_ps($file);
5295 unlink($file.'.tex');
5301 =item print TEMPLATE
5303 Prints the filled in template.
5305 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5309 sub queueable_print {
5312 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5313 or die "invalid customer number: " . $opt{custnum};
5315 my $error = $self->print( { 'template' => $opt{template} } );
5316 die $error if $error;
5320 my ($self, $template) = (shift, shift);
5322 [ $self->print_ps($template) ],
5323 'agentnum' => $self->agentnum,
5327 #these three subs should just go away once agent stuff is all config overrides
5329 sub agent_template {
5331 $self->_agent_plandata('agent_templatename');
5334 sub agent_invoice_from {
5336 $self->_agent_plandata('agent_invoice_from');
5339 sub _agent_plandata {
5340 my( $self, $option ) = @_;
5342 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5343 #agent-specific Conf
5345 use FS::part_event::Condition;
5347 my $agentnum = $self->agentnum;
5349 my $regexp = regexp_sql();
5351 my $part_event_option =
5353 'select' => 'part_event_option.*',
5354 'table' => 'part_event_option',
5356 LEFT JOIN part_event USING ( eventpart )
5357 LEFT JOIN part_event_option AS peo_agentnum
5358 ON ( part_event.eventpart = peo_agentnum.eventpart
5359 AND peo_agentnum.optionname = 'agentnum'
5360 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5362 LEFT JOIN part_event_condition
5363 ON ( part_event.eventpart = part_event_condition.eventpart
5364 AND part_event_condition.conditionname = 'cust_bill_age'
5366 LEFT JOIN part_event_condition_option
5367 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5368 AND part_event_condition_option.optionname = 'age'
5371 #'hashref' => { 'optionname' => $option },
5372 #'hashref' => { 'part_event_option.optionname' => $option },
5374 " WHERE part_event_option.optionname = ". dbh->quote($option).
5375 " AND action = 'cust_bill_send_agent' ".
5376 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5377 " AND peo_agentnum.optionname = 'agentnum' ".
5378 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5380 CASE WHEN part_event_condition_option.optionname IS NULL
5382 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5384 , part_event.weight".
5388 unless ( $part_event_option ) {
5389 return $self->agent->invoice_template || ''
5390 if $option eq 'agent_templatename';
5394 $part_event_option->optionvalue;
5398 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5400 Subroutine (not a method), designed to be called from the queue.
5402 Takes a list of options and values.
5404 Pulls up the customer record via the custnum option and calls bill_and_collect.
5409 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5411 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5412 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5414 #without this errors don't get rolled back
5415 $args{'fatal'} = 1; # runs from job queue, will be caught
5417 $cust_main->bill_and_collect( %args );
5420 sub process_bill_and_collect {
5422 my $param = thaw(decode_base64(shift));
5423 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5424 or die "custnum '$param->{custnum}' not found!\n";
5425 $param->{'job'} = $job;
5426 $param->{'fatal'} = 1; # runs from job queue, will be caught
5427 $param->{'retry'} = 1;
5429 $cust_main->bill_and_collect( %$param );
5432 #starting to take quite a while for big dbs
5433 # (JRNL: journaled so it only happens once per database)
5434 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5435 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5436 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5437 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5438 # JRNL leading/trailing spaces in first, last, company
5439 # - otaker upgrade? journal and call it good? (double check to make sure
5440 # we're not still setting otaker here)
5442 #only going to get worse with new location stuff...
5444 sub _upgrade_data { #class method
5445 my ($class, %opts) = @_;
5448 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5451 #this seems to be the only expensive one.. why does it take so long?
5452 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5454 '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';
5455 FS::upgrade_journal->set_done('cust_main__signupdate');
5458 unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5460 # fix yyyy-m-dd formatted paydates
5461 if ( driver_name =~ /^mysql/i ) {
5463 "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5464 } else { # the SQL standard
5466 "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5468 FS::upgrade_journal->set_done('cust_main__paydate');
5471 unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5473 push @statements, #fix the weird BILL with a cc# in payinfo problem
5475 "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5477 FS::upgrade_journal->set_done('cust_main__payinfo');
5482 foreach my $sql ( @statements ) {
5483 my $sth = dbh->prepare($sql) or die dbh->errstr;
5484 $sth->execute or die $sth->errstr;
5485 #warn ( (time - $t). " seconds\n" );
5489 local($ignore_expired_card) = 1;
5490 local($ignore_banned_card) = 1;
5491 local($skip_fuzzyfiles) = 1;
5492 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5494 FS::cust_main::Location->_upgrade_data(%opts);
5496 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5498 foreach my $cust_main ( qsearch({
5499 'table' => 'cust_main',
5501 'extra_sql' => 'WHERE '.
5503 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5504 qw( first last company )
5507 my $error = $cust_main->replace;
5508 die $error if $error;
5511 FS::upgrade_journal->set_done('cust_main__trimspaces');
5515 $class->_upgrade_otaker(%opts);
5525 The delete method should possibly take an FS::cust_main object reference
5526 instead of a scalar customer number.
5528 Bill and collect options should probably be passed as references instead of a
5531 There should probably be a configuration file with a list of allowed credit
5534 No multiple currency support (probably a larger project than just this module).
5536 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5538 Birthdates rely on negative epoch values.
5540 The payby for card/check batches is broken. With mixed batching, bad
5543 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5547 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5548 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5549 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.