2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
8 use FS::Maketext qw( emt );
9 use FS::Record qw( qsearch qsearchs );
13 use FS::prospect_main;
14 use FS::quotation_pkg;
15 use FS::quotation_pkg_tax;
20 FS::quotation - Object methods for quotation records
26 $record = new FS::quotation \%hash;
27 $record = new FS::quotation { 'column' => 'value' };
29 $error = $record->insert;
31 $error = $new_record->replace($old_record);
33 $error = $record->delete;
35 $error = $record->check;
39 An FS::quotation object represents a quotation. FS::quotation inherits from
40 FS::Record. The following fields are currently supported:
77 Creates a new quotation. To add the quotation to the database, see L<"insert">.
79 Note that this stores the hash reference, not a distinct copy of the hash it
80 points to. You can ask the object for a copy with the I<hash> method.
84 sub table { 'quotation'; }
85 sub notice_name { 'Quotation'; }
86 sub template_conf { 'quotation_'; }
90 Adds this record to the database. If there is an error, returns the error,
91 otherwise returns false.
95 Delete this record from the database.
97 =item replace OLD_RECORD
99 Replaces the OLD_RECORD with this one in the database. If there is an error,
100 returns the error, otherwise returns false.
104 Checks all fields to make sure this is a valid quotation. If there is
105 an error, returns the error, otherwise returns false. Called by the insert
114 $self->ut_numbern('quotationnum')
115 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum' )
116 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum' )
117 || $self->ut_numbern('_date')
118 || $self->ut_enum('disabled', [ '', 'Y' ])
119 || $self->ut_numbern('usernum')
121 return $error if $error;
123 $self->_date(time) unless $self->_date;
125 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
127 return 'prospectnum or custnum must be specified'
128 if ! $self->prospectnum
140 qsearchs('prospect_main', { 'prospectnum' => $self->prospectnum } );
149 qsearchs('cust_main', { 'custnum' => $self->custnum } );
156 sub cust_bill_pkg { #actually quotation_pkg objects
158 qsearch('quotation_pkg', { quotationnum=>$self->quotationnum });
167 $self->_total('setup');
170 =item total_recur [ FREQ ]
176 #=item total_recur [ FREQ ]
177 #my $freq = @_ ? shift : '';
178 $self->_total('recur');
182 my( $self, $method ) = @_;
185 $total += $_->$method() for $self->cust_bill_pkg;
186 sprintf('%.2f', $total);
192 my $opt = shift || {};
193 if ($opt and !ref($opt)) {
194 die ref($self). '->email called with positional parameters';
197 my $conf = $self->conf;
199 my $from = delete $opt->{from};
201 # this is where we set the From: address
202 $from ||= $conf->config('quotation_from', $self->cust_or_prospect->agentnum )
203 || $conf->invoice_from_full( $self->cust_or_prospect->agentnum );
204 $self->SUPER::email( {
215 $self->conf->config('quotation_subject') #, $self->cust_main->agentnum)
218 #my $cust_main = $self->cust_main;
219 #my $name = $cust_main->name;
220 #my $name_short = $cust_main->name_short;
221 #my $invoice_number = $self->invnum;
222 #my $invoice_date = $self->_date_pretty;
227 =item cust_or_prosect
231 sub cust_or_prospect {
233 $self->custnum ? $self->cust_main : $self->prospect_main;
236 =item cust_or_prospect_label_link P
238 HTML links to either the customer or prospect.
240 Returns a list consisting of two elements. The first is a text label for the
241 link, and the second is the URL.
245 sub cust_or_prospect_label_link {
246 my( $self, $p ) = @_;
248 if ( my $custnum = $self->custnum ) {
249 my $display_custnum = $self->cust_main->display_custnum;
250 my $target = $FS::CurrentUser::CurrentUser->default_customer_view eq 'jumbo'
252 : ';show=quotations';
254 emt("View this customer (#[_1])",$display_custnum) =>
255 "${p}view/cust_main.cgi?custnum=$custnum$target"
257 } elsif ( my $prospectnum = $self->prospectnum ) {
259 emt("View this prospect (#[_1])",$prospectnum) =>
260 "${p}view/prospect_main.html?$prospectnum"
273 shift->cust_bill_pkg;
278 $self->quotationnum =~ /^(\d+)$/ or return ();
282 # show taxes in here also; the setup/recurring breakdown is different
283 # from what Template_Mixin expects
284 my @setup_tax = qsearch({
285 select => 'itemdesc, SUM(setup_amount) as setup_amount',
286 table => 'quotation_pkg_tax',
287 addl_from => ' JOIN quotation_pkg USING (quotationpkgnum) ',
288 extra_sql => ' WHERE quotationnum = '.$1,
289 order_by => ' GROUP BY itemdesc HAVING SUM(setup_amount) > 0' .
290 ' ORDER BY itemdesc',
292 # recurs need to be grouped by frequency, and to have a pkgpart
293 my @recur_tax = qsearch({
294 select => 'freq, itemdesc, SUM(recur_amount) as recur_amount, MAX(pkgpart) as pkgpart',
295 table => 'quotation_pkg_tax',
296 addl_from => ' JOIN quotation_pkg USING (quotationpkgnum)'.
297 ' JOIN part_pkg USING (pkgpart)',
298 extra_sql => ' WHERE quotationnum = '.$1,
299 order_by => ' GROUP BY freq, itemdesc HAVING SUM(recur_amount) > 0' .
300 ' ORDER BY freq, itemdesc',
303 my $total_setup = $self->total_setup;
304 foreach my $pkg_tax (@setup_tax) {
305 if ($pkg_tax->setup_amount > 0) {
306 $total_setup += $pkg_tax->setup_amount;
308 'total_item' => $pkg_tax->itemdesc . ' ' . $self->mt('(setup)'),
309 'total_amount' => $pkg_tax->setup_amount,
314 if ( $total_setup > 0 ) {
316 'total_item' => $self->mt( $self->total_recur > 0 ? 'Total Setup' : 'Total' ),
317 'total_amount' => sprintf('%.2f',$total_setup),
318 'break_after' => ( scalar(@recur_tax) ? 1 : 0 )
322 #could/should add up the different recurring frequencies on lines of their own
323 # but this will cover the 95% cases for now
324 my $total_recur = $self->total_recur;
325 # label these with the frequency
326 foreach my $pkg_tax (@recur_tax) {
327 if ($pkg_tax->recur_amount > 0) {
328 $total_recur += $pkg_tax->recur_amount;
329 # an arbitrary part_pkg, but with the right frequency
331 my $part_pkg = qsearchs('part_pkg', { pkgpart => $pkg_tax->pkgpart });
333 'total_item' => $pkg_tax->itemdesc . ' (' . $part_pkg->freq_pretty . ')',
334 'total_amount' => $pkg_tax->recur_amount,
339 if ( $total_recur > 0 ) {
341 'total_item' => $self->mt('Total Recurring'),
342 'total_amount' => sprintf('%.2f',$total_recur),
345 # show 'first payment' line (setup + recur) if there are no prorated
347 my $disable_total = 0;
348 foreach my $quotation_pkg ($self->quotation_pkg) {
349 my $part_pkg = $quotation_pkg->part_pkg;
350 if ( $part_pkg->plan =~ /^(prorate|torrus|agent$)/
351 || $part_pkg->option('recur_method') eq 'prorate'
352 || ( $part_pkg->option('sync_bill_date')
354 && $self->cust_main->billing_pkgs #num_billing_pkgs when we have it
361 if (!$disable_total) {
363 'total_item' => $self->mt('First payment'),
364 'total_amount' => sprintf('%.2f', $total_setup + $total_recur),
374 =item enable_previous
378 sub enable_previous { 0 }
380 =item convert_cust_main
382 If this quotation already belongs to a customer, then returns that customer, as
383 an FS::cust_main object.
385 Otherwise, creates a new customer (FS::cust_main object and record, and
386 associated) based on this quotation's prospect, then orders this quotation's
387 packages as real packages for the customer.
389 If there is an error, returns an error message, otherwise, returns the
390 newly-created FS::cust_main object.
394 sub convert_cust_main {
397 my $cust_main = $self->cust_main;
398 return $cust_main if $cust_main; #already converted, don't again
400 my $oldAutoCommit = $FS::UID::AutoCommit;
401 local $FS::UID::AutoCommit = 0;
404 $cust_main = $self->prospect_main->convert_cust_main;
405 unless ( ref($cust_main) ) { # eq 'FS::cust_main' ) {
406 $dbh->rollback if $oldAutoCommit;
410 $self->prospectnum('');
411 $self->custnum( $cust_main->custnum );
412 my $error = $self->replace || $self->order;
414 $dbh->rollback if $oldAutoCommit;
418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
424 =item order [ HASHREF ]
426 This method is for use with quotations which are already associated with a customer.
428 Orders this quotation's packages as real packages for the customer.
430 If there is an error, returns an error message, otherwise returns false.
432 If HASHREF is passed, it will be filled with a hash mapping the
433 C<quotationpkgnum> of each quoted package to the C<pkgnum> of the package
440 my $pkgnum_map = shift || {};
441 my $details_map = {};
443 tie my %all_cust_pkg, 'Tie::RefHash';
444 foreach my $quotation_pkg ($self->quotation_pkg) {
445 my $cust_pkg = FS::cust_pkg->new;
446 $pkgnum_map->{ $quotation_pkg->quotationpkgnum } = $cust_pkg;
448 # details will be copied below, after package is ordered
449 $details_map->{ $quotation_pkg->quotationpkgnum } = [
450 map { $_->copy_on_order ? $_->detail : () } $quotation_pkg->quotation_pkg_detail
453 foreach (qw(pkgpart locationnum start_date contract_end quantity waive_setup)) {
454 $cust_pkg->set( $_, $quotation_pkg->get($_) );
457 # currently only one discount each
458 my ($pkg_discount) = $quotation_pkg->quotation_pkg_discount;
459 if ( $pkg_discount ) {
460 $cust_pkg->set('discountnum', $pkg_discount->discountnum);
463 $all_cust_pkg{$cust_pkg} = []; # no services
466 local $SIG{HUP} = 'IGNORE';
467 local $SIG{INT} = 'IGNORE';
468 local $SIG{QUIT} = 'IGNORE';
469 local $SIG{TERM} = 'IGNORE';
470 local $SIG{TSTP} = 'IGNORE';
471 local $SIG{PIPE} = 'IGNORE';
473 my $oldAutoCommit = $FS::UID::AutoCommit;
474 local $FS::UID::AutoCommit = 0;
477 my $error = $self->cust_main->order_pkgs( \%all_cust_pkg );
480 # copy details (copy_on_order filtering handled above)
481 foreach my $quotationpkgnum (keys %$details_map) {
482 next unless @{$details_map->{$quotationpkgnum}};
483 $error = $pkgnum_map->{$quotationpkgnum}->set_cust_pkg_detail(
485 @{$details_map->{$quotationpkgnum}}
491 foreach my $quotationpkgnum (keys %$pkgnum_map) {
492 # convert the objects to just pkgnums
493 my $cust_pkg = $pkgnum_map->{$quotationpkgnum};
494 $pkgnum_map->{$quotationpkgnum} = $cust_pkg->pkgnum;
498 $dbh->rollback if $oldAutoCommit;
502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
513 qsearch('quotation_pkg', { 'quotationnum' => $self->quotationnum } );
518 One-time charges, like FS::cust_main::charge()
522 #super false laziness w/cust_main::charge
525 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
526 my ( $pkg, $comment, $additional );
527 my ( $setuptax, $taxclass ); #internal taxes
528 my ( $taxproduct, $override ); #vendor (CCH) taxes
530 my $cust_pkg_ref = '';
531 my ( $bill_now, $invoice_terms ) = ( 0, '' );
533 if ( ref( $_[0] ) ) {
534 $amount = $_[0]->{amount};
535 $setup_cost = $_[0]->{setup_cost};
536 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
537 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
538 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
539 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
540 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
541 : '$'. sprintf("%.2f",$amount);
542 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
543 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
544 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
545 $additional = $_[0]->{additional} || [];
546 $taxproduct = $_[0]->{taxproductnum};
547 $override = { '' => $_[0]->{tax_override} };
548 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
549 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
550 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
551 $locationnum = $_[0]->{locationnum};
557 $pkg = @_ ? shift : 'One-time charge';
558 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
560 $taxclass = @_ ? shift : '';
564 local $SIG{HUP} = 'IGNORE';
565 local $SIG{INT} = 'IGNORE';
566 local $SIG{QUIT} = 'IGNORE';
567 local $SIG{TERM} = 'IGNORE';
568 local $SIG{TSTP} = 'IGNORE';
569 local $SIG{PIPE} = 'IGNORE';
571 my $oldAutoCommit = $FS::UID::AutoCommit;
572 local $FS::UID::AutoCommit = 0;
575 my $part_pkg = new FS::part_pkg ( {
577 'comment' => $comment,
581 'classnum' => ( $classnum ? $classnum : '' ),
582 'setuptax' => $setuptax,
583 'taxclass' => $taxclass,
584 'taxproductnum' => $taxproduct,
585 'setup_cost' => $setup_cost,
588 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
589 ( 0 .. @$additional - 1 )
591 'additional_count' => scalar(@$additional),
592 'setup_fee' => $amount,
595 my $error = $part_pkg->insert( options => \%options,
596 tax_overrides => $override,
599 $dbh->rollback if $oldAutoCommit;
603 my $pkgpart = $part_pkg->pkgpart;
606 my %type_pkgs = ( 'typenum' => $self->cust_or_prospect->agent->typenum, 'pkgpart' => $pkgpart );
608 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
609 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
610 $error = $type_pkgs->insert;
612 $dbh->rollback if $oldAutoCommit;
617 #except for DIFF, eveything above is idential to cust_main version
618 #but below is our own thing pretty much (adding a quotation package instead
619 # of ordering a customer package, no "bill now")
621 my $quotation_pkg = new FS::quotation_pkg ( {
622 'quotationnum' => $self->quotationnum,
623 'pkgpart' => $pkgpart,
624 'quantity' => $quantity,
625 #'start_date' => $start_date,
626 #'no_auto' => $no_auto,
627 'locationnum'=> $locationnum,
630 $error = $quotation_pkg->insert;
632 $dbh->rollback if $oldAutoCommit;
634 #} elsif ( $cust_pkg_ref ) {
635 # ${$cust_pkg_ref} = $cust_pkg;
638 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
645 Disables this quotation (sets disabled to Y, which hides the quotation on
646 prospects and customers).
648 If there is an error, returns an error message, otherwise returns false.
654 $self->disabled('Y');
660 Enables this quotation.
662 If there is an error, returns an error message, otherwise returns false.
674 Calculates current prices for all items on this quotation, including
675 discounts and taxes, and updates the quotation_pkg records accordingly.
681 my $conf = FS::Conf->new;
684 my $oldAutoCommit = $FS::UID::AutoCommit;
685 local $FS::UID::AutoCommit = 0;
687 # bring individual items up to date (set setup/recur and discounts)
688 my @quotation_pkg = $self->quotation_pkg;
689 foreach my $pkg (@quotation_pkg) {
690 my $error = $pkg->estimate;
692 $dbh->rollback if $oldAutoCommit;
693 die "error calculating estimate for pkgpart " . $pkg->pkgpart.": $error\n";
696 # delete old tax records
697 foreach my $quotation_pkg_tax ($pkg->quotation_pkg_tax) {
698 $error = $quotation_pkg_tax->delete;
700 $dbh->rollback if $oldAutoCommit;
701 die "error flushing tax records for pkgpart ". $pkg->pkgpart.": $error\n";
706 # annoyingly duplicates handle_taxes--fix this in 4.x
707 if ( $conf->exists('enable_taxproducts') ) {
708 warn "can't calculate external taxes for quotations yet\n";
713 my %taxnum_exemptions; # for monthly exemptions; as yet unused
715 foreach my $pkg (@quotation_pkg) {
716 my $location = $pkg->cust_location;
718 my $part_item = $pkg->part_pkg; # we don't have fees on these yet
719 my @loc_keys = qw( district city county state country);
720 my %taxhash = map { $_ => $location->$_ } @loc_keys;
721 $taxhash{'taxclass'} = $part_item->taxclass;
723 my %taxhash_elim = %taxhash;
724 my @elim = qw( district city county state );
726 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
727 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
728 #then try a match without taxclass
729 my %no_taxclass = %taxhash_elim;
730 $no_taxclass{ 'taxclass' } = '';
731 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
734 $taxhash_elim{ shift(@elim) } = '';
735 } while ( !scalar(@taxes) && scalar(@elim) );
737 foreach my $tax_def (@taxes) {
738 my $taxnum = $tax_def->taxnum;
739 $taxnum_exemptions{$taxnum} ||= [];
741 # XXX do some kind of equivalent to set_exemptions here
742 # but for now just declare that there are no exemptions,
743 # and then hack the taxable amounts if the package def
744 # excludes setup/recur
745 $pkg->set('cust_tax_exempt_pkg', []);
747 if ( $part_item->setuptax or $tax_def->setuptax ) {
748 $pkg->set('unitsetup', 0);
750 if ( $part_item->recurtax or $tax_def->recurtax ) {
751 $pkg->set('unitrecur', 0);
755 foreach my $pass (qw(first recur)) {
756 if ($pass eq 'recur') {
757 $pkg->set('unitsetup', 0);
760 my $taxline = $tax_def->taxline(
762 exemptions => $taxnum_exemptions{$taxnum}
764 if ($taxline and !ref($taxline)) {
765 $dbh->rollback if $oldAutoCommit;
766 die "error calculating '".$tax_def->taxname .
767 "' for pkgpart '".$pkg->pkgpart."': $taxline\n";
769 $taxline{$pass} = $taxline;
772 my $quotation_pkg_tax = FS::quotation_pkg_tax->new({
773 quotationpkgnum => $pkg->quotationpkgnum,
774 itemdesc => ($tax_def->taxname || 'Tax'),
776 taxtype => ref($tax_def),
778 my $setup_amount = 0;
779 my $recur_amount = 0;
780 if ($taxline{first}) {
781 $setup_amount = $taxline{first}->setup; # "first cycle", not setup
783 if ($taxline{recur}) {
784 $recur_amount = $taxline{recur}->setup;
785 $setup_amount -= $recur_amount; # to get the actual setup amount
787 if ( $recur_amount > 0 or $setup_amount > 0 ) {
788 $quotation_pkg_tax->set('setup_amount', sprintf('%.2f', $setup_amount));
789 $quotation_pkg_tax->set('recur_amount', sprintf('%.2f', $recur_amount));
791 my $error = $quotation_pkg_tax->insert;
793 $dbh->rollback if $oldAutoCommit;
794 die "error recording '".$tax_def->taxname .
795 "' for pkgpart '".$pkg->pkgpart."': $error\n";
797 } # else there are no non-zero taxes; continue
801 $dbh->commit if $oldAutoCommit;
812 =item search_sql_where HASHREF
814 Class method which returns an SQL WHERE fragment to search for parameters
815 specified in HASHREF. Valid parameters are
821 List reference of start date, end date, as UNIX timestamps.
831 List reference of charged limits (exclusive).
835 List reference of charged limits (exclusive).
839 flag, return open invoices only
843 flag, return net invoices only
851 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
855 sub search_sql_where {
856 my($class, $param) = @_;
858 # warn "$me search_sql_where called with params: \n".
859 # join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
865 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
866 push @search, "( prospect_main.agentnum = $1 OR cust_main.agentnum = $1 )";
870 # if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
871 # push @search, "cust_main.refnum = $1";
875 if ( $param->{'prospectnum'} =~ /^(\d+)$/ ) {
876 push @search, "quotation.prospectnum = $1";
880 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
881 push @search, "cust_bill.custnum = $1";
885 if ( $param->{_date} ) {
886 my($beginning, $ending) = @{$param->{_date}};
888 push @search, "quotation._date >= $beginning",
889 "quotation._date < $ending";
893 if ( $param->{'quotationnum_min'} =~ /^(\d+)$/ ) {
894 push @search, "quotation.quotationnum >= $1";
896 if ( $param->{'quotationnum_max'} =~ /^(\d+)$/ ) {
897 push @search, "quotation.quotationnum <= $1";
901 # if ( $param->{charged} ) {
902 # my @charged = ref($param->{charged})
903 # ? @{ $param->{charged} }
904 # : ($param->{charged});
906 # push @search, map { s/^charged/cust_bill.charged/; $_; }
910 my $owed_sql = FS::cust_bill->owed_sql;
913 push @search, "quotation._date < ". (time-86400*$param->{'days'})
916 #agent virtualization
917 my $curuser = $FS::CurrentUser::CurrentUser;
918 #false laziness w/search/quotation.html
919 push @search,' ( '. $curuser->agentnums_sql( table=>'prospect_main' ).
920 ' OR '. $curuser->agentnums_sql( table=>'cust_main' ).
923 join(' AND ', @search );
929 Return line item hashes for each package on this quotation. Differs from the
930 base L<FS::Template_Mixin> version in that it recalculates each quoted package
931 first, and doesn't implement the "condensed" option.
936 my ($self, %options) = @_;
938 # run it through the Template_Mixin engine
939 return $self->_items_cust_bill_pkg([ $self->quotation_pkg ], %options);
948 L<FS::Record>, schema.html from the base documentation.