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 );
12 use FS::prospect_main;
13 use FS::quotation_pkg;
18 FS::quotation - Object methods for quotation records
24 $record = new FS::quotation \%hash;
25 $record = new FS::quotation { 'column' => 'value' };
27 $error = $record->insert;
29 $error = $new_record->replace($old_record);
31 $error = $record->delete;
33 $error = $record->check;
37 An FS::quotation object represents a quotation. FS::quotation inherits from
38 FS::Record. The following fields are currently supported:
75 Creates a new quotation. To add the quotation to the database, see L<"insert">.
77 Note that this stores the hash reference, not a distinct copy of the hash it
78 points to. You can ask the object for a copy with the I<hash> method.
82 sub table { 'quotation'; }
83 sub notice_name { 'Quotation'; }
84 sub template_conf { 'quotation_'; }
88 Adds this record to the database. If there is an error, returns the error,
89 otherwise returns false.
93 Delete this record from the database.
95 =item replace OLD_RECORD
97 Replaces the OLD_RECORD with this one in the database. If there is an error,
98 returns the error, otherwise returns false.
102 Checks all fields to make sure this is a valid quotation. If there is
103 an error, returns the error, otherwise returns false. Called by the insert
112 $self->ut_numbern('quotationnum')
113 || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum' )
114 || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum' )
115 || $self->ut_numbern('_date')
116 || $self->ut_enum('disabled', [ '', 'Y' ])
117 || $self->ut_numbern('usernum')
119 return $error if $error;
121 $self->_date(time) unless $self->_date;
123 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
125 return 'prospectnum or custnum must be specified'
126 if ! $self->prospectnum
138 qsearchs('prospect_main', { 'prospectnum' => $self->prospectnum } );
147 qsearchs('cust_main', { 'custnum' => $self->custnum } );
154 sub cust_bill_pkg { #actually quotation_pkg objects
156 qsearch('quotation_pkg', { quotationnum=>$self->quotationnum });
165 $self->_total('setup');
168 =item total_recur [ FREQ ]
174 #=item total_recur [ FREQ ]
175 #my $freq = @_ ? shift : '';
176 $self->_total('recur');
180 my( $self, $method ) = @_;
183 $total += $_->$method() for $self->cust_bill_pkg;
184 sprintf('%.2f', $total);
190 my $opt = shift || {};
191 if ($opt and !ref($opt)) {
192 die ref($self). '->email called with positional parameters';
195 my $conf = $self->conf;
197 my $from = delete $opt->{from};
199 # this is where we set the From: address
200 $from ||= $conf->config('quotation_from', $self->cust_or_prospect->agentnum )
201 || $conf->invoice_from_full( $self->cust_or_prospect->agentnum );
202 $self->SUPER::email( {
213 $self->conf->config('quotation_subject') #, $self->cust_main->agentnum)
216 #my $cust_main = $self->cust_main;
217 #my $name = $cust_main->name;
218 #my $name_short = $cust_main->name_short;
219 #my $invoice_number = $self->invnum;
220 #my $invoice_date = $self->_date_pretty;
225 =item cust_or_prosect
229 sub cust_or_prospect {
231 $self->custnum ? $self->cust_main : $self->prospect_main;
234 =item cust_or_prospect_label_link P
236 HTML links to either the customer or prospect.
238 Returns a list consisting of two elements. The first is a text label for the
239 link, and the second is the URL.
243 sub cust_or_prospect_label_link {
244 my( $self, $p ) = @_;
246 if ( my $custnum = $self->custnum ) {
247 my $display_custnum = $self->cust_main->display_custnum;
248 my $target = $FS::CurrentUser::CurrentUser->default_customer_view eq 'jumbo'
250 : ';show=quotations';
252 emt("View this customer (#[_1])",$display_custnum) =>
253 "${p}view/cust_main.cgi?custnum=$custnum$target"
255 } elsif ( my $prospectnum = $self->prospectnum ) {
257 emt("View this prospect (#[_1])",$prospectnum) =>
258 "${p}view/prospect_main.html?$prospectnum"
266 #prevent things from falsely showing up as taxes, at least until we support
267 # quoting tax amounts..
272 shift->cust_bill_pkg;
276 my( $self, $total_items ) = @_;
278 if ( $self->total_setup > 0 ) {
279 push @$total_items, {
280 'total_item' => $self->mt( $self->total_recur > 0 ? 'Total Setup' : 'Total' ),
281 'total_amount' => $self->total_setup,
285 #could/should add up the different recurring frequencies on lines of their own
286 # but this will cover the 95% cases for now
287 if ( $self->total_recur > 0 ) {
288 push @$total_items, {
289 'total_item' => $self->mt('Total Recurring'),
290 'total_amount' => $self->total_recur,
296 =item enable_previous
300 sub enable_previous { 0 }
302 =item convert_cust_main
304 If this quotation already belongs to a customer, then returns that customer, as
305 an FS::cust_main object.
307 Otherwise, creates a new customer (FS::cust_main object and record, and
308 associated) based on this quotation's prospect, then orders this quotation's
309 packages as real packages for the customer.
311 If there is an error, returns an error message, otherwise, returns the
312 newly-created FS::cust_main object.
316 sub convert_cust_main {
319 my $cust_main = $self->cust_main;
320 return $cust_main if $cust_main; #already converted, don't again
322 my $oldAutoCommit = $FS::UID::AutoCommit;
323 local $FS::UID::AutoCommit = 0;
326 $cust_main = $self->prospect_main->convert_cust_main;
327 unless ( ref($cust_main) ) { # eq 'FS::cust_main' ) {
328 $dbh->rollback if $oldAutoCommit;
332 $self->prospectnum('');
333 $self->custnum( $cust_main->custnum );
334 my $error = $self->replace || $self->order;
336 $dbh->rollback if $oldAutoCommit;
340 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
348 This method is for use with quotations which are already associated with a customer.
350 Orders this quotation's packages as real packages for the customer.
352 If there is an error, returns an error message, otherwise returns false.
359 tie my %cust_pkg, 'Tie::RefHash',
360 map { FS::cust_pkg->new({ pkgpart => $_->pkgpart,
361 quantity => $_->quantity,
365 $self->quotation_pkg ;
367 $self->cust_main->order_pkgs( \%cust_pkg );
377 qsearch('quotation_pkg', { 'quotationnum' => $self->quotationnum } );
382 One-time charges, like FS::cust_main::charge()
386 #super false laziness w/cust_main::charge
389 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
390 my ( $pkg, $comment, $additional );
391 my ( $setuptax, $taxclass ); #internal taxes
392 my ( $taxproduct, $override ); #vendor (CCH) taxes
394 my $cust_pkg_ref = '';
395 my ( $bill_now, $invoice_terms ) = ( 0, '' );
397 if ( ref( $_[0] ) ) {
398 $amount = $_[0]->{amount};
399 $setup_cost = $_[0]->{setup_cost};
400 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
401 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
402 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
403 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
404 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
405 : '$'. sprintf("%.2f",$amount);
406 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
407 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
408 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
409 $additional = $_[0]->{additional} || [];
410 $taxproduct = $_[0]->{taxproductnum};
411 $override = { '' => $_[0]->{tax_override} };
412 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
413 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
414 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
415 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
421 $pkg = @_ ? shift : 'One-time charge';
422 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
424 $taxclass = @_ ? shift : '';
428 local $SIG{HUP} = 'IGNORE';
429 local $SIG{INT} = 'IGNORE';
430 local $SIG{QUIT} = 'IGNORE';
431 local $SIG{TERM} = 'IGNORE';
432 local $SIG{TSTP} = 'IGNORE';
433 local $SIG{PIPE} = 'IGNORE';
435 my $oldAutoCommit = $FS::UID::AutoCommit;
436 local $FS::UID::AutoCommit = 0;
439 my $part_pkg = new FS::part_pkg ( {
441 'comment' => $comment,
445 'classnum' => ( $classnum ? $classnum : '' ),
446 'setuptax' => $setuptax,
447 'taxclass' => $taxclass,
448 'taxproductnum' => $taxproduct,
449 'setup_cost' => $setup_cost,
452 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
453 ( 0 .. @$additional - 1 )
455 'additional_count' => scalar(@$additional),
456 'setup_fee' => $amount,
459 my $error = $part_pkg->insert( options => \%options,
460 tax_overrides => $override,
463 $dbh->rollback if $oldAutoCommit;
467 my $pkgpart = $part_pkg->pkgpart;
470 my %type_pkgs = ( 'typenum' => $self->cust_or_prospect->agent->typenum, 'pkgpart' => $pkgpart );
472 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
473 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
474 $error = $type_pkgs->insert;
476 $dbh->rollback if $oldAutoCommit;
481 #except for DIFF, eveything above is idential to cust_main version
482 #but below is our own thing pretty much (adding a quotation package instead
483 # of ordering a customer package, no "bill now")
485 my $quotation_pkg = new FS::quotation_pkg ( {
486 'quotationnum' => $self->quotationnum,
487 'pkgpart' => $pkgpart,
488 'quantity' => $quantity,
489 #'start_date' => $start_date,
490 #'no_auto' => $no_auto,
491 'locationnum'=> $locationnum,
494 $error = $quotation_pkg->insert;
496 $dbh->rollback if $oldAutoCommit;
498 #} elsif ( $cust_pkg_ref ) {
499 # ${$cust_pkg_ref} = $cust_pkg;
502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
509 Disables this quotation (sets disabled to Y, which hides the quotation on
510 prospects and customers).
512 If there is an error, returns an error message, otherwise returns false.
518 $self->disabled('Y');
524 Enables this quotation.
526 If there is an error, returns an error message, otherwise returns false.
543 =item search_sql_where HASHREF
545 Class method which returns an SQL WHERE fragment to search for parameters
546 specified in HASHREF. Valid parameters are
552 List reference of start date, end date, as UNIX timestamps.
562 List reference of charged limits (exclusive).
566 List reference of charged limits (exclusive).
570 flag, return open invoices only
574 flag, return net invoices only
582 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
586 sub search_sql_where {
587 my($class, $param) = @_;
589 # warn "$me search_sql_where called with params: \n".
590 # join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
596 if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
597 push @search, "( prospect_main.agentnum = $1 OR cust_main.agentnum = $1 )";
601 # if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
602 # push @search, "cust_main.refnum = $1";
606 if ( $param->{'prospectnum'} =~ /^(\d+)$/ ) {
607 push @search, "quotation.prospectnum = $1";
611 if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
612 push @search, "cust_bill.custnum = $1";
616 if ( $param->{_date} ) {
617 my($beginning, $ending) = @{$param->{_date}};
619 push @search, "quotation._date >= $beginning",
620 "quotation._date < $ending";
624 if ( $param->{'quotationnum_min'} =~ /^(\d+)$/ ) {
625 push @search, "quotation.quotationnum >= $1";
627 if ( $param->{'quotationnum_max'} =~ /^(\d+)$/ ) {
628 push @search, "quotation.quotationnum <= $1";
632 # if ( $param->{charged} ) {
633 # my @charged = ref($param->{charged})
634 # ? @{ $param->{charged} }
635 # : ($param->{charged});
637 # push @search, map { s/^charged/cust_bill.charged/; $_; }
641 my $owed_sql = FS::cust_bill->owed_sql;
644 push @search, "quotation._date < ". (time-86400*$param->{'days'})
647 #agent virtualization
648 my $curuser = $FS::CurrentUser::CurrentUser;
649 #false laziness w/search/quotation.html
650 push @search,' ( '. $curuser->agentnums_sql( table=>'prospect_main' ).
651 ' OR '. $curuser->agentnums_sql( table=>'cust_main' ).
654 join(' AND ', @search );
664 L<FS::Record>, schema.html from the base documentation.