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/
351 or $part_pkg->plan eq 'agent'
352 or $part_pkg->plan =~ /^torrus/
353 or $part_pkg->option('sync_bill_date')
354 or $part_pkg->option('recur_method') eq 'prorate' ) {
359 if (!$disable_total) {
361 'total_item' => $self->mt('First payment'),
362 'total_amount' => sprintf('%.2f', $total_setup + $total_recur),
372 =item enable_previous
376 sub enable_previous { 0 }
378 =item convert_cust_main
380 If this quotation already belongs to a customer, then returns that customer, as
381 an FS::cust_main object.
383 Otherwise, creates a new customer (FS::cust_main object and record, and
384 associated) based on this quotation's prospect, then orders this quotation's
385 packages as real packages for the customer.
387 If there is an error, returns an error message, otherwise, returns the
388 newly-created FS::cust_main object.
392 sub convert_cust_main {
395 my $cust_main = $self->cust_main;
396 return $cust_main if $cust_main; #already converted, don't again
398 my $oldAutoCommit = $FS::UID::AutoCommit;
399 local $FS::UID::AutoCommit = 0;
402 $cust_main = $self->prospect_main->convert_cust_main;
403 unless ( ref($cust_main) ) { # eq 'FS::cust_main' ) {
404 $dbh->rollback if $oldAutoCommit;
408 $self->prospectnum('');
409 $self->custnum( $cust_main->custnum );
410 my $error = $self->replace || $self->order;
412 $dbh->rollback if $oldAutoCommit;
416 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
424 This method is for use with quotations which are already associated with a customer.
426 Orders this quotation's packages as real packages for the customer.
428 If there is an error, returns an error message, otherwise returns false.
435 tie my %all_cust_pkg, 'Tie::RefHash';
436 foreach my $quotation_pkg ($self->quotation_pkg) {
437 my $cust_pkg = FS::cust_pkg->new;
438 foreach (qw(pkgpart locationnum start_date contract_end quantity waive_setup)) {
439 $cust_pkg->set( $_, $quotation_pkg->get($_) );
442 # currently only one discount each
443 my ($pkg_discount) = $quotation_pkg->quotation_pkg_discount;
444 if ( $pkg_discount ) {
445 $cust_pkg->set('discountnum', $pkg_discount->discountnum);
448 $all_cust_pkg{$cust_pkg} = []; # no services
451 $self->cust_main->order_pkgs( \%all_cust_pkg );
461 qsearch('quotation_pkg', { 'quotationnum' => $self->quotationnum } );
466 One-time charges, like FS::cust_main::charge()
470 #super false laziness w/cust_main::charge
473 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
474 my ( $pkg, $comment, $additional );
475 my ( $setuptax, $taxclass ); #internal taxes
476 my ( $taxproduct, $override ); #vendor (CCH) taxes
478 my $cust_pkg_ref = '';
479 my ( $bill_now, $invoice_terms ) = ( 0, '' );
481 if ( ref( $_[0] ) ) {
482 $amount = $_[0]->{amount};
483 $setup_cost = $_[0]->{setup_cost};
484 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
485 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
486 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
487 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
488 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
489 : '$'. sprintf("%.2f",$amount);
490 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
491 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
492 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
493 $additional = $_[0]->{additional} || [];
494 $taxproduct = $_[0]->{taxproductnum};
495 $override = { '' => $_[0]->{tax_override} };
496 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
497 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
498 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
499 $locationnum = $_[0]->{locationnum};
505 $pkg = @_ ? shift : 'One-time charge';
506 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
508 $taxclass = @_ ? shift : '';
512 local $SIG{HUP} = 'IGNORE';
513 local $SIG{INT} = 'IGNORE';
514 local $SIG{QUIT} = 'IGNORE';
515 local $SIG{TERM} = 'IGNORE';
516 local $SIG{TSTP} = 'IGNORE';
517 local $SIG{PIPE} = 'IGNORE';
519 my $oldAutoCommit = $FS::UID::AutoCommit;
520 local $FS::UID::AutoCommit = 0;
523 my $part_pkg = new FS::part_pkg ( {
525 'comment' => $comment,
529 'classnum' => ( $classnum ? $classnum : '' ),
530 'setuptax' => $setuptax,
531 'taxclass' => $taxclass,
532 'taxproductnum' => $taxproduct,
533 'setup_cost' => $setup_cost,
536 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
537 ( 0 .. @$additional - 1 )
539 'additional_count' => scalar(@$additional),
540 'setup_fee' => $amount,
543 my $error = $part_pkg->insert( options => \%options,
544 tax_overrides => $override,
547 $dbh->rollback if $oldAutoCommit;
551 my $pkgpart = $part_pkg->pkgpart;
554 my %type_pkgs = ( 'typenum' => $self->cust_or_prospect->agent->typenum, 'pkgpart' => $pkgpart );
556 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
557 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
558 $error = $type_pkgs->insert;
560 $dbh->rollback if $oldAutoCommit;
565 #except for DIFF, eveything above is idential to cust_main version
566 #but below is our own thing pretty much (adding a quotation package instead
567 # of ordering a customer package, no "bill now")
569 my $quotation_pkg = new FS::quotation_pkg ( {
570 'quotationnum' => $self->quotationnum,
571 'pkgpart' => $pkgpart,
572 'quantity' => $quantity,
573 #'start_date' => $start_date,
574 #'no_auto' => $no_auto,
575 'locationnum'=> $locationnum,
578 $error = $quotation_pkg->insert;
580 $dbh->rollback if $oldAutoCommit;
582 #} elsif ( $cust_pkg_ref ) {
583 # ${$cust_pkg_ref} = $cust_pkg;
586 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
593 Disables this quotation (sets disabled to Y, which hides the quotation on
594 prospects and customers).
596 If there is an error, returns an error message, otherwise returns false.
602 $self->disabled('Y');
608 Enables this quotation.
610 If there is an error, returns an error message, otherwise returns false.
622 Calculates current prices for all items on this quotation, including
623 discounts and taxes, and updates the quotation_pkg records accordingly.
629 my $conf = FS::Conf->new;
632 my $oldAutoCommit = $FS::UID::AutoCommit;
633 local $FS::UID::AutoCommit = 0;
635 # bring individual items up to date (set setup/recur and discounts)
636 my @quotation_pkg = $self->quotation_pkg;
637 foreach my $pkg (@quotation_pkg) {
638 my $error = $pkg->estimate;
640 $dbh->rollback if $oldAutoCommit;
641 die "error calculating estimate for pkgpart " . $pkg->pkgpart.": $error\n";
644 # delete old tax records
645 foreach my $quotation_pkg_tax ($pkg->quotation_pkg_tax) {
646 $error = $quotation_pkg_tax->delete;
648 $dbh->rollback if $oldAutoCommit;
649 die "error flushing tax records for pkgpart ". $pkg->pkgpart.": $error\n";
654 # annoyingly duplicates handle_taxes--fix this in 4.x
655 if ( $conf->exists('enable_taxproducts') ) {
656 warn "can't calculate external taxes for quotations yet\n";
661 my %taxnum_exemptions; # for monthly exemptions; as yet unused
663 foreach my $pkg (@quotation_pkg) {
664 my $location = $pkg->cust_location;
666 my $part_item = $pkg->part_pkg; # we don't have fees on these yet
667 my @loc_keys = qw( district city county state country);
668 my %taxhash = map { $_ => $location->$_ } @loc_keys;
669 $taxhash{'taxclass'} = $part_item->taxclass;
671 my %taxhash_elim = %taxhash;
672 my @elim = qw( district city county state );
674 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
675 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
676 #then try a match without taxclass
677 my %no_taxclass = %taxhash_elim;
678 $no_taxclass{ 'taxclass' } = '';
679 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
682 $taxhash_elim{ shift(@elim) } = '';
683 } while ( !scalar(@taxes) && scalar(@elim) );
685 foreach my $tax_def (@taxes) {
686 my $taxnum = $tax_def->taxnum;
687 $taxnum_exemptions{$taxnum} ||= [];
689 # XXX do some kind of equivalent to set_exemptions here
690 # but for now just declare that there are no exemptions,
691 # and then hack the taxable amounts if the package def
692 # excludes setup/recur
693 $pkg->set('cust_tax_exempt_pkg', []);
695 if ( $part_item->setuptax or $tax_def->setuptax ) {
696 $pkg->set('unitsetup', 0);
698 if ( $part_item->recurtax or $tax_def->recurtax ) {
699 $pkg->set('unitrecur', 0);
703 foreach my $pass (qw(first recur)) {
704 if ($pass eq 'recur') {
705 $pkg->set('unitsetup', 0);
708 my $taxline = $tax_def->taxline(
710 exemptions => $taxnum_exemptions{$taxnum}
712 if ($taxline and !ref($taxline)) {
713 $dbh->rollback if $oldAutoCommit;
714 die "error calculating '".$tax_def->taxname .
715 "' for pkgpart '".$pkg->pkgpart."': $taxline\n";
717 $taxline{$pass} = $taxline;
720 my $quotation_pkg_tax = FS::quotation_pkg_tax->new({
721 quotationpkgnum => $pkg->quotationpkgnum,
722 itemdesc => ($tax_def->taxname || 'Tax'),
724 taxtype => ref($tax_def),
726 my $setup_amount = 0;
727 my $recur_amount = 0;
728 if ($taxline{first}) {
729 $setup_amount = $taxline{first}->setup; # "first cycle", not setup
731 if ($taxline{recur}) {
732 $recur_amount = $taxline{recur}->setup;
733 $setup_amount -= $recur_amount; # to get the actual setup amount
735 if ( $recur_amount > 0 or $setup_amount > 0 ) {
736 $quotation_pkg_tax->set('setup_amount', sprintf('%.2f', $setup_amount));
737 $quotation_pkg_tax->set('recur_amount', sprintf('%.2f', $recur_amount));
739 my $error = $quotation_pkg_tax->insert;
741 $dbh->rollback if $oldAutoCommit;
742 die "error recording '".$tax_def->taxname .
743 "' for pkgpart '".$pkg->pkgpart."': $error\n";
745 } # else there are no non-zero taxes; continue
749 $dbh->commit if $oldAutoCommit;
760 =item search_sql_where HASHREF
762 Class method which returns an SQL WHERE fragment to search for parameters
763 specified in HASHREF. Valid parameters are
769 List reference of start date, end date, as UNIX timestamps.
779 List reference of charged limits (exclusive).
783 List reference of charged limits (exclusive).
787 flag, return open invoices only
791 flag, return net invoices only
799 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
803 sub search_sql_where {
804 my($class, $param) = @_;
806 # warn "$me search_sql_where called with params: \n".
807 # join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
813 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
814 push @search, "( prospect_main.agentnum = $1 OR cust_main.agentnum = $1 )";
818 # if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
819 # push @search, "cust_main.refnum = $1";
823 if ( $param->{'prospectnum'} =~ /^(\d+)$/ ) {
824 push @search, "quotation.prospectnum = $1";
828 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
829 push @search, "cust_bill.custnum = $1";
833 if ( $param->{_date} ) {
834 my($beginning, $ending) = @{$param->{_date}};
836 push @search, "quotation._date >= $beginning",
837 "quotation._date < $ending";
841 if ( $param->{'quotationnum_min'} =~ /^(\d+)$/ ) {
842 push @search, "quotation.quotationnum >= $1";
844 if ( $param->{'quotationnum_max'} =~ /^(\d+)$/ ) {
845 push @search, "quotation.quotationnum <= $1";
849 # if ( $param->{charged} ) {
850 # my @charged = ref($param->{charged})
851 # ? @{ $param->{charged} }
852 # : ($param->{charged});
854 # push @search, map { s/^charged/cust_bill.charged/; $_; }
858 my $owed_sql = FS::cust_bill->owed_sql;
861 push @search, "quotation._date < ". (time-86400*$param->{'days'})
864 #agent virtualization
865 my $curuser = $FS::CurrentUser::CurrentUser;
866 #false laziness w/search/quotation.html
867 push @search,' ( '. $curuser->agentnums_sql( table=>'prospect_main' ).
868 ' OR '. $curuser->agentnums_sql( table=>'cust_main' ).
871 join(' AND ', @search );
877 Return line item hashes for each package on this quotation. Differs from the
878 base L<FS::Template_Mixin> version in that it recalculates each quoted package
879 first, and doesn't implement the "condensed" option.
884 my ($self, %options) = @_;
886 # run it through the Template_Mixin engine
887 return $self->_items_cust_bill_pkg([ $self->quotation_pkg ], %options);
896 L<FS::Record>, schema.html from the base documentation.