2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record
9 use FS::Maketext qw( emt );
10 use FS::Record qw( qsearch qsearchs );
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
142 sub cust_bill_pkg { #actually quotation_pkg objects
143 shift->quotation_pkg(@_);
152 $self->_total('setup');
155 =item total_recur [ FREQ ]
161 #=item total_recur [ FREQ ]
162 #my $freq = @_ ? shift : '';
163 $self->_total('recur');
167 my( $self, $method ) = @_;
170 $total += $_->$method() for $self->cust_bill_pkg;
171 sprintf('%.2f', $total);
177 my $opt = shift || {};
178 if ($opt and !ref($opt)) {
179 die ref($self). '->email called with positional parameters';
182 my $conf = $self->conf;
184 my $from = delete $opt->{from};
186 # this is where we set the From: address
187 $from ||= $conf->config('quotation_from', $self->cust_or_prospect->agentnum )
188 || $conf->invoice_from_full( $self->cust_or_prospect->agentnum );
189 $self->SUPER::email( {
200 $self->conf->config('quotation_subject') #, $self->cust_main->agentnum)
203 #my $cust_main = $self->cust_main;
204 #my $name = $cust_main->name;
205 #my $name_short = $cust_main->name_short;
206 #my $invoice_number = $self->invnum;
207 #my $invoice_date = $self->_date_pretty;
212 =item cust_or_prosect
216 sub cust_or_prospect {
218 $self->custnum ? $self->cust_main : $self->prospect_main;
221 =item cust_or_prospect_label_link P
223 HTML links to either the customer or prospect.
225 Returns a list consisting of two elements. The first is a text label for the
226 link, and the second is the URL.
230 sub cust_or_prospect_label_link {
231 my( $self, $p ) = @_;
233 if ( my $custnum = $self->custnum ) {
234 my $display_custnum = $self->cust_main->display_custnum;
235 my $target = $FS::CurrentUser::CurrentUser->default_customer_view eq 'jumbo'
237 : ';show=quotations';
239 emt("View this customer (#[_1])",$display_custnum) =>
240 "${p}view/cust_main.cgi?custnum=$custnum$target"
242 } elsif ( my $prospectnum = $self->prospectnum ) {
244 emt("View this prospect (#[_1])",$prospectnum) =>
245 "${p}view/prospect_main.html?$prospectnum"
258 shift->cust_bill_pkg;
263 $self->quotationnum =~ /^(\d+)$/ or return ();
267 # show taxes in here also; the setup/recurring breakdown is different
268 # from what Template_Mixin expects
269 my @setup_tax = qsearch({
270 select => 'itemdesc, SUM(setup_amount) as setup_amount',
271 table => 'quotation_pkg_tax',
272 addl_from => ' JOIN quotation_pkg USING (quotationpkgnum) ',
273 extra_sql => ' WHERE quotationnum = '.$1,
274 order_by => ' GROUP BY itemdesc HAVING SUM(setup_amount) > 0' .
275 ' ORDER BY itemdesc',
277 # recurs need to be grouped by frequency, and to have a pkgpart
278 my @recur_tax = qsearch({
279 select => 'freq, itemdesc, SUM(recur_amount) as recur_amount, MAX(pkgpart) as pkgpart',
280 table => 'quotation_pkg_tax',
281 addl_from => ' JOIN quotation_pkg USING (quotationpkgnum)'.
282 ' JOIN part_pkg USING (pkgpart)',
283 extra_sql => ' WHERE quotationnum = '.$1,
284 order_by => ' GROUP BY freq, itemdesc HAVING SUM(recur_amount) > 0' .
285 ' ORDER BY freq, itemdesc',
288 my $total_setup = $self->total_setup;
289 foreach my $pkg_tax (@setup_tax) {
290 if ($pkg_tax->setup_amount > 0) {
291 $total_setup += $pkg_tax->setup_amount;
293 'total_item' => $pkg_tax->itemdesc . ' ' . $self->mt('(setup)'),
294 'total_amount' => $pkg_tax->setup_amount,
299 if ( $total_setup > 0 ) {
301 'total_item' => $self->mt( $self->total_recur > 0 ? 'Total Setup' : 'Total' ),
302 'total_amount' => sprintf('%.2f',$total_setup),
303 'break_after' => ( scalar(@recur_tax) ? 1 : 0 )
307 #could/should add up the different recurring frequencies on lines of their own
308 # but this will cover the 95% cases for now
309 my $total_recur = $self->total_recur;
310 # label these with the frequency
311 foreach my $pkg_tax (@recur_tax) {
312 if ($pkg_tax->recur_amount > 0) {
313 $total_recur += $pkg_tax->recur_amount;
314 # an arbitrary part_pkg, but with the right frequency
316 my $part_pkg = qsearchs('part_pkg', { pkgpart => $pkg_tax->pkgpart });
318 'total_item' => $pkg_tax->itemdesc . ' (' . $part_pkg->freq_pretty . ')',
319 'total_amount' => $pkg_tax->recur_amount,
324 if ( $total_recur > 0 ) {
326 'total_item' => $self->mt('Total Recurring'),
327 'total_amount' => sprintf('%.2f',$total_recur),
336 =item enable_previous
340 sub enable_previous { 0 }
342 =item convert_cust_main
344 If this quotation already belongs to a customer, then returns that customer, as
345 an FS::cust_main object.
347 Otherwise, creates a new customer (FS::cust_main object and record, and
348 associated) based on this quotation's prospect, then orders this quotation's
349 packages as real packages for the customer.
351 If there is an error, returns an error message, otherwise, returns the
352 newly-created FS::cust_main object.
356 sub convert_cust_main {
359 my $cust_main = $self->cust_main;
360 return $cust_main if $cust_main; #already converted, don't again
362 my $oldAutoCommit = $FS::UID::AutoCommit;
363 local $FS::UID::AutoCommit = 0;
366 $cust_main = $self->prospect_main->convert_cust_main;
367 unless ( ref($cust_main) ) { # eq 'FS::cust_main' ) {
368 $dbh->rollback if $oldAutoCommit;
372 $self->prospectnum('');
373 $self->custnum( $cust_main->custnum );
374 my $error = $self->replace || $self->order;
376 $dbh->rollback if $oldAutoCommit;
380 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
388 This method is for use with quotations which are already associated with a customer.
390 Orders this quotation's packages as real packages for the customer.
392 If there is an error, returns an error message, otherwise returns false.
399 tie my %all_cust_pkg, 'Tie::RefHash';
400 foreach my $quotation_pkg ($self->quotation_pkg) {
401 my $cust_pkg = FS::cust_pkg->new;
402 foreach (qw(pkgpart locationnum start_date contract_end quantity waive_setup)) {
403 $cust_pkg->set( $_, $quotation_pkg->get($_) );
406 # currently only one discount each
407 my ($pkg_discount) = $quotation_pkg->quotation_pkg_discount;
408 if ( $pkg_discount ) {
409 $cust_pkg->set('discountnum', $pkg_discount->discountnum);
412 $all_cust_pkg{$cust_pkg} = []; # no services
415 $self->cust_main->order_pkgs( \%all_cust_pkg );
421 One-time charges, like FS::cust_main::charge()
425 #super false laziness w/cust_main::charge
428 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
429 my ( $pkg, $comment, $additional );
430 my ( $setuptax, $taxclass ); #internal taxes
431 my ( $taxproduct, $override ); #vendor (CCH) taxes
433 my $cust_pkg_ref = '';
434 my ( $bill_now, $invoice_terms ) = ( 0, '' );
436 if ( ref( $_[0] ) ) {
437 $amount = $_[0]->{amount};
438 $setup_cost = $_[0]->{setup_cost};
439 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
440 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
441 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
442 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
443 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
444 : '$'. sprintf("%.2f",$amount);
445 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
446 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
447 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
448 $additional = $_[0]->{additional} || [];
449 $taxproduct = $_[0]->{taxproductnum};
450 $override = { '' => $_[0]->{tax_override} };
451 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
452 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
453 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
454 $locationnum = $_[0]->{locationnum};
460 $pkg = @_ ? shift : 'One-time charge';
461 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
463 $taxclass = @_ ? shift : '';
467 local $SIG{HUP} = 'IGNORE';
468 local $SIG{INT} = 'IGNORE';
469 local $SIG{QUIT} = 'IGNORE';
470 local $SIG{TERM} = 'IGNORE';
471 local $SIG{TSTP} = 'IGNORE';
472 local $SIG{PIPE} = 'IGNORE';
474 my $oldAutoCommit = $FS::UID::AutoCommit;
475 local $FS::UID::AutoCommit = 0;
478 my $part_pkg = new FS::part_pkg ( {
480 'comment' => $comment,
484 'classnum' => ( $classnum ? $classnum : '' ),
485 'setuptax' => $setuptax,
486 'taxclass' => $taxclass,
487 'taxproductnum' => $taxproduct,
488 'setup_cost' => $setup_cost,
491 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
492 ( 0 .. @$additional - 1 )
494 'additional_count' => scalar(@$additional),
495 'setup_fee' => $amount,
498 my $error = $part_pkg->insert( options => \%options,
499 tax_overrides => $override,
502 $dbh->rollback if $oldAutoCommit;
506 my $pkgpart = $part_pkg->pkgpart;
509 my %type_pkgs = ( 'typenum' => $self->cust_or_prospect->agent->typenum, 'pkgpart' => $pkgpart );
511 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
512 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
513 $error = $type_pkgs->insert;
515 $dbh->rollback if $oldAutoCommit;
520 #except for DIFF, eveything above is idential to cust_main version
521 #but below is our own thing pretty much (adding a quotation package instead
522 # of ordering a customer package, no "bill now")
524 my $quotation_pkg = new FS::quotation_pkg ( {
525 'quotationnum' => $self->quotationnum,
526 'pkgpart' => $pkgpart,
527 'quantity' => $quantity,
528 #'start_date' => $start_date,
529 #'no_auto' => $no_auto,
530 'locationnum'=> $locationnum,
533 $error = $quotation_pkg->insert;
535 $dbh->rollback if $oldAutoCommit;
537 #} elsif ( $cust_pkg_ref ) {
538 # ${$cust_pkg_ref} = $cust_pkg;
541 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
548 Disables this quotation (sets disabled to Y, which hides the quotation on
549 prospects and customers).
551 If there is an error, returns an error message, otherwise returns false.
557 $self->disabled('Y');
563 Enables this quotation.
565 If there is an error, returns an error message, otherwise returns false.
577 Calculates current prices for all items on this quotation, including
578 discounts and taxes, and updates the quotation_pkg records accordingly.
584 my $conf = FS::Conf->new;
587 my $oldAutoCommit = $FS::UID::AutoCommit;
588 local $FS::UID::AutoCommit = 0;
590 # bring individual items up to date (set setup/recur and discounts)
591 my @quotation_pkg = $self->quotation_pkg;
592 foreach my $pkg (@quotation_pkg) {
593 my $error = $pkg->estimate;
595 $dbh->rollback if $oldAutoCommit;
596 die "error calculating estimate for pkgpart " . $pkg->pkgpart.": $error\n";
599 # delete old tax records
600 foreach my $quotation_pkg_tax ($pkg->quotation_pkg_tax) {
601 $error = $quotation_pkg_tax->delete;
603 $dbh->rollback if $oldAutoCommit;
604 die "error flushing tax records for pkgpart ". $pkg->pkgpart.": $error\n";
609 # annoyingly duplicates handle_taxes--fix this in 4.x
610 if ( $conf->exists('enable_taxproducts') ) {
611 warn "can't calculate external taxes for quotations yet\n";
616 my %taxnum_exemptions; # for monthly exemptions; as yet unused
618 foreach my $pkg (@quotation_pkg) {
619 my $location = $pkg->cust_location;
621 my $part_item = $pkg->part_pkg; # we don't have fees on these yet
622 my @loc_keys = qw( district city county state country);
623 my %taxhash = map { $_ => $location->$_ } @loc_keys;
624 $taxhash{'taxclass'} = $part_item->taxclass;
626 my %taxhash_elim = %taxhash;
627 my @elim = qw( district city county state );
629 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
630 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
631 #then try a match without taxclass
632 my %no_taxclass = %taxhash_elim;
633 $no_taxclass{ 'taxclass' } = '';
634 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
637 $taxhash_elim{ shift(@elim) } = '';
638 } while ( !scalar(@taxes) && scalar(@elim) );
640 foreach my $tax_def (@taxes) {
641 my $taxnum = $tax_def->taxnum;
642 $taxnum_exemptions{$taxnum} ||= [];
644 # XXX do some kind of equivalent to set_exemptions here
645 # but for now just declare that there are no exemptions,
646 # and then hack the taxable amounts if the package def
647 # excludes setup/recur
648 $pkg->set('cust_tax_exempt_pkg', []);
650 if ( $part_item->setuptax or $tax_def->setuptax ) {
651 $pkg->set('unitsetup', 0);
653 if ( $part_item->recurtax or $tax_def->recurtax ) {
654 $pkg->set('unitrecur', 0);
658 foreach my $pass (qw(first recur)) {
659 if ($pass eq 'recur') {
660 $pkg->set('unitsetup', 0);
663 my $taxline = $tax_def->taxline(
665 exemptions => $taxnum_exemptions{$taxnum}
667 if ($taxline and !ref($taxline)) {
668 $dbh->rollback if $oldAutoCommit;
669 die "error calculating '".$tax_def->taxname .
670 "' for pkgpart '".$pkg->pkgpart."': $taxline\n";
672 $taxline{$pass} = $taxline;
675 my $quotation_pkg_tax = FS::quotation_pkg_tax->new({
676 quotationpkgnum => $pkg->quotationpkgnum,
677 itemdesc => ($tax_def->taxname || 'Tax'),
679 taxtype => ref($tax_def),
681 my $setup_amount = 0;
682 my $recur_amount = 0;
683 if ($taxline{first}) {
684 $setup_amount = $taxline{first}->setup; # "first cycle", not setup
686 if ($taxline{recur}) {
687 $recur_amount = $taxline{recur}->setup;
688 $setup_amount -= $recur_amount; # to get the actual setup amount
690 if ( $recur_amount > 0 or $setup_amount > 0 ) {
691 $quotation_pkg_tax->set('setup_amount', sprintf('%.2f', $setup_amount));
692 $quotation_pkg_tax->set('recur_amount', sprintf('%.2f', $recur_amount));
694 my $error = $quotation_pkg_tax->insert;
696 $dbh->rollback if $oldAutoCommit;
697 die "error recording '".$tax_def->taxname .
698 "' for pkgpart '".$pkg->pkgpart."': $error\n";
700 } # else there are no non-zero taxes; continue
704 $dbh->commit if $oldAutoCommit;
715 =item search_sql_where HASHREF
717 Class method which returns an SQL WHERE fragment to search for parameters
718 specified in HASHREF. Valid parameters are
724 List reference of start date, end date, as UNIX timestamps.
734 List reference of charged limits (exclusive).
738 List reference of charged limits (exclusive).
742 flag, return open invoices only
746 flag, return net invoices only
754 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
758 sub search_sql_where {
759 my($class, $param) = @_;
761 # warn "$me search_sql_where called with params: \n".
762 # join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
768 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
769 push @search, "( prospect_main.agentnum = $1 OR cust_main.agentnum = $1 )";
773 # if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
774 # push @search, "cust_main.refnum = $1";
778 if ( $param->{'prospectnum'} =~ /^(\d+)$/ ) {
779 push @search, "quotation.prospectnum = $1";
783 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
784 push @search, "cust_bill.custnum = $1";
788 if ( $param->{_date} ) {
789 my($beginning, $ending) = @{$param->{_date}};
791 push @search, "quotation._date >= $beginning",
792 "quotation._date < $ending";
796 if ( $param->{'quotationnum_min'} =~ /^(\d+)$/ ) {
797 push @search, "quotation.quotationnum >= $1";
799 if ( $param->{'quotationnum_max'} =~ /^(\d+)$/ ) {
800 push @search, "quotation.quotationnum <= $1";
804 # if ( $param->{charged} ) {
805 # my @charged = ref($param->{charged})
806 # ? @{ $param->{charged} }
807 # : ($param->{charged});
809 # push @search, map { s/^charged/cust_bill.charged/; $_; }
813 my $owed_sql = FS::cust_bill->owed_sql;
816 push @search, "quotation._date < ". (time-86400*$param->{'days'})
819 #agent virtualization
820 my $curuser = $FS::CurrentUser::CurrentUser;
821 #false laziness w/search/quotation.html
822 push @search,' ( '. $curuser->agentnums_sql( table=>'prospect_main' ).
823 ' OR '. $curuser->agentnums_sql( table=>'cust_main' ).
826 join(' AND ', @search );
832 Return line item hashes for each package on this quotation. Differs from the
833 base L<FS::Template_Mixin> version in that it recalculates each quoted package
834 first, and doesn't implement the "condensed" option.
839 my ($self, %options) = @_;
841 # run it through the Template_Mixin engine
842 return $self->_items_cust_bill_pkg([ $self->quotation_pkg ], %options);
851 L<FS::Record>, schema.html from the base documentation.