4 use vars qw( @ISA $conf $Debug $import );
10 use Business::CreditCard;
11 use FS::UID qw( getotaker dbh );
12 use FS::Record qw( qsearchs qsearch dbdef );
15 use FS::cust_bill_pkg;
18 use FS::part_referral;
19 use FS::cust_main_county;
21 use FS::cust_main_invoice;
22 use FS::cust_credit_bill;
23 use FS::cust_bill_pay;
24 use FS::prepay_credit;
27 use FS::part_bill_event;
28 use FS::cust_bill_event;
29 use FS::cust_tax_exempt;
31 use FS::Msgcat qw(gettext);
33 @ISA = qw( FS::Record );
40 #ask FS::UID to run this stuff for us later
41 $FS::UID::callback{'FS::cust_main'} = sub {
43 #yes, need it for stuff below (prolly should be cached)
48 my ( $hashref, $cache ) = @_;
49 if ( exists $hashref->{'pkgnum'} ) {
50 # #@{ $self->{'_pkgnum'} } = ();
51 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
52 $self->{'_pkgnum'} = $subcache;
53 #push @{ $self->{'_pkgnum'} },
54 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
60 FS::cust_main - Object methods for cust_main records
66 $record = new FS::cust_main \%hash;
67 $record = new FS::cust_main { 'column' => 'value' };
69 $error = $record->insert;
71 $error = $new_record->replace($old_record);
73 $error = $record->delete;
75 $error = $record->check;
77 @cust_pkg = $record->all_pkgs;
79 @cust_pkg = $record->ncancelled_pkgs;
81 @cust_pkg = $record->suspended_pkgs;
83 $error = $record->bill;
84 $error = $record->bill %options;
85 $error = $record->bill 'time' => $time;
87 $error = $record->collect;
88 $error = $record->collect %options;
89 $error = $record->collect 'invoice_time' => $time,
90 'batch_card' => 'yes',
91 'report_badcard' => 'yes',
96 An FS::cust_main object represents a customer. FS::cust_main inherits from
97 FS::Record. The following fields are currently supported:
101 =item custnum - primary key (assigned automatically for new customers)
103 =item agentnum - agent (see L<FS::agent>)
105 =item refnum - Advertising source (see L<FS::part_referral>)
111 =item ss - social security number (optional)
113 =item company - (optional)
117 =item address2 - (optional)
121 =item county - (optional, see L<FS::cust_main_county>)
123 =item state - (see L<FS::cust_main_county>)
127 =item country - (see L<FS::cust_main_county>)
129 =item daytime - phone (optional)
131 =item night - phone (optional)
133 =item fax - phone (optional)
135 =item ship_first - name
137 =item ship_last - name
139 =item ship_company - (optional)
143 =item ship_address2 - (optional)
147 =item ship_county - (optional, see L<FS::cust_main_county>)
149 =item ship_state - (see L<FS::cust_main_county>)
153 =item ship_country - (see L<FS::cust_main_county>)
155 =item ship_daytime - phone (optional)
157 =item ship_night - phone (optional)
159 =item ship_fax - phone (optional)
161 =item payby - `CARD' (credit cards), `CHEK' (electronic check), `LECB' (Phone bill billing), `BILL' (billing), `COMP' (free), or `PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to BILL)
163 =item payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
165 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
167 =item payname - name on card or billing name
169 =item tax - tax exempt, empty or `Y'
171 =item otaker - order taker (assigned automatically, see L<FS::UID>)
173 =item comments - comments (optional)
175 =item referral_custnum - referring customer number
185 Creates a new customer. To add the customer to the database, see L<"insert">.
187 Note that this stores the hash reference, not a distinct copy of the hash it
188 points to. You can ask the object for a copy with the I<hash> method.
192 sub table { 'cust_main'; }
194 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] ]
196 Adds this customer to the database. If there is an error, returns the error,
197 otherwise returns false.
199 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
200 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
201 are inserted atomicly, or the transaction is rolled back. Passing an empty
202 hash reference is equivalent to not supplying this parameter. There should be
203 a better explanation of this, but until then, here's an example:
206 tie %hash, 'Tie::RefHash'; #this part is important
208 $cust_pkg => [ $svc_acct ],
211 $cust_main->insert( \%hash );
213 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
214 be set as the invoicing list (see L<"invoicing_list">). Errors return as
215 expected and rollback the entire transaction; it is not necessary to call
216 check_invoicing_list first. The invoicing_list is set after the records in the
217 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
218 invoicing_list destination to the newly-created svc_acct. Here's an example:
220 $cust_main->insert( {}, [ $email, 'POST' ] );
226 my $cust_pkgs = @_ ? shift : {};
227 my $invoicing_list = @_ ? shift : '';
229 local $SIG{HUP} = 'IGNORE';
230 local $SIG{INT} = 'IGNORE';
231 local $SIG{QUIT} = 'IGNORE';
232 local $SIG{TERM} = 'IGNORE';
233 local $SIG{TSTP} = 'IGNORE';
234 local $SIG{PIPE} = 'IGNORE';
236 my $oldAutoCommit = $FS::UID::AutoCommit;
237 local $FS::UID::AutoCommit = 0;
242 if ( $self->payby eq 'PREPAY' ) {
243 $self->payby('BILL');
244 my $prepay_credit = qsearchs(
246 { 'identifier' => $self->payinfo },
250 warn "WARNING: can't find pre-found prepay_credit: ". $self->payinfo
251 unless $prepay_credit;
252 $amount = $prepay_credit->amount;
253 $seconds = $prepay_credit->seconds;
254 my $error = $prepay_credit->delete;
256 $dbh->rollback if $oldAutoCommit;
257 return "removing prepay_credit (transaction rolled back): $error";
261 my $error = $self->SUPER::insert;
263 $dbh->rollback if $oldAutoCommit;
264 #return "inserting cust_main record (transaction rolled back): $error";
269 if ( $invoicing_list ) {
270 $error = $self->check_invoicing_list( $invoicing_list );
272 $dbh->rollback if $oldAutoCommit;
273 return "checking invoicing_list (transaction rolled back): $error";
275 $self->invoicing_list( $invoicing_list );
279 foreach my $cust_pkg ( keys %$cust_pkgs ) {
280 $cust_pkg->custnum( $self->custnum );
281 $error = $cust_pkg->insert;
283 $dbh->rollback if $oldAutoCommit;
284 return "inserting cust_pkg (transaction rolled back): $error";
286 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
287 $svc_something->pkgnum( $cust_pkg->pkgnum );
288 if ( $seconds && $svc_something->isa('FS::svc_acct') ) {
289 $svc_something->seconds( $svc_something->seconds + $seconds );
292 $error = $svc_something->insert;
294 $dbh->rollback if $oldAutoCommit;
295 #return "inserting svc_ (transaction rolled back): $error";
302 $dbh->rollback if $oldAutoCommit;
303 return "No svc_acct record to apply pre-paid time";
307 my $cust_credit = new FS::cust_credit {
308 'custnum' => $self->custnum,
311 $error = $cust_credit->insert;
313 $dbh->rollback if $oldAutoCommit;
314 return "inserting credit (transaction rolled back): $error";
318 #false laziness with sub replace
319 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
320 $error = $queue->insert($self->getfield('last'), $self->company);
322 $dbh->rollback if $oldAutoCommit;
323 return "queueing job (transaction rolled back): $error";
326 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
327 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
328 $error = $queue->insert($self->getfield('last'), $self->company);
330 $dbh->rollback if $oldAutoCommit;
331 return "queueing job (transaction rolled back): $error";
336 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
341 =item delete NEW_CUSTNUM
343 This deletes the customer. If there is an error, returns the error, otherwise
346 This will completely remove all traces of the customer record. This is not
347 what you want when a customer cancels service; for that, cancel all of the
348 customer's packages (see L<FS::cust_pkg/cancel>).
350 If the customer has any uncancelled packages, you need to pass a new (valid)
351 customer number for those packages to be transferred to. Cancelled packages
352 will be deleted. Did I mention that this is NOT what you want when a customer
353 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
355 You can't delete a customer with invoices (see L<FS::cust_bill>),
356 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
357 refunds (see L<FS::cust_refund>).
364 local $SIG{HUP} = 'IGNORE';
365 local $SIG{INT} = 'IGNORE';
366 local $SIG{QUIT} = 'IGNORE';
367 local $SIG{TERM} = 'IGNORE';
368 local $SIG{TSTP} = 'IGNORE';
369 local $SIG{PIPE} = 'IGNORE';
371 my $oldAutoCommit = $FS::UID::AutoCommit;
372 local $FS::UID::AutoCommit = 0;
375 if ( qsearch( 'cust_bill', { 'custnum' => $self->custnum } ) ) {
376 $dbh->rollback if $oldAutoCommit;
377 return "Can't delete a customer with invoices";
379 if ( qsearch( 'cust_credit', { 'custnum' => $self->custnum } ) ) {
380 $dbh->rollback if $oldAutoCommit;
381 return "Can't delete a customer with credits";
383 if ( qsearch( 'cust_pay', { 'custnum' => $self->custnum } ) ) {
384 $dbh->rollback if $oldAutoCommit;
385 return "Can't delete a customer with payments";
387 if ( qsearch( 'cust_refund', { 'custnum' => $self->custnum } ) ) {
388 $dbh->rollback if $oldAutoCommit;
389 return "Can't delete a customer with refunds";
392 my @cust_pkg = $self->ncancelled_pkgs;
394 my $new_custnum = shift;
395 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
396 $dbh->rollback if $oldAutoCommit;
397 return "Invalid new customer number: $new_custnum";
399 foreach my $cust_pkg ( @cust_pkg ) {
400 my %hash = $cust_pkg->hash;
401 $hash{'custnum'} = $new_custnum;
402 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
403 my $error = $new_cust_pkg->replace($cust_pkg);
405 $dbh->rollback if $oldAutoCommit;
410 my @cancelled_cust_pkg = $self->all_pkgs;
411 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
412 my $error = $cust_pkg->delete;
414 $dbh->rollback if $oldAutoCommit;
419 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
420 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
422 my $error = $cust_main_invoice->delete;
424 $dbh->rollback if $oldAutoCommit;
429 my $error = $self->SUPER::delete;
431 $dbh->rollback if $oldAutoCommit;
435 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
440 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
442 Replaces the OLD_RECORD with this one in the database. If there is an error,
443 returns the error, otherwise returns false.
445 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
446 be set as the invoicing list (see L<"invoicing_list">). Errors return as
447 expected and rollback the entire transaction; it is not necessary to call
448 check_invoicing_list first. Here's an example:
450 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
459 local $SIG{HUP} = 'IGNORE';
460 local $SIG{INT} = 'IGNORE';
461 local $SIG{QUIT} = 'IGNORE';
462 local $SIG{TERM} = 'IGNORE';
463 local $SIG{TSTP} = 'IGNORE';
464 local $SIG{PIPE} = 'IGNORE';
466 my $oldAutoCommit = $FS::UID::AutoCommit;
467 local $FS::UID::AutoCommit = 0;
470 my $error = $self->SUPER::replace($old);
473 $dbh->rollback if $oldAutoCommit;
477 if ( @param ) { # INVOICING_LIST_ARYREF
478 my $invoicing_list = shift @param;
479 $error = $self->check_invoicing_list( $invoicing_list );
481 $dbh->rollback if $oldAutoCommit;
484 $self->invoicing_list( $invoicing_list );
487 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
488 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
489 # card/check info has changed, want to retry realtime_card invoice events
490 #false laziness w/collect
491 foreach my $cust_bill_event (
493 #$_->part_bill_event->plan eq 'realtime-card'
494 $_->part_bill_event->eventcode =~
495 /^\$cust_bill\->realtime_(card|ach|lec)\(\);$/
496 && $_->status eq 'done'
499 map { $_->cust_bill_event }
500 grep { $_->cust_bill_event }
501 $self->open_cust_bill
504 my $error = $cust_bill_event->retry;
506 $dbh->rollback if $oldAutoCommit;
507 return "error scheduling invoice events for retry: $error";
514 #false laziness with sub insert
515 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
516 $error = $queue->insert($self->getfield('last'), $self->company);
518 $dbh->rollback if $oldAutoCommit;
519 return "queueing job (transaction rolled back): $error";
522 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
523 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
524 $error = $queue->insert($self->getfield('last'), $self->company);
526 $dbh->rollback if $oldAutoCommit;
527 return "queueing job (transaction rolled back): $error";
532 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
539 Checks all fields to make sure this is a valid customer record. If there is
540 an error, returns the error, otherwise returns false. Called by the insert
548 #warn "BEFORE: \n". $self->_dump;
551 $self->ut_numbern('custnum')
552 || $self->ut_number('agentnum')
553 || $self->ut_number('refnum')
554 || $self->ut_name('last')
555 || $self->ut_name('first')
556 || $self->ut_textn('company')
557 || $self->ut_text('address1')
558 || $self->ut_textn('address2')
559 || $self->ut_text('city')
560 || $self->ut_textn('county')
561 || $self->ut_textn('state')
562 || $self->ut_country('country')
563 || $self->ut_anything('comments')
564 || $self->ut_numbern('referral_custnum')
566 #barf. need message catalogs. i18n. etc.
567 $error .= "Please select a advertising source."
568 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
569 return $error if $error;
571 return "Unknown agent"
572 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
574 return "Unknown refnum"
575 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
577 return "Unknown referring custnum ". $self->referral_custnum
578 unless ! $self->referral_custnum
579 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
581 if ( $self->ss eq '' ) {
586 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
587 or return "Illegal social security number: ". $self->ss;
588 $self->ss("$1-$2-$3");
592 # bad idea to disable, causes billing to fail because of no tax rates later
593 # unless ( $import ) {
594 unless ( qsearch('cust_main_county', {
595 'country' => $self->country,
598 return "Unknown state/county/country: ".
599 $self->state. "/". $self->county. "/". $self->country
600 unless qsearch('cust_main_county',{
601 'state' => $self->state,
602 'county' => $self->county,
603 'country' => $self->country,
609 $self->ut_phonen('daytime', $self->country)
610 || $self->ut_phonen('night', $self->country)
611 || $self->ut_phonen('fax', $self->country)
612 || $self->ut_zip('zip', $self->country)
614 return $error if $error;
617 last first company address1 address2 city county state zip
618 country daytime night fax
621 if ( defined $self->dbdef_table->column('ship_last') ) {
622 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
624 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
628 $self->ut_name('ship_last')
629 || $self->ut_name('ship_first')
630 || $self->ut_textn('ship_company')
631 || $self->ut_text('ship_address1')
632 || $self->ut_textn('ship_address2')
633 || $self->ut_text('ship_city')
634 || $self->ut_textn('ship_county')
635 || $self->ut_textn('ship_state')
636 || $self->ut_country('ship_country')
638 return $error if $error;
640 #false laziness with above
641 unless ( qsearchs('cust_main_county', {
642 'country' => $self->ship_country,
645 return "Unknown ship_state/ship_county/ship_country: ".
646 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
647 unless qsearchs('cust_main_county',{
648 'state' => $self->ship_state,
649 'county' => $self->ship_county,
650 'country' => $self->ship_country,
656 $self->ut_phonen('ship_daytime', $self->ship_country)
657 || $self->ut_phonen('ship_night', $self->ship_country)
658 || $self->ut_phonen('ship_fax', $self->ship_country)
659 || $self->ut_zip('ship_zip', $self->ship_country)
661 return $error if $error;
663 } else { # ship_ info eq billing info, so don't store dup info in database
664 $self->setfield("ship_$_", '')
665 foreach qw( last first company address1 address2 city county state zip
666 country daytime night fax );
670 $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREPAY)$/
671 or return "Illegal payby: ". $self->payby;
674 if ( $self->payby eq 'CARD' ) {
676 my $payinfo = $self->payinfo;
678 $payinfo =~ /^(\d{13,16})$/
679 or return gettext('invalid_card'); # . ": ". $self->payinfo;
681 $self->payinfo($payinfo);
683 or return gettext('invalid_card'); # . ": ". $self->payinfo;
684 return gettext('unknown_card_type')
685 if cardtype($self->payinfo) eq "Unknown";
687 } elsif ( $self->payby eq 'CHEK' ) {
689 my $payinfo = $self->payinfo;
690 $payinfo =~ s/[^\d\@]//g;
691 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
693 $self->payinfo($payinfo);
695 } elsif ( $self->payby eq 'LECB' ) {
697 my $payinfo = $self->payinfo;
699 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
701 $self->payinfo($payinfo);
703 } elsif ( $self->payby eq 'BILL' ) {
705 $error = $self->ut_textn('payinfo');
706 return "Illegal P.O. number: ". $self->payinfo if $error;
708 } elsif ( $self->payby eq 'COMP' ) {
710 $error = $self->ut_textn('payinfo');
711 return "Illegal comp account issuer: ". $self->payinfo if $error;
713 } elsif ( $self->payby eq 'PREPAY' ) {
715 my $payinfo = $self->payinfo;
716 $payinfo =~ s/\W//g; #anything else would just confuse things
717 $self->payinfo($payinfo);
718 $error = $self->ut_alpha('payinfo');
719 return "Illegal prepayment identifier: ". $self->payinfo if $error;
720 return "Unknown prepayment identifier"
721 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
725 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
726 return "Expriation date required"
727 unless $self->payby =~ /^(BILL|PREPAY|CHEK|LECB)$/;
730 $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/
731 or return "Illegal expiration date: ". $self->paydate;
732 my $y = length($2) == 4 ? $2 : "20$2";
733 $self->paydate("$y-$1-01");
734 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
735 return gettext('expired_card')
736 if !$import && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
739 if ( $self->payname eq '' && $self->payby ne 'CHEK' &&
740 ( ! $conf->exists('require_cardname') || $self->payby ne 'CARD' ) ) {
741 $self->payname( $self->first. " ". $self->getfield('last') );
743 $self->payname =~ /^([\w \,\.\-\']+)$/
744 or return gettext('illegal_name'). " payname: ". $self->payname;
748 $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
751 $self->otaker(getotaker);
753 #warn "AFTER: \n". $self->_dump;
760 Returns all packages (see L<FS::cust_pkg>) for this customer.
766 if ( $self->{'_pkgnum'} ) {
767 values %{ $self->{'_pkgnum'}->cache };
769 qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
773 =item ncancelled_pkgs
775 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
779 sub ncancelled_pkgs {
781 if ( $self->{'_pkgnum'} ) {
782 grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
784 @{ [ # force list context
785 qsearch( 'cust_pkg', {
786 'custnum' => $self->custnum,
789 qsearch( 'cust_pkg', {
790 'custnum' => $self->custnum,
799 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
805 grep { $_->susp } $self->ncancelled_pkgs;
808 =item unflagged_suspended_pkgs
810 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
811 customer (thouse packages without the `manual_flag' set).
815 sub unflagged_suspended_pkgs {
817 return $self->suspended_pkgs
818 unless dbdef->table('cust_pkg')->column('manual_flag');
819 grep { ! $_->manual_flag } $self->suspended_pkgs;
822 =item unsuspended_pkgs
824 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
829 sub unsuspended_pkgs {
831 grep { ! $_->susp } $self->ncancelled_pkgs;
836 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
837 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
838 on success or a list of errors.
844 grep { $_->unsuspend } $self->suspended_pkgs;
849 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
850 Always returns a list: an empty list on success or a list of errors.
856 grep { $_->suspend } $self->unsuspended_pkgs;
861 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
862 Always returns a list: an empty list on success or a list of errors.
868 grep { $_->cancel } $self->ncancelled_pkgs;
873 Returns the agent (see L<FS::agent>) for this customer.
879 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
884 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
885 conjunction with the collect method.
887 Options are passed as name-value pairs.
889 The only currently available option is `time', which bills the customer as if
890 it were that time. It is specified as a UNIX timestamp; see
891 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
892 functions. For example:
896 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
898 If there is an error, returns the error, otherwise returns false.
903 my( $self, %options ) = @_;
904 my $time = $options{'time'} || time;
909 local $SIG{HUP} = 'IGNORE';
910 local $SIG{INT} = 'IGNORE';
911 local $SIG{QUIT} = 'IGNORE';
912 local $SIG{TERM} = 'IGNORE';
913 local $SIG{TSTP} = 'IGNORE';
914 local $SIG{PIPE} = 'IGNORE';
916 my $oldAutoCommit = $FS::UID::AutoCommit;
917 local $FS::UID::AutoCommit = 0;
920 # find the packages which are due for billing, find out how much they are
921 # & generate invoice database.
923 my( $total_setup, $total_recur ) = ( 0, 0 );
924 #my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
925 my @cust_bill_pkg = ();
927 #my $taxable_charged = 0;##
932 foreach my $cust_pkg (
933 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
936 #NO!! next if $cust_pkg->cancel;
937 next if $cust_pkg->getfield('cancel');
939 #? to avoid use of uninitialized value errors... ?
940 $cust_pkg->setfield('bill', '')
941 unless defined($cust_pkg->bill);
943 my $part_pkg = $cust_pkg->part_pkg;
945 #so we don't modify cust_pkg record unnecessarily
946 my $cust_pkg_mod_flag = 0;
947 my %hash = $cust_pkg->hash;
948 my $old_cust_pkg = new FS::cust_pkg \%hash;
952 unless ( $cust_pkg->setup ) {
953 my $setup_prog = $part_pkg->getfield('setup');
954 $setup_prog =~ /^(.*)$/ or do {
955 $dbh->rollback if $oldAutoCommit;
956 return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
962 ##$cpt->permit(); #what is necessary?
963 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
964 #$setup = $cpt->reval($setup_prog);
965 $setup = eval $setup_prog;
966 unless ( defined($setup) ) {
967 $dbh->rollback if $oldAutoCommit;
968 return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
969 "(expression $setup_prog): $@";
971 $cust_pkg->setfield('setup',$time);
972 $cust_pkg_mod_flag=1;
978 if ( $part_pkg->getfield('freq') > 0 &&
979 ! $cust_pkg->getfield('susp') &&
980 ( $cust_pkg->getfield('bill') || 0 ) < $time
982 my $recur_prog = $part_pkg->getfield('recur');
983 $recur_prog =~ /^(.*)$/ or do {
984 $dbh->rollback if $oldAutoCommit;
985 return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
990 # shared with $recur_prog
991 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
994 ##$cpt->permit(); #what is necessary?
995 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
996 #$recur = $cpt->reval($recur_prog);
997 $recur = eval $recur_prog;
998 unless ( defined($recur) ) {
999 $dbh->rollback if $oldAutoCommit;
1000 return "Error eval-ing part_pkg->recur pkgpart ". $part_pkg->pkgpart.
1001 "(expression $recur_prog): $@";
1003 #change this bit to use Date::Manip? CAREFUL with timezones (see
1004 # mailing list archive)
1005 my ($sec,$min,$hour,$mday,$mon,$year) =
1006 (localtime($sdate) )[0,1,2,3,4,5];
1008 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1009 # only for figuring next bill date, nothing else, so, reset $sdate again
1011 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1013 $mon += $part_pkg->freq;
1014 until ( $mon < 12 ) { $mon -= 12; $year++; }
1015 $cust_pkg->setfield('bill',
1016 timelocal($sec,$min,$hour,$mday,$mon,$year));
1017 $cust_pkg_mod_flag = 1;
1020 warn "\$setup is undefined" unless defined($setup);
1021 warn "\$recur is undefined" unless defined($recur);
1022 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1024 my $taxable_charged = 0;
1025 if ( $cust_pkg_mod_flag ) {
1026 $error=$cust_pkg->replace($old_cust_pkg);
1027 if ( $error ) { #just in case
1028 $dbh->rollback if $oldAutoCommit;
1029 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1031 $setup = sprintf( "%.2f", $setup );
1032 $recur = sprintf( "%.2f", $recur );
1034 $dbh->rollback if $oldAutoCommit;
1035 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1038 $dbh->rollback if $oldAutoCommit;
1039 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1041 if ( $setup > 0 || $recur > 0 ) {
1042 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1043 'pkgnum' => $cust_pkg->pkgnum,
1047 'edate' => $cust_pkg->bill,
1049 push @cust_bill_pkg, $cust_bill_pkg;
1050 $total_setup += $setup;
1051 $total_recur += $recur;
1052 $taxable_charged += $setup
1053 unless $part_pkg->setuptax =~ /^Y$/i;
1054 $taxable_charged += $recur
1055 unless $part_pkg->recurtax =~ /^Y$/i;
1057 unless ( $self->tax =~ /Y/i
1058 || $self->payby eq 'COMP'
1059 || $taxable_charged == 0 ) {
1061 my $cust_main_county = qsearchs('cust_main_county',{
1062 'state' => $self->state,
1063 'county' => $self->county,
1064 'country' => $self->country,
1065 'taxclass' => $part_pkg->taxclass,
1067 $cust_main_county ||= qsearchs('cust_main_county',{
1068 'state' => $self->state,
1069 'county' => $self->county,
1070 'country' => $self->country,
1073 unless ( $cust_main_county ) {
1074 $dbh->rollback if $oldAutoCommit;
1076 "fatal: can't find tax rate for state/county/country/taxclass ".
1077 join('/', ( map $self->$_(), qw(state county country) ),
1078 $part_pkg->taxclass ). "\n";
1081 if ( $cust_main_county->exempt_amount ) {
1082 my ($mon,$year) = (localtime($sdate) )[4,5];
1084 my $freq = $part_pkg->freq || 1;
1085 my $taxable_per_month = sprintf("%.2f", $taxable_charged / $freq );
1086 foreach my $which_month ( 1 .. $freq ) {
1088 'custnum' => $self->custnum,
1089 'taxnum' => $cust_main_county->taxnum,
1090 'year' => 1900+$year,
1093 #until ( $mon < 12 ) { $mon -= 12; $year++; }
1094 until ( $mon < 13 ) { $mon -= 12; $year++; }
1095 my $cust_tax_exempt =
1096 qsearchs('cust_tax_exempt', \%hash)
1097 || new FS::cust_tax_exempt( { %hash, 'amount' => 0 } );
1098 my $remaining_exemption = sprintf("%.2f",
1099 $cust_main_county->exempt_amount - $cust_tax_exempt->amount );
1100 if ( $remaining_exemption > 0 ) {
1101 my $addl = $remaining_exemption > $taxable_per_month
1102 ? $taxable_per_month
1103 : $remaining_exemption;
1104 $taxable_charged -= $addl;
1105 my $new_cust_tax_exempt = new FS::cust_tax_exempt ( {
1106 $cust_tax_exempt->hash,
1107 'amount' => sprintf("%.2f", $cust_tax_exempt->amount + $addl),
1109 $error = $new_cust_tax_exempt->exemptnum
1110 ? $new_cust_tax_exempt->replace($cust_tax_exempt)
1111 : $new_cust_tax_exempt->insert;
1113 $dbh->rollback if $oldAutoCommit;
1114 return "fatal: can't update cust_tax_exempt: $error";
1117 } # if $remaining_exemption > 0
1119 } #foreach $which_month
1121 } #if $cust_main_county->exempt_amount
1123 $taxable_charged = sprintf( "%.2f", $taxable_charged);
1125 #$tax += $taxable_charged * $cust_main_county->tax / 100
1126 $tax{ $cust_main_county->taxname || 'Tax' } +=
1127 $taxable_charged * $cust_main_county->tax / 100
1129 } #unless $self->tax =~ /Y/i
1130 # || $self->payby eq 'COMP'
1131 # || $taxable_charged == 0
1133 } #if $setup > 0 || $recur > 0
1135 } #if $cust_pkg_mod_flag
1137 } #foreach my $cust_pkg
1139 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
1140 # my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
1142 unless ( @cust_bill_pkg ) { #don't create invoices with no line items
1143 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 # unless ( $self->tax =~ /Y/i
1148 # || $self->payby eq 'COMP'
1149 # || $taxable_charged == 0 ) {
1150 # my $cust_main_county = qsearchs('cust_main_county',{
1151 # 'state' => $self->state,
1152 # 'county' => $self->county,
1153 # 'country' => $self->country,
1154 # } ) or die "fatal: can't find tax rate for state/county/country ".
1155 # $self->state. "/". $self->county. "/". $self->country. "\n";
1156 # my $tax = sprintf( "%.2f",
1157 # $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1160 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
1161 my $tax = sprintf("%.2f", $tax{$taxname} );
1162 $charged = sprintf( "%.2f", $charged+$tax );
1164 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1170 'itemdesc' => $taxname,
1172 push @cust_bill_pkg, $cust_bill_pkg;
1176 my $cust_bill = new FS::cust_bill ( {
1177 'custnum' => $self->custnum,
1179 'charged' => $charged,
1181 $error = $cust_bill->insert;
1183 $dbh->rollback if $oldAutoCommit;
1184 return "can't create invoice for customer #". $self->custnum. ": $error";
1187 my $invnum = $cust_bill->invnum;
1189 foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1191 $cust_bill_pkg->invnum($invnum);
1192 $error = $cust_bill_pkg->insert;
1194 $dbh->rollback if $oldAutoCommit;
1195 return "can't create invoice line item for customer #". $self->custnum.
1200 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1204 =item collect OPTIONS
1206 (Attempt to) collect money for this customer's outstanding invoices (see
1207 L<FS::cust_bill>). Usually used after the bill method.
1209 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1210 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1212 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1213 and the invoice events web interface.
1215 If there is an error, returns the error, otherwise returns false.
1217 Options are passed as name-value pairs.
1219 Currently available options are:
1221 invoice_time - Use this time when deciding when to print invoices and
1222 late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse>
1223 for conversion functions.
1225 retry_card - Retry cards even when not scheduled by invoice events.
1227 batch_card - This option is deprecated. See the invoice events web interface
1228 to control whether cards are batched or run against a realtime gateway.
1230 report_badcard - This option is deprecated.
1232 force_print - This option is deprecated; see the invoice events web interface.
1237 my( $self, %options ) = @_;
1238 my $invoice_time = $options{'invoice_time'} || time;
1241 local $SIG{HUP} = 'IGNORE';
1242 local $SIG{INT} = 'IGNORE';
1243 local $SIG{QUIT} = 'IGNORE';
1244 local $SIG{TERM} = 'IGNORE';
1245 local $SIG{TSTP} = 'IGNORE';
1246 local $SIG{PIPE} = 'IGNORE';
1248 my $oldAutoCommit = $FS::UID::AutoCommit;
1249 local $FS::UID::AutoCommit = 0;
1252 my $balance = $self->balance;
1253 warn "collect customer". $self->custnum. ": balance $balance" if $Debug;
1254 unless ( $balance > 0 ) { #redundant?????
1255 $dbh->rollback if $oldAutoCommit; #hmm
1259 if ( exists($options{'retry_card'}) && $options{'retry_card'} ) {
1260 #false laziness w/replace
1261 foreach my $cust_bill_event (
1263 #$_->part_bill_event->plan eq 'realtime-card'
1264 $_->part_bill_event->eventcode eq '$cust_bill->realtime_card();'
1265 && $_->status eq 'done'
1268 map { $_->cust_bill_event }
1269 grep { $_->cust_bill_event }
1270 $self->open_cust_bill
1272 my $error = $cust_bill_event->retry;
1274 $dbh->rollback if $oldAutoCommit;
1275 return "error scheduling invoice events for retry: $error";
1281 foreach my $cust_bill ( $self->cust_bill ) {
1283 #this has to be before next's
1284 my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1288 $balance = sprintf( "%.2f", $balance - $amount );
1290 next unless $cust_bill->owed > 0;
1292 # don't try to charge for the same invoice if it's already in a batch
1293 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1295 warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1297 next unless $amount > 0;
1300 foreach my $part_bill_event (
1301 sort { $a->seconds <=> $b->seconds
1302 || $a->weight <=> $b->weight
1303 || $a->eventpart <=> $b->eventpart }
1304 grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
1305 && ! qsearchs( 'cust_bill_event', {
1306 'invnum' => $cust_bill->invnum,
1307 'eventpart' => $_->eventpart,
1311 qsearch('part_bill_event', { 'payby' => $self->payby,
1312 'disabled' => '', } )
1315 last unless $cust_bill->owed > 0; #don't run subsequent events if owed=0
1317 warn "calling invoice event (". $part_bill_event->eventcode. ")\n"
1319 my $cust_main = $self; #for callback
1320 my $error = eval $part_bill_event->eventcode;
1323 my $statustext = '';
1327 } elsif ( $error ) {
1329 $statustext = $error;
1334 #add cust_bill_event
1335 my $cust_bill_event = new FS::cust_bill_event {
1336 'invnum' => $cust_bill->invnum,
1337 'eventpart' => $part_bill_event->eventpart,
1338 #'_date' => $invoice_time,
1340 'status' => $status,
1341 'statustext' => $statustext,
1343 $error = $cust_bill_event->insert;
1345 #$dbh->rollback if $oldAutoCommit;
1346 #return "error: $error";
1348 # gah, even with transactions.
1349 $dbh->commit if $oldAutoCommit; #well.
1350 my $e = 'WARNING: Event run but database not updated - '.
1351 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1352 ', eventpart '. $part_bill_event->eventpart.
1363 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1370 Returns the total owed for this customer on all invoices
1371 (see L<FS::cust_bill/owed>).
1377 $self->total_owed_date(2145859200); #12/31/2037
1380 =item total_owed_date TIME
1382 Returns the total owed for this customer on all invoices with date earlier than
1383 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
1384 see L<Time::Local> and L<Date::Parse> for conversion functions.
1388 sub total_owed_date {
1392 foreach my $cust_bill (
1393 grep { $_->_date <= $time }
1394 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1396 $total_bill += $cust_bill->owed;
1398 sprintf( "%.2f", $total_bill );
1403 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1404 to outstanding invoice balances in chronological order and returns the value
1405 of any remaining unapplied credits available for refund
1406 (see L<FS::cust_refund>).
1413 return 0 unless $self->total_credited;
1415 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1416 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1418 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1419 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1423 foreach my $cust_bill ( @invoices ) {
1426 if ( !defined($credit) || $credit->credited == 0) {
1427 $credit = pop @credits or last;
1430 if ($cust_bill->owed >= $credit->credited) {
1431 $amount=$credit->credited;
1433 $amount=$cust_bill->owed;
1436 my $cust_credit_bill = new FS::cust_credit_bill ( {
1437 'crednum' => $credit->crednum,
1438 'invnum' => $cust_bill->invnum,
1439 'amount' => $amount,
1441 my $error = $cust_credit_bill->insert;
1442 die $error if $error;
1444 redo if ($cust_bill->owed > 0);
1448 return $self->total_credited;
1451 =item apply_payments
1453 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1454 to outstanding invoice balances in chronological order.
1456 #and returns the value of any remaining unapplied payments.
1460 sub apply_payments {
1465 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1466 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1468 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1469 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1473 foreach my $cust_bill ( @invoices ) {
1476 if ( !defined($payment) || $payment->unapplied == 0 ) {
1477 $payment = pop @payments or last;
1480 if ( $cust_bill->owed >= $payment->unapplied ) {
1481 $amount = $payment->unapplied;
1483 $amount = $cust_bill->owed;
1486 my $cust_bill_pay = new FS::cust_bill_pay ( {
1487 'paynum' => $payment->paynum,
1488 'invnum' => $cust_bill->invnum,
1489 'amount' => $amount,
1491 my $error = $cust_bill_pay->insert;
1492 die $error if $error;
1494 redo if ( $cust_bill->owed > 0);
1498 return $self->total_unapplied_payments;
1501 =item total_credited
1503 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1504 customer. See L<FS::cust_credit/credited>.
1508 sub total_credited {
1510 my $total_credit = 0;
1511 foreach my $cust_credit ( qsearch('cust_credit', {
1512 'custnum' => $self->custnum,
1514 $total_credit += $cust_credit->credited;
1516 sprintf( "%.2f", $total_credit );
1519 =item total_unapplied_payments
1521 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1522 See L<FS::cust_pay/unapplied>.
1526 sub total_unapplied_payments {
1528 my $total_unapplied = 0;
1529 foreach my $cust_pay ( qsearch('cust_pay', {
1530 'custnum' => $self->custnum,
1532 $total_unapplied += $cust_pay->unapplied;
1534 sprintf( "%.2f", $total_unapplied );
1539 Returns the balance for this customer (total_owed minus total_credited
1540 minus total_unapplied_payments).
1547 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1551 =item balance_date TIME
1553 Returns the balance for this customer, only considering invoices with date
1554 earlier than TIME (total_owed_date minus total_credited minus
1555 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
1556 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
1565 $self->total_owed_date($time)
1566 - $self->total_credited
1567 - $self->total_unapplied_payments
1571 =item invoicing_list [ ARRAYREF ]
1573 If an arguement is given, sets these email addresses as invoice recipients
1574 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
1575 (except as warnings), so use check_invoicing_list first.
1577 Returns a list of email addresses (with svcnum entries expanded).
1579 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
1580 check it without disturbing anything by passing nothing.
1582 This interface may change in the future.
1586 sub invoicing_list {
1587 my( $self, $arrayref ) = @_;
1589 my @cust_main_invoice;
1590 if ( $self->custnum ) {
1591 @cust_main_invoice =
1592 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1594 @cust_main_invoice = ();
1596 foreach my $cust_main_invoice ( @cust_main_invoice ) {
1597 #warn $cust_main_invoice->destnum;
1598 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1599 #warn $cust_main_invoice->destnum;
1600 my $error = $cust_main_invoice->delete;
1601 warn $error if $error;
1604 if ( $self->custnum ) {
1605 @cust_main_invoice =
1606 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1608 @cust_main_invoice = ();
1610 my %seen = map { $_->address => 1 } @cust_main_invoice;
1611 foreach my $address ( @{$arrayref} ) {
1612 next if exists $seen{$address} && $seen{$address};
1613 $seen{$address} = 1;
1614 my $cust_main_invoice = new FS::cust_main_invoice ( {
1615 'custnum' => $self->custnum,
1618 my $error = $cust_main_invoice->insert;
1619 warn $error if $error;
1622 if ( $self->custnum ) {
1624 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1630 =item check_invoicing_list ARRAYREF
1632 Checks these arguements as valid input for the invoicing_list method. If there
1633 is an error, returns the error, otherwise returns false.
1637 sub check_invoicing_list {
1638 my( $self, $arrayref ) = @_;
1639 foreach my $address ( @{$arrayref} ) {
1640 my $cust_main_invoice = new FS::cust_main_invoice ( {
1641 'custnum' => $self->custnum,
1644 my $error = $self->custnum
1645 ? $cust_main_invoice->check
1646 : $cust_main_invoice->checkdest
1648 return $error if $error;
1653 =item set_default_invoicing_list
1655 Sets the invoicing list to all accounts associated with this customer,
1656 overwriting any previous invoicing list.
1660 sub set_default_invoicing_list {
1662 $self->invoicing_list($self->all_emails);
1667 Returns the email addresses of all accounts provisioned for this customer.
1674 foreach my $cust_pkg ( $self->all_pkgs ) {
1675 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1677 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1678 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1680 $list{$_}=1 foreach map { $_->email } @svc_acct;
1685 =item invoicing_list_addpost
1687 Adds postal invoicing to this customer. If this customer is already configured
1688 to receive postal invoices, does nothing.
1692 sub invoicing_list_addpost {
1694 return if grep { $_ eq 'POST' } $self->invoicing_list;
1695 my @invoicing_list = $self->invoicing_list;
1696 push @invoicing_list, 'POST';
1697 $self->invoicing_list(\@invoicing_list);
1700 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1702 Returns an array of customers referred by this customer (referral_custnum set
1703 to this custnum). If DEPTH is given, recurses up to the given depth, returning
1704 customers referred by customers referred by this customer and so on, inclusive.
1705 The default behavior is DEPTH 1 (no recursion).
1709 sub referral_cust_main {
1711 my $depth = @_ ? shift : 1;
1712 my $exclude = @_ ? shift : {};
1715 map { $exclude->{$_->custnum}++; $_; }
1716 grep { ! $exclude->{ $_->custnum } }
1717 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1721 map { $_->referral_cust_main($depth-1, $exclude) }
1728 =item referral_cust_main_ncancelled
1730 Same as referral_cust_main, except only returns customers with uncancelled
1735 sub referral_cust_main_ncancelled {
1737 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
1740 =item referral_cust_pkg [ DEPTH ]
1742 Like referral_cust_main, except returns a flat list of all unsuspended (and
1743 uncancelled) packages for each customer. The number of items in this list may
1744 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
1748 sub referral_cust_pkg {
1750 my $depth = @_ ? shift : 1;
1752 map { $_->unsuspended_pkgs }
1753 grep { $_->unsuspended_pkgs }
1754 $self->referral_cust_main($depth);
1757 =item credit AMOUNT, REASON
1759 Applies a credit to this customer. If there is an error, returns the error,
1760 otherwise returns false.
1765 my( $self, $amount, $reason ) = @_;
1766 my $cust_credit = new FS::cust_credit {
1767 'custnum' => $self->custnum,
1768 'amount' => $amount,
1769 'reason' => $reason,
1771 $cust_credit->insert;
1774 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
1776 Creates a one-time charge for this customer. If there is an error, returns
1777 the error, otherwise returns false.
1782 my ( $self, $amount ) = ( shift, shift );
1783 my $pkg = @_ ? shift : 'One-time charge';
1784 my $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
1785 my $taxclass = @_ ? shift : '';
1787 local $SIG{HUP} = 'IGNORE';
1788 local $SIG{INT} = 'IGNORE';
1789 local $SIG{QUIT} = 'IGNORE';
1790 local $SIG{TERM} = 'IGNORE';
1791 local $SIG{TSTP} = 'IGNORE';
1792 local $SIG{PIPE} = 'IGNORE';
1794 my $oldAutoCommit = $FS::UID::AutoCommit;
1795 local $FS::UID::AutoCommit = 0;
1798 my $part_pkg = new FS::part_pkg ( {
1800 'comment' => $comment,
1805 'taxclass' => $taxclass,
1808 my $error = $part_pkg->insert;
1810 $dbh->rollback if $oldAutoCommit;
1814 my $pkgpart = $part_pkg->pkgpart;
1815 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
1816 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
1817 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
1818 $error = $type_pkgs->insert;
1820 $dbh->rollback if $oldAutoCommit;
1825 my $cust_pkg = new FS::cust_pkg ( {
1826 'custnum' => $self->custnum,
1827 'pkgpart' => $pkgpart,
1830 $error = $cust_pkg->insert;
1832 $dbh->rollback if $oldAutoCommit;
1836 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1843 Returns all the invoices (see L<FS::cust_bill>) for this customer.
1849 sort { $a->_date <=> $b->_date }
1850 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1853 =item open_cust_bill
1855 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
1860 sub open_cust_bill {
1862 grep { $_->owed > 0 } $self->cust_bill;
1871 =item check_and_rebuild_fuzzyfiles
1875 sub check_and_rebuild_fuzzyfiles {
1876 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1877 -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1878 or &rebuild_fuzzyfiles;
1881 =item rebuild_fuzzyfiles
1885 sub rebuild_fuzzyfiles {
1887 use Fcntl qw(:flock);
1889 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1893 open(LASTLOCK,">>$dir/cust_main.last")
1894 or die "can't open $dir/cust_main.last: $!";
1895 flock(LASTLOCK,LOCK_EX)
1896 or die "can't lock $dir/cust_main.last: $!";
1898 my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1900 grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1901 if defined dbdef->table('cust_main')->column('ship_last');
1903 open (LASTCACHE,">$dir/cust_main.last.tmp")
1904 or die "can't open $dir/cust_main.last.tmp: $!";
1905 print LASTCACHE join("\n", @all_last), "\n";
1906 close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1908 rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1913 open(COMPANYLOCK,">>$dir/cust_main.company")
1914 or die "can't open $dir/cust_main.company: $!";
1915 flock(COMPANYLOCK,LOCK_EX)
1916 or die "can't lock $dir/cust_main.company: $!";
1918 my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1920 grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1921 if defined dbdef->table('cust_main')->column('ship_last');
1923 open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1924 or die "can't open $dir/cust_main.company.tmp: $!";
1925 print COMPANYCACHE join("\n", @all_company), "\n";
1926 close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1928 rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1938 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1939 open(LASTCACHE,"<$dir/cust_main.last")
1940 or die "can't open $dir/cust_main.last: $!";
1941 my @array = map { chomp; $_; } <LASTCACHE>;
1951 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1952 open(COMPANYCACHE,"<$dir/cust_main.company")
1953 or die "can't open $dir/cust_main.last: $!";
1954 my @array = map { chomp; $_; } <COMPANYCACHE>;
1959 =item append_fuzzyfiles LASTNAME COMPANY
1963 sub append_fuzzyfiles {
1964 my( $last, $company ) = @_;
1966 &check_and_rebuild_fuzzyfiles;
1968 use Fcntl qw(:flock);
1970 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1974 open(LAST,">>$dir/cust_main.last")
1975 or die "can't open $dir/cust_main.last: $!";
1977 or die "can't lock $dir/cust_main.last: $!";
1979 print LAST "$last\n";
1982 or die "can't unlock $dir/cust_main.last: $!";
1988 open(COMPANY,">>$dir/cust_main.company")
1989 or die "can't open $dir/cust_main.company: $!";
1990 flock(COMPANY,LOCK_EX)
1991 or die "can't lock $dir/cust_main.company: $!";
1993 print COMPANY "$company\n";
1995 flock(COMPANY,LOCK_UN)
1996 or die "can't unlock $dir/cust_main.company: $!";
2010 #warn join('-',keys %$param);
2011 my $fh = $param->{filehandle};
2012 my $agentnum = $param->{agentnum};
2013 my $refnum = $param->{refnum};
2014 my $pkgpart = $param->{pkgpart};
2015 my @fields = @{$param->{fields}};
2017 eval "use Date::Parse;";
2019 eval "use Text::CSV_XS;";
2022 my $csv = new Text::CSV_XS;
2029 local $SIG{HUP} = 'IGNORE';
2030 local $SIG{INT} = 'IGNORE';
2031 local $SIG{QUIT} = 'IGNORE';
2032 local $SIG{TERM} = 'IGNORE';
2033 local $SIG{TSTP} = 'IGNORE';
2034 local $SIG{PIPE} = 'IGNORE';
2036 my $oldAutoCommit = $FS::UID::AutoCommit;
2037 local $FS::UID::AutoCommit = 0;
2040 #while ( $columns = $csv->getline($fh) ) {
2042 while ( defined($line=<$fh>) ) {
2044 $csv->parse($line) or do {
2045 $dbh->rollback if $oldAutoCommit;
2046 return "can't parse: ". $csv->error_input();
2049 my @columns = $csv->fields();
2050 #warn join('-',@columns);
2053 agentnum => $agentnum,
2055 country => 'US', #default
2056 payby => 'BILL', #default
2057 paydate => '12/2037', #default
2059 my $billtime = time;
2060 my %cust_pkg = ( pkgpart => $pkgpart );
2061 foreach my $field ( @fields ) {
2062 if ( $field =~ /^cust_pkg\.(setup|bill|susp|expire|cancel)$/ ) {
2063 #$cust_pkg{$1} = str2time( shift @$columns );
2064 if ( $1 eq 'setup' ) {
2065 $billtime = str2time(shift @columns);
2067 $cust_pkg{$1} = str2time( shift @columns );
2070 #$cust_main{$field} = shift @$columns;
2071 $cust_main{$field} = shift @columns;
2075 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg ) if $pkgpart;
2076 my $cust_main = new FS::cust_main ( \%cust_main );
2078 tie my %hash, 'Tie::RefHash'; #this part is important
2079 $hash{$cust_pkg} = [] if $pkgpart;
2080 my $error = $cust_main->insert( \%hash );
2083 $dbh->rollback if $oldAutoCommit;
2084 return "can't insert customer for $line: $error";
2087 #false laziness w/bill.cgi
2088 $error = $cust_main->bill( 'time' => $billtime );
2090 $dbh->rollback if $oldAutoCommit;
2091 return "can't bill customer for $line: $error";
2094 $cust_main->apply_payments;
2095 $cust_main->apply_credits;
2097 $error = $cust_main->collect();
2099 $dbh->rollback if $oldAutoCommit;
2100 return "can't collect customer for $line: $error";
2106 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2108 return "Empty file!" unless $imported;
2120 #warn join('-',keys %$param);
2121 my $fh = $param->{filehandle};
2122 my @fields = @{$param->{fields}};
2124 eval "use Date::Parse;";
2126 eval "use Text::CSV_XS;";
2129 my $csv = new Text::CSV_XS;
2136 local $SIG{HUP} = 'IGNORE';
2137 local $SIG{INT} = 'IGNORE';
2138 local $SIG{QUIT} = 'IGNORE';
2139 local $SIG{TERM} = 'IGNORE';
2140 local $SIG{TSTP} = 'IGNORE';
2141 local $SIG{PIPE} = 'IGNORE';
2143 my $oldAutoCommit = $FS::UID::AutoCommit;
2144 local $FS::UID::AutoCommit = 0;
2147 #while ( $columns = $csv->getline($fh) ) {
2149 while ( defined($line=<$fh>) ) {
2151 $csv->parse($line) or do {
2152 $dbh->rollback if $oldAutoCommit;
2153 return "can't parse: ". $csv->error_input();
2156 my @columns = $csv->fields();
2157 #warn join('-',@columns);
2160 foreach my $field ( @fields ) {
2161 $row{$field} = shift @columns;
2164 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
2165 unless ( $cust_main ) {
2166 $dbh->rollback if $oldAutoCommit;
2167 return "unknown custnum $row{'custnum'}";
2170 if ( $row{'amount'} > 0 ) {
2171 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
2173 $dbh->rollback if $oldAutoCommit;
2177 } elsif ( $row{'amount'} < 0 ) {
2178 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
2181 $dbh->rollback if $oldAutoCommit;
2191 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2193 return "Empty file!" unless $imported;
2205 The delete method should possibly take an FS::cust_main object reference
2206 instead of a scalar customer number.
2208 Bill and collect options should probably be passed as references instead of a
2211 There should probably be a configuration file with a list of allowed credit
2214 No multiple currency support (probably a larger project than just this module).
2218 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
2219 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
2220 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.