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;
30 @ISA = qw( FS::Record );
37 #ask FS::UID to run this stuff for us later
38 $FS::UID::callback{'FS::cust_main'} = sub {
40 #yes, need it for stuff below (prolly should be cached)
45 my ( $hashref, $cache ) = @_;
46 if ( exists $hashref->{'pkgnum'} ) {
47 # #@{ $self->{'_pkgnum'} } = ();
48 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
49 $self->{'_pkgnum'} = $subcache;
50 #push @{ $self->{'_pkgnum'} },
51 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
57 FS::cust_main - Object methods for cust_main records
63 $record = new FS::cust_main \%hash;
64 $record = new FS::cust_main { 'column' => 'value' };
66 $error = $record->insert;
68 $error = $new_record->replace($old_record);
70 $error = $record->delete;
72 $error = $record->check;
74 @cust_pkg = $record->all_pkgs;
76 @cust_pkg = $record->ncancelled_pkgs;
78 @cust_pkg = $record->suspended_pkgs;
80 $error = $record->bill;
81 $error = $record->bill %options;
82 $error = $record->bill 'time' => $time;
84 $error = $record->collect;
85 $error = $record->collect %options;
86 $error = $record->collect 'invoice_time' => $time,
87 'batch_card' => 'yes',
88 'report_badcard' => 'yes',
93 An FS::cust_main object represents a customer. FS::cust_main inherits from
94 FS::Record. The following fields are currently supported:
98 =item custnum - primary key (assigned automatically for new customers)
100 =item agentnum - agent (see L<FS::agent>)
102 =item refnum - referral (see L<FS::part_referral>)
108 =item ss - social security number (optional)
110 =item company - (optional)
114 =item address2 - (optional)
118 =item county - (optional, see L<FS::cust_main_county>)
120 =item state - (see L<FS::cust_main_county>)
124 =item country - (see L<FS::cust_main_county>)
126 =item daytime - phone (optional)
128 =item night - phone (optional)
130 =item fax - phone (optional)
132 =item ship_first - name
134 =item ship_last - name
136 =item ship_company - (optional)
140 =item ship_address2 - (optional)
144 =item ship_county - (optional, see L<FS::cust_main_county>)
146 =item ship_state - (see L<FS::cust_main_county>)
150 =item ship_country - (see L<FS::cust_main_county>)
152 =item ship_daytime - phone (optional)
154 =item ship_night - phone (optional)
156 =item ship_fax - phone (optional)
158 =item payby - `CARD' (credit cards), `BILL' (billing), `COMP' (free), or `PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to BILL)
160 =item payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
162 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
164 =item payname - name on card or billing name
166 =item tax - tax exempt, empty or `Y'
168 =item otaker - order taker (assigned automatically, see L<FS::UID>)
170 =item comments - comments (optional)
180 Creates a new customer. To add the customer to the database, see L<"insert">.
182 Note that this stores the hash reference, not a distinct copy of the hash it
183 points to. You can ask the object for a copy with the I<hash> method.
187 sub table { 'cust_main'; }
189 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] ]
191 Adds this customer to the database. If there is an error, returns the error,
192 otherwise returns false.
194 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
195 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
196 are inserted atomicly, or the transaction is rolled back. Passing an empty
197 hash reference is equivalent to not supplying this parameter. There should be
198 a better explanation of this, but until then, here's an example:
201 tie %hash, 'Tie::RefHash'; #this part is important
203 $cust_pkg => [ $svc_acct ],
206 $cust_main->insert( \%hash );
208 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
209 be set as the invoicing list (see L<"invoicing_list">). Errors return as
210 expected and rollback the entire transaction; it is not necessary to call
211 check_invoicing_list first. The invoicing_list is set after the records in the
212 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
213 invoicing_list destination to the newly-created svc_acct. Here's an example:
215 $cust_main->insert( {}, [ $email, 'POST' ] );
223 local $SIG{HUP} = 'IGNORE';
224 local $SIG{INT} = 'IGNORE';
225 local $SIG{QUIT} = 'IGNORE';
226 local $SIG{TERM} = 'IGNORE';
227 local $SIG{TSTP} = 'IGNORE';
228 local $SIG{PIPE} = 'IGNORE';
230 my $oldAutoCommit = $FS::UID::AutoCommit;
231 local $FS::UID::AutoCommit = 0;
236 if ( $self->payby eq 'PREPAY' ) {
237 $self->payby('BILL');
238 my $prepay_credit = qsearchs(
240 { 'identifier' => $self->payinfo },
244 warn "WARNING: can't find pre-found prepay_credit: ". $self->payinfo
245 unless $prepay_credit;
246 $amount = $prepay_credit->amount;
247 $seconds = $prepay_credit->seconds;
248 my $error = $prepay_credit->delete;
250 $dbh->rollback if $oldAutoCommit;
251 return "removing prepay_credit (transaction rolled back): $error";
255 my $error = $self->SUPER::insert;
257 $dbh->rollback if $oldAutoCommit;
258 return "inserting cust_main record (transaction rolled back): $error";
261 if ( @param ) { # CUST_PKG_HASHREF
262 my $cust_pkgs = shift @param;
263 foreach my $cust_pkg ( keys %$cust_pkgs ) {
264 $cust_pkg->custnum( $self->custnum );
265 $error = $cust_pkg->insert;
267 $dbh->rollback if $oldAutoCommit;
268 return "inserting cust_pkg (transaction rolled back): $error";
270 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
271 $svc_something->pkgnum( $cust_pkg->pkgnum );
272 if ( $seconds && $svc_something->isa('FS::svc_acct') ) {
273 $svc_something->seconds( $svc_something->seconds + $seconds );
276 $error = $svc_something->insert;
278 $dbh->rollback if $oldAutoCommit;
279 return "inserting svc_ (transaction rolled back): $error";
286 $dbh->rollback if $oldAutoCommit;
287 return "No svc_acct record to apply pre-paid time";
290 if ( @param ) { # INVOICING_LIST_ARYREF
291 my $invoicing_list = shift @param;
292 $error = $self->check_invoicing_list( $invoicing_list );
294 $dbh->rollback if $oldAutoCommit;
295 return "checking invoicing_list (transaction rolled back): $error";
297 $self->invoicing_list( $invoicing_list );
301 my $cust_credit = new FS::cust_credit {
302 'custnum' => $self->custnum,
305 $error = $cust_credit->insert;
307 $dbh->rollback if $oldAutoCommit;
308 return "inserting credit (transaction rolled back): $error";
312 #false laziness with sub replace
313 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
314 $error = $queue->insert($self->getfield('last'), $self->company);
316 $dbh->rollback if $oldAutoCommit;
317 return "queueing job (transaction rolled back): $error";
320 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
321 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
322 $error = $queue->insert($self->getfield('last'), $self->company);
324 $dbh->rollback if $oldAutoCommit;
325 return "queueing job (transaction rolled back): $error";
330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
335 =item delete NEW_CUSTNUM
337 This deletes the customer. If there is an error, returns the error, otherwise
340 This will completely remove all traces of the customer record. This is not
341 what you want when a customer cancels service; for that, cancel all of the
342 customer's packages (see L<FS::cust_pkg/cancel>).
344 If the customer has any uncancelled packages, you need to pass a new (valid)
345 customer number for those packages to be transferred to. Cancelled packages
346 will be deleted. Did I mention that this is NOT what you want when a customer
347 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
349 You can't delete a customer with invoices (see L<FS::cust_bill>),
350 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
351 refunds (see L<FS::cust_refund>).
358 local $SIG{HUP} = 'IGNORE';
359 local $SIG{INT} = 'IGNORE';
360 local $SIG{QUIT} = 'IGNORE';
361 local $SIG{TERM} = 'IGNORE';
362 local $SIG{TSTP} = 'IGNORE';
363 local $SIG{PIPE} = 'IGNORE';
365 my $oldAutoCommit = $FS::UID::AutoCommit;
366 local $FS::UID::AutoCommit = 0;
369 if ( qsearch( 'cust_bill', { 'custnum' => $self->custnum } ) ) {
370 $dbh->rollback if $oldAutoCommit;
371 return "Can't delete a customer with invoices";
373 if ( qsearch( 'cust_credit', { 'custnum' => $self->custnum } ) ) {
374 $dbh->rollback if $oldAutoCommit;
375 return "Can't delete a customer with credits";
377 if ( qsearch( 'cust_pay', { 'custnum' => $self->custnum } ) ) {
378 $dbh->rollback if $oldAutoCommit;
379 return "Can't delete a customer with payments";
381 if ( qsearch( 'cust_refund', { 'custnum' => $self->custnum } ) ) {
382 $dbh->rollback if $oldAutoCommit;
383 return "Can't delete a customer with refunds";
386 my @cust_pkg = $self->ncancelled_pkgs;
388 my $new_custnum = shift;
389 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
390 $dbh->rollback if $oldAutoCommit;
391 return "Invalid new customer number: $new_custnum";
393 foreach my $cust_pkg ( @cust_pkg ) {
394 my %hash = $cust_pkg->hash;
395 $hash{'custnum'} = $new_custnum;
396 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
397 my $error = $new_cust_pkg->replace($cust_pkg);
399 $dbh->rollback if $oldAutoCommit;
404 my @cancelled_cust_pkg = $self->all_pkgs;
405 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
406 my $error = $cust_pkg->delete;
408 $dbh->rollback if $oldAutoCommit;
413 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
414 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
416 my $error = $cust_main_invoice->delete;
418 $dbh->rollback if $oldAutoCommit;
423 my $error = $self->SUPER::delete;
425 $dbh->rollback if $oldAutoCommit;
429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
434 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
436 Replaces the OLD_RECORD with this one in the database. If there is an error,
437 returns the error, otherwise returns false.
439 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
440 be set as the invoicing list (see L<"invoicing_list">). Errors return as
441 expected and rollback the entire transaction; it is not necessary to call
442 check_invoicing_list first. Here's an example:
444 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
453 local $SIG{HUP} = 'IGNORE';
454 local $SIG{INT} = 'IGNORE';
455 local $SIG{QUIT} = 'IGNORE';
456 local $SIG{TERM} = 'IGNORE';
457 local $SIG{TSTP} = 'IGNORE';
458 local $SIG{PIPE} = 'IGNORE';
460 my $oldAutoCommit = $FS::UID::AutoCommit;
461 local $FS::UID::AutoCommit = 0;
464 my $error = $self->SUPER::replace($old);
467 $dbh->rollback if $oldAutoCommit;
471 if ( @param ) { # INVOICING_LIST_ARYREF
472 my $invoicing_list = shift @param;
473 $error = $self->check_invoicing_list( $invoicing_list );
475 $dbh->rollback if $oldAutoCommit;
478 $self->invoicing_list( $invoicing_list );
481 #false laziness with sub insert
482 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
483 $error = $queue->insert($self->getfield('last'), $self->company);
485 $dbh->rollback if $oldAutoCommit;
486 return "queueing job (transaction rolled back): $error";
489 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
490 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
491 $error = $queue->insert($self->getfield('last'), $self->company);
493 $dbh->rollback if $oldAutoCommit;
494 return "queueing job (transaction rolled back): $error";
499 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
506 Checks all fields to make sure this is a valid customer record. If there is
507 an error, returns the error, otherwise returns false. Called by the insert
516 $self->ut_numbern('custnum')
517 || $self->ut_number('agentnum')
518 || $self->ut_number('refnum')
519 || $self->ut_name('last')
520 || $self->ut_name('first')
521 || $self->ut_textn('company')
522 || $self->ut_text('address1')
523 || $self->ut_textn('address2')
524 || $self->ut_text('city')
525 || $self->ut_textn('county')
526 || $self->ut_textn('state')
527 || $self->ut_country('country')
528 || $self->ut_anything('comments')
529 || $self->ut_numbern('referral_custnum')
531 #barf. need message catalogs. i18n. etc.
532 $error .= "Please select a referral."
533 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
534 return $error if $error;
536 return "Unknown agent"
537 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
539 return "Unknown referral"
540 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
542 return "Unknown referring custnum ". $self->referral_custnum
543 unless ! $self->referral_custnum
544 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
546 if ( $self->ss eq '' ) {
551 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
552 or return "Illegal social security number: ". $self->ss;
553 $self->ss("$1-$2-$3");
557 unless ( qsearchs('cust_main_county', {
558 'country' => $self->country,
561 return "Unknown state/county/country: ".
562 $self->state. "/". $self->county. "/". $self->country
563 unless qsearchs('cust_main_county',{
564 'state' => $self->state,
565 'county' => $self->county,
566 'country' => $self->country,
572 $self->ut_phonen('daytime', $self->country)
573 || $self->ut_phonen('night', $self->country)
574 || $self->ut_phonen('fax', $self->country)
575 || $self->ut_zip('zip', $self->country)
577 return $error if $error;
580 last first company address1 address2 city county state zip
581 country daytime night fax
584 if ( defined $self->dbdef_table->column('ship_last') ) {
585 if ( grep { $self->getfield($_) ne $self->getfield("ship_$_") } @addfields
586 && grep $self->getfield("ship_$_"), grep $_ ne 'state', @addfields
590 $self->ut_name('ship_last')
591 || $self->ut_name('ship_first')
592 || $self->ut_textn('ship_company')
593 || $self->ut_text('ship_address1')
594 || $self->ut_textn('ship_address2')
595 || $self->ut_text('ship_city')
596 || $self->ut_textn('ship_county')
597 || $self->ut_textn('ship_state')
598 || $self->ut_country('ship_country')
600 return $error if $error;
602 #false laziness with above
603 unless ( qsearchs('cust_main_county', {
604 'country' => $self->ship_country,
607 return "Unknown ship_state/ship_county/ship_country: ".
608 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
609 unless qsearchs('cust_main_county',{
610 'state' => $self->ship_state,
611 'county' => $self->ship_county,
612 'country' => $self->ship_country,
618 $self->ut_phonen('ship_daytime', $self->ship_country)
619 || $self->ut_phonen('ship_night', $self->ship_country)
620 || $self->ut_phonen('ship_fax', $self->ship_country)
621 || $self->ut_zip('ship_zip', $self->ship_country)
623 return $error if $error;
625 } else { # ship_ info eq billing info, so don't store dup info in database
626 $self->setfield("ship_$_", '')
627 foreach qw( last first company address1 address2 city county state zip
628 country daytime night fax );
632 $self->payby =~ /^(CARD|BILL|COMP|PREPAY)$/
633 or return "Illegal payby: ". $self->payby;
636 if ( $self->payby eq 'CARD' ) {
638 my $payinfo = $self->payinfo;
640 $payinfo =~ /^(\d{13,16})$/
641 or return "Illegal credit card number: ". $self->payinfo;
643 $self->payinfo($payinfo);
645 or return "Illegal credit card number: ". $self->payinfo;
646 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
648 } elsif ( $self->payby eq 'BILL' ) {
650 $error = $self->ut_textn('payinfo');
651 return "Illegal P.O. number: ". $self->payinfo if $error;
653 } elsif ( $self->payby eq 'COMP' ) {
655 $error = $self->ut_textn('payinfo');
656 return "Illegal comp account issuer: ". $self->payinfo if $error;
658 } elsif ( $self->payby eq 'PREPAY' ) {
660 my $payinfo = $self->payinfo;
661 $payinfo =~ s/\W//g; #anything else would just confuse things
662 $self->payinfo($payinfo);
663 $error = $self->ut_alpha('payinfo');
664 return "Illegal prepayment identifier: ". $self->payinfo if $error;
665 return "Unknown prepayment identifier"
666 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
670 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
671 return "Expriation date required"
672 unless $self->payby eq 'BILL' || $self->payby eq 'PREPAY';
675 $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/
676 or return "Illegal expiration date: ". $self->paydate;
677 if ( length($2) == 4 ) {
678 $self->paydate("$2-$1-01");
680 $self->paydate("20$2-$1-01");
684 if ( $self->payname eq '' ) {
685 $self->payname( $self->first. " ". $self->getfield('last') );
687 $self->payname =~ /^([\w \,\.\-\']+)$/
688 or return "Illegal billing name: ". $self->payname;
692 $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
695 $self->otaker(getotaker);
702 Returns all packages (see L<FS::cust_pkg>) for this customer.
708 if ( $self->{'_pkgnum'} ) {
709 values %{ $self->{'_pkgnum'}->cache };
711 qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
715 =item ncancelled_pkgs
717 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
721 sub ncancelled_pkgs {
723 if ( $self->{'_pkgnum'} ) {
724 grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
726 @{ [ # force list context
727 qsearch( 'cust_pkg', {
728 'custnum' => $self->custnum,
731 qsearch( 'cust_pkg', {
732 'custnum' => $self->custnum,
741 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
747 grep { $_->susp } $self->ncancelled_pkgs;
750 =item unflagged_suspended_pkgs
752 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
753 customer (thouse packages without the `manual_flag' set).
757 sub unflagged_suspended_pkgs {
759 return $self->suspended_pkgs
760 unless dbdef->table('cust_pkg')->column('manual_flag');
761 grep { ! $_->manual_flag } $self->suspended_pkgs;
764 =item unsuspended_pkgs
766 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
771 sub unsuspended_pkgs {
773 grep { ! $_->susp } $self->ncancelled_pkgs;
778 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
779 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
780 on success or a list of errors.
786 grep { $_->unsuspend } $self->suspended_pkgs;
791 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
792 Always returns a list: an empty list on success or a list of errors.
798 grep { $_->suspend } $self->unsuspended_pkgs;
803 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
804 Always returns a list: an empty list on success or a list of errors.
810 grep { $_->cancel } $self->ncancelled_pkgs;
815 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
816 conjunction with the collect method.
818 Options are passed as name-value pairs.
820 The only currently available option is `time', which bills the customer as if
821 it were that time. It is specified as a UNIX timestamp; see
822 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
823 functions. For example:
827 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
829 If there is an error, returns the error, otherwise returns false.
834 my( $self, %options ) = @_;
835 my $time = $options{'time'} || time;
840 local $SIG{HUP} = 'IGNORE';
841 local $SIG{INT} = 'IGNORE';
842 local $SIG{QUIT} = 'IGNORE';
843 local $SIG{TERM} = 'IGNORE';
844 local $SIG{TSTP} = 'IGNORE';
845 local $SIG{PIPE} = 'IGNORE';
847 my $oldAutoCommit = $FS::UID::AutoCommit;
848 local $FS::UID::AutoCommit = 0;
851 # find the packages which are due for billing, find out how much they are
852 # & generate invoice database.
854 my( $total_setup, $total_recur ) = ( 0, 0 );
855 my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
856 my @cust_bill_pkg = ();
858 foreach my $cust_pkg (
859 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
862 #NO!! next if $cust_pkg->cancel;
863 next if $cust_pkg->getfield('cancel');
865 #? to avoid use of uninitialized value errors... ?
866 $cust_pkg->setfield('bill', '')
867 unless defined($cust_pkg->bill);
869 my $part_pkg = qsearchs( 'part_pkg', { 'pkgpart' => $cust_pkg->pkgpart } );
871 #so we don't modify cust_pkg record unnecessarily
872 my $cust_pkg_mod_flag = 0;
873 my %hash = $cust_pkg->hash;
874 my $old_cust_pkg = new FS::cust_pkg \%hash;
878 unless ( $cust_pkg->setup ) {
879 my $setup_prog = $part_pkg->getfield('setup');
880 $setup_prog =~ /^(.*)$/ or do {
881 $dbh->rollback if $oldAutoCommit;
882 return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
888 ##$cpt->permit(); #what is necessary?
889 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
890 #$setup = $cpt->reval($setup_prog);
891 $setup = eval $setup_prog;
892 unless ( defined($setup) ) {
893 $dbh->rollback if $oldAutoCommit;
894 return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
895 "(expression $setup_prog): $@";
897 $cust_pkg->setfield('setup',$time);
898 $cust_pkg_mod_flag=1;
904 if ( $part_pkg->getfield('freq') > 0 &&
905 ! $cust_pkg->getfield('susp') &&
906 ( $cust_pkg->getfield('bill') || 0 ) < $time
908 my $recur_prog = $part_pkg->getfield('recur');
909 $recur_prog =~ /^(.*)$/ or do {
910 $dbh->rollback if $oldAutoCommit;
911 return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
917 ##$cpt->permit(); #what is necessary?
918 #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
919 #$recur = $cpt->reval($recur_prog);
920 $recur = eval $recur_prog;
921 unless ( defined($recur) ) {
922 $dbh->rollback if $oldAutoCommit;
923 return "Error eval-ing part_pkg->recur pkgpart ". $part_pkg->pkgpart.
924 "(expression $recur_prog): $@";
926 #change this bit to use Date::Manip? CAREFUL with timezones (see
927 # mailing list archive)
928 #$sdate=$cust_pkg->bill || time;
929 #$sdate=$cust_pkg->bill || $time;
930 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
931 my ($sec,$min,$hour,$mday,$mon,$year) =
932 (localtime($sdate) )[0,1,2,3,4,5];
933 $mon += $part_pkg->getfield('freq');
934 until ( $mon < 12 ) { $mon -= 12; $year++; }
935 $cust_pkg->setfield('bill',
936 timelocal($sec,$min,$hour,$mday,$mon,$year));
937 $cust_pkg_mod_flag = 1;
940 warn "\$setup is undefined" unless defined($setup);
941 warn "\$recur is undefined" unless defined($recur);
942 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
944 if ( $cust_pkg_mod_flag ) {
945 $error=$cust_pkg->replace($old_cust_pkg);
946 if ( $error ) { #just in case
947 $dbh->rollback if $oldAutoCommit;
948 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
950 $setup = sprintf( "%.2f", $setup );
951 $recur = sprintf( "%.2f", $recur );
953 $dbh->rollback if $oldAutoCommit;
954 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
957 $dbh->rollback if $oldAutoCommit;
958 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
960 if ( $setup > 0 || $recur > 0 ) {
961 my $cust_bill_pkg = new FS::cust_bill_pkg ({
962 'pkgnum' => $cust_pkg->pkgnum,
966 'edate' => $cust_pkg->bill,
968 push @cust_bill_pkg, $cust_bill_pkg;
969 $total_setup += $setup;
970 $total_recur += $recur;
971 $taxable_setup += $setup
972 unless $part_pkg->dbdef_table->column('setuptax')
973 || $part_pkg->setuptax =~ /^Y$/i;
974 $taxable_recur += $recur
975 unless $part_pkg->dbdef_table->column('recurtax')
976 || $part_pkg->recurtax =~ /^Y$/i;
982 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
983 my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
985 unless ( @cust_bill_pkg ) {
986 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
990 unless ( $self->tax =~ /Y/i
991 || $self->payby eq 'COMP'
992 || $taxable_charged == 0 ) {
993 my $cust_main_county = qsearchs('cust_main_county',{
994 'state' => $self->state,
995 'county' => $self->county,
996 'country' => $self->country,
998 my $tax = sprintf( "%.2f",
999 $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1003 $charged = sprintf( "%.2f", $charged+$tax );
1005 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1012 push @cust_bill_pkg, $cust_bill_pkg;
1016 my $cust_bill = new FS::cust_bill ( {
1017 'custnum' => $self->custnum,
1019 'charged' => $charged,
1021 $error = $cust_bill->insert;
1023 $dbh->rollback if $oldAutoCommit;
1024 return "can't create invoice for customer #". $self->custnum. ": $error";
1027 my $invnum = $cust_bill->invnum;
1029 foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1031 $cust_bill_pkg->invnum($invnum);
1032 $error = $cust_bill_pkg->insert;
1034 $dbh->rollback if $oldAutoCommit;
1035 return "can't create invoice line item for customer #". $self->custnum.
1040 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1044 =item collect OPTIONS
1046 (Attempt to) collect money for this customer's outstanding invoices (see
1047 L<FS::cust_bill>). Usually used after the bill method.
1049 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1050 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1052 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1053 and the invoice events web interface.
1055 If there is an error, returns the error, otherwise returns false.
1057 Options are passed as name-value pairs.
1059 Currently available options are:
1061 invoice_time - Use this time when deciding when to print invoices and
1062 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>
1063 for conversion functions.
1065 batch_card - This option is deprecated. See the invoice events web interface
1066 to control whether cards are batched or run against a realtime gateway.
1068 report_badcard - This option is deprecated.
1070 force_print - This option is deprecated; see the invoice events web interface.
1075 my( $self, %options ) = @_;
1076 my $invoice_time = $options{'invoice_time'} || time;
1079 local $SIG{HUP} = 'IGNORE';
1080 local $SIG{INT} = 'IGNORE';
1081 local $SIG{QUIT} = 'IGNORE';
1082 local $SIG{TERM} = 'IGNORE';
1083 local $SIG{TSTP} = 'IGNORE';
1084 local $SIG{PIPE} = 'IGNORE';
1086 my $oldAutoCommit = $FS::UID::AutoCommit;
1087 local $FS::UID::AutoCommit = 0;
1090 my $balance = $self->balance;
1091 warn "collect: balance $balance" if $Debug;
1092 unless ( $balance > 0 ) { #redundant?????
1093 $dbh->rollback if $oldAutoCommit; #hmm
1097 foreach my $cust_bill (
1098 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1101 #this has to be before next's
1102 my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1106 $balance = sprintf( "%.2f", $balance - $amount );
1108 next unless $cust_bill->owed > 0;
1110 # don't try to charge for the same invoice if it's already in a batch
1111 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1113 warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1115 next unless $amount > 0;
1117 foreach my $part_bill_event (
1118 sort { $a->seconds <=> $b->seconds
1119 || $a->weight <=> $b->weight
1120 || $a->eventpart <=> $b->eventpart }
1121 grep { $_->seconds > ( $invoice_time - ( $cust_bill->_date || 0 ) )
1122 && ! qsearchs( 'cust_bill_event', {
1123 'invnum' => $cust_bill->invnum,
1124 'eventpart' => $_->eventpart } )
1126 qsearch('part_bill_event', { 'payby' => $self->payby,
1127 'disabled' => '', } )
1130 my $cust_main = $self; #for callback
1131 my $error = eval $part_bill_event->eventcode;
1135 warn "Error running invoice event (". $part_bill_event->eventcode.
1140 #add cust_bill_event
1141 my $cust_bill_event = new FS::cust_bill_event {
1142 'invnum' => $cust_bill->invnum,
1143 'eventpart' => $part_bill_event->eventpart,
1144 '_date' => $invoice_time,
1146 $cust_bill_event->insert;
1148 #$dbh->rollback if $oldAutoCommit;
1149 #return "error: $error";
1151 # gah, even with transactions.
1152 $dbh->commit if $oldAutoCommit; #well.
1153 my $e = 'WARNING: Event run but database not updated - '.
1154 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1155 ', eventpart '. $part_bill_event->eventpart.
1167 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1174 Returns the total owed for this customer on all invoices
1175 (see L<FS::cust_bill/owed>).
1181 $self->total_owed_date(2145859200); #12/31/2037
1184 =item total_owed_date TIME
1186 Returns the total owed for this customer on all invoices with date earlier than
1187 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
1188 see L<Time::Local> and L<Date::Parse> for conversion functions.
1192 sub total_owed_date {
1196 foreach my $cust_bill (
1197 grep { $_->_date <= $time }
1198 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1200 $total_bill += $cust_bill->owed;
1202 sprintf( "%.2f", $total_bill );
1207 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1208 to outstanding invoice balances in chronological order and returns the value
1209 of any remaining unapplied credits available for refund
1210 (see L<FS::cust_refund>).
1217 return 0 unless $self->total_credited;
1219 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1220 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1222 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1223 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1227 foreach my $cust_bill ( @invoices ) {
1230 if ( !defined($credit) || $credit->credited == 0) {
1231 $credit = pop @credits or last;
1234 if ($cust_bill->owed >= $credit->credited) {
1235 $amount=$credit->credited;
1237 $amount=$cust_bill->owed;
1240 my $cust_credit_bill = new FS::cust_credit_bill ( {
1241 'crednum' => $credit->crednum,
1242 'invnum' => $cust_bill->invnum,
1243 'amount' => $amount,
1245 my $error = $cust_credit_bill->insert;
1246 die $error if $error;
1248 redo if ($cust_bill->owed > 0);
1252 return $self->total_credited;
1255 =item apply_payments
1257 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1258 to outstanding invoice balances in chronological order.
1260 #and returns the value of any remaining unapplied payments.
1264 sub apply_payments {
1269 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1270 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1272 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1273 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1277 foreach my $cust_bill ( @invoices ) {
1280 if ( !defined($payment) || $payment->unapplied == 0 ) {
1281 $payment = pop @payments or last;
1284 if ( $cust_bill->owed >= $payment->unapplied ) {
1285 $amount = $payment->unapplied;
1287 $amount = $cust_bill->owed;
1290 my $cust_bill_pay = new FS::cust_bill_pay ( {
1291 'paynum' => $payment->paynum,
1292 'invnum' => $cust_bill->invnum,
1293 'amount' => $amount,
1295 my $error = $cust_bill_pay->insert;
1296 die $error if $error;
1298 redo if ( $cust_bill->owed > 0);
1302 return $self->total_unapplied_payments;
1305 =item total_credited
1307 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1308 customer. See L<FS::cust_credit/credited>.
1312 sub total_credited {
1314 my $total_credit = 0;
1315 foreach my $cust_credit ( qsearch('cust_credit', {
1316 'custnum' => $self->custnum,
1318 $total_credit += $cust_credit->credited;
1320 sprintf( "%.2f", $total_credit );
1323 =item total_unapplied_payments
1325 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1326 See L<FS::cust_pay/unapplied>.
1330 sub total_unapplied_payments {
1332 my $total_unapplied = 0;
1333 foreach my $cust_pay ( qsearch('cust_pay', {
1334 'custnum' => $self->custnum,
1336 $total_unapplied += $cust_pay->unapplied;
1338 sprintf( "%.2f", $total_unapplied );
1343 Returns the balance for this customer (total_owed minus total_credited
1344 minus total_unapplied_payments).
1351 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1355 =item balance_date TIME
1357 Returns the balance for this customer, only considering invoices with date
1358 earlier than TIME (total_owed_date minus total_credited minus
1359 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
1360 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
1369 $self->total_owed_date($time)
1370 - $self->total_credited
1371 - $self->total_unapplied_payments
1375 =item invoicing_list [ ARRAYREF ]
1377 If an arguement is given, sets these email addresses as invoice recipients
1378 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
1379 (except as warnings), so use check_invoicing_list first.
1381 Returns a list of email addresses (with svcnum entries expanded).
1383 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
1384 check it without disturbing anything by passing nothing.
1386 This interface may change in the future.
1390 sub invoicing_list {
1391 my( $self, $arrayref ) = @_;
1393 my @cust_main_invoice;
1394 if ( $self->custnum ) {
1395 @cust_main_invoice =
1396 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1398 @cust_main_invoice = ();
1400 foreach my $cust_main_invoice ( @cust_main_invoice ) {
1401 #warn $cust_main_invoice->destnum;
1402 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1403 #warn $cust_main_invoice->destnum;
1404 my $error = $cust_main_invoice->delete;
1405 warn $error if $error;
1408 if ( $self->custnum ) {
1409 @cust_main_invoice =
1410 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1412 @cust_main_invoice = ();
1414 my %seen = map { $_->address => 1 } @cust_main_invoice;
1415 foreach my $address ( @{$arrayref} ) {
1416 #unless ( grep { $address eq $_->address } @cust_main_invoice ) {
1417 next if exists $seen{$address} && $seen{$address};
1418 $seen{$address} = 1;
1419 my $cust_main_invoice = new FS::cust_main_invoice ( {
1420 'custnum' => $self->custnum,
1423 my $error = $cust_main_invoice->insert;
1424 warn $error if $error;
1427 if ( $self->custnum ) {
1429 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1435 =item check_invoicing_list ARRAYREF
1437 Checks these arguements as valid input for the invoicing_list method. If there
1438 is an error, returns the error, otherwise returns false.
1442 sub check_invoicing_list {
1443 my( $self, $arrayref ) = @_;
1444 foreach my $address ( @{$arrayref} ) {
1445 my $cust_main_invoice = new FS::cust_main_invoice ( {
1446 'custnum' => $self->custnum,
1449 my $error = $self->custnum
1450 ? $cust_main_invoice->check
1451 : $cust_main_invoice->checkdest
1453 return $error if $error;
1458 =item default_invoicing_list
1460 Sets the invoicing list to all accounts associated with this customer.
1464 sub default_invoicing_list {
1467 foreach my $cust_pkg ( $self->all_pkgs ) {
1468 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1470 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1471 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1473 push @list, map { $_->email } @svc_acct;
1475 $self->invoicing_list(\@list);
1478 =item invoicing_list_addpost
1480 Adds postal invoicing to this customer. If this customer is already configured
1481 to receive postal invoices, does nothing.
1485 sub invoicing_list_addpost {
1487 return if grep { $_ eq 'POST' } $self->invoicing_list;
1488 my @invoicing_list = $self->invoicing_list;
1489 push @invoicing_list, 'POST';
1490 $self->invoicing_list(\@invoicing_list);
1493 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1495 Returns an array of customers referred by this customer (referral_custnum set
1496 to this custnum). If DEPTH is given, recurses up to the given depth, returning
1497 customers referred by customers referred by this customer and so on, inclusive.
1498 The default behavior is DEPTH 1 (no recursion).
1502 sub referral_cust_main {
1504 my $depth = @_ ? shift : 1;
1505 my $exclude = @_ ? shift : {};
1508 map { $exclude->{$_->custnum}++; $_; }
1509 grep { ! $exclude->{ $_->custnum } }
1510 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1514 map { $_->referral_cust_main($depth-1, $exclude) }
1521 =item referral_cust_pkg [ DEPTH ]
1523 Like referral_cust_main, except returns a flat list of all unsuspended packages
1524 for each customer. The number of items in this list may be useful for
1525 comission calculations (perhaps after a grep).
1529 sub referral_cust_pkg {
1531 my $depth = @_ ? shift : 1;
1533 map { $_->unsuspended_pkgs }
1534 grep { $_->unsuspended_pkgs }
1535 $self->referral_cust_main($depth);
1538 =item credit AMOUNT, REASON
1540 Applies a credit to this customer. If there is an error, returns the error,
1541 otherwise returns false.
1546 my( $self, $amount, $reason ) = @_;
1547 my $cust_credit = new FS::cust_credit {
1548 'custnum' => $self->custnum,
1549 'amount' => $amount,
1550 'reason' => $reason,
1552 $cust_credit->insert;
1555 =item charge AMOUNT PKG COMMENT
1557 Creates a one-time charge for this customer. If there is an error, returns
1558 the error, otherwise returns false.
1563 my ( $self, $amount, $pkg, $comment ) = @_;
1565 my $part_pkg = new FS::part_pkg ( {
1566 'pkg' => $pkg || 'One-time charge',
1567 'comment' => $comment,
1584 =item check_and_rebuild_fuzzyfiles
1588 sub check_and_rebuild_fuzzyfiles {
1589 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1590 -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1591 or &rebuild_fuzzyfiles;
1594 =item rebuild_fuzzyfiles
1598 sub rebuild_fuzzyfiles {
1600 use Fcntl qw(:flock);
1602 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1606 open(LASTLOCK,">>$dir/cust_main.last")
1607 or die "can't open $dir/cust_main.last: $!";
1608 flock(LASTLOCK,LOCK_EX)
1609 or die "can't lock $dir/cust_main.last: $!";
1611 my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1613 grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1614 if defined dbdef->table('cust_main')->column('ship_last');
1616 open (LASTCACHE,">$dir/cust_main.last.tmp")
1617 or die "can't open $dir/cust_main.last.tmp: $!";
1618 print LASTCACHE join("\n", @all_last), "\n";
1619 close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1621 rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1626 open(COMPANYLOCK,">>$dir/cust_main.company")
1627 or die "can't open $dir/cust_main.company: $!";
1628 flock(COMPANYLOCK,LOCK_EX)
1629 or die "can't lock $dir/cust_main.company: $!";
1631 my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1633 grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1634 if defined dbdef->table('cust_main')->column('ship_last');
1636 open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1637 or die "can't open $dir/cust_main.company.tmp: $!";
1638 print COMPANYCACHE join("\n", @all_company), "\n";
1639 close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1641 rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1651 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1652 open(LASTCACHE,"<$dir/cust_main.last")
1653 or die "can't open $dir/cust_main.last: $!";
1654 my @array = map { chomp; $_; } <LASTCACHE>;
1664 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1665 open(COMPANYCACHE,"<$dir/cust_main.company")
1666 or die "can't open $dir/cust_main.last: $!";
1667 my @array = map { chomp; $_; } <COMPANYCACHE>;
1672 =item append_fuzzyfiles LASTNAME COMPANY
1676 sub append_fuzzyfiles {
1677 my( $last, $company ) = @_;
1679 &check_and_rebuild_fuzzyfiles;
1681 use Fcntl qw(:flock);
1683 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1687 open(LAST,">>$dir/cust_main.last")
1688 or die "can't open $dir/cust_main.last: $!";
1690 or die "can't lock $dir/cust_main.last: $!";
1692 print LAST "$last\n";
1695 or die "can't unlock $dir/cust_main.last: $!";
1701 open(COMPANY,">>$dir/cust_main.company")
1702 or die "can't open $dir/cust_main.company: $!";
1703 flock(COMPANY,LOCK_EX)
1704 or die "can't lock $dir/cust_main.company: $!";
1706 print COMPANY "$company\n";
1708 flock(COMPANY,LOCK_UN)
1709 or die "can't unlock $dir/cust_main.company: $!";
1723 The delete method should possibly take an FS::cust_main object reference
1724 instead of a scalar customer number.
1726 Bill and collect options should probably be passed as references instead of a
1729 There should probably be a configuration file with a list of allowed credit
1732 No multiple currency support (probably a larger project than just this module).
1736 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
1737 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
1738 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.