1 package FS::quotation_pkg;
2 use base qw( FS::TemplateItem_Mixin FS::Record );
5 use FS::Record qw( qsearchs qsearch dbh );
7 use FS::quotation_pkg_discount; #so its loaded when TemplateItem_Mixin needs it
8 use FS::quotation_pkg_detail;
9 use List::Util qw(sum);
13 FS::quotation_pkg - Object methods for quotation_pkg records
17 use FS::quotation_pkg;
19 $record = new FS::quotation_pkg \%hash;
20 $record = new FS::quotation_pkg { 'column' => 'value' };
22 $error = $record->insert;
24 $error = $new_record->replace($old_record);
26 $error = $record->delete;
28 $error = $record->check;
32 An FS::quotation_pkg object represents a quotation package.
33 FS::quotation_pkg inherits from FS::Record. The following fields are currently
44 pkgpart (L<FS::part_pkg>) of the package
48 locationnum (L<FS::cust_location>) where the package will be in service
52 expected start date for the package, as a timestamp
64 'Y' to waive the setup fee
68 The amount per package that will be charged in setup/one-time fees.
72 The amount per package that will be charged per billing cycle.
76 The length of the billing cycle. If zero it's a one-time charge; if any
77 other number it's that many months; other values are in L<FS::Misc::pkg_freqs>.
87 Creates a new quotation package. To add the quotation package to the database,
90 Note that this stores the hash reference, not a distinct copy of the hash it
91 points to. You can ask the object for a copy with the I<hash> method.
95 sub table { 'quotation_pkg'; }
97 sub display_table { 'quotation_pkg'; }
99 #forget it, just overriding cust_bill_pkg_display entirely
100 #sub display_table_orderby { 'quotationpkgnum'; } # something else?
101 # # (for invoice display order)
103 sub discount_table { 'quotation_pkg_discount'; }
105 # detail table uses non-quotation fieldnames, see billpkgnum below
106 sub detail_table { 'quotation_pkg_detail'; }
110 Sets/returns quotationpkgnum, for ease of integration with TemplateItem_Mixin::details
116 $self->quotationpkgnum(@_);
121 Adds this record to the database. If there is an error, returns the error,
122 otherwise returns false.
127 my ($self, %options) = @_;
130 my $oldAutoCommit = $FS::UID::AutoCommit;
131 local $FS::UID::AutoCommit = 0;
133 my $error = $self->SUPER::insert;
135 if ( !$error and ($self->setup_discountnum || $self->recur_discountnum) ) {
136 #warn "inserting discount\n";
137 $error = $self->insert_discount;
138 $error .= ' (setting discount)' if $error;
142 $dbh->rollback if $oldAutoCommit;
145 $dbh->commit if $oldAutoCommit;
152 Delete this record from the database.
160 my $oldAutoCommit = $FS::UID::AutoCommit;
161 local $FS::UID::AutoCommit = 0;
163 my $error = $self->delete_details;
165 $dbh->rollback if $oldAutoCommit;
169 foreach ($self->quotation_pkg_discount, $self->quotation_pkg_tax) {
172 $dbh->rollback if $oldAutoCommit;
173 return $error . ' (deleting discount)';
177 $error = $self->SUPER::delete;
179 $dbh->rollback if $oldAutoCommit;
182 $dbh->commit if $oldAutoCommit;
185 $self->quotation->estimate;
188 =item replace OLD_RECORD
190 Replaces the OLD_RECORD with this one in the database. If there is an error,
191 returns the error, otherwise returns false.
195 Checks all fields to make sure this is a valid quotation package. If there is
196 an error, returns the error, otherwise returns false. Called by the insert
204 my @freqs = ('', keys (%{ FS::Misc->pkg_freqs }));
207 $self->ut_numbern('quotationpkgnum')
208 || $self->ut_foreign_key( 'quotationnum', 'quotation', 'quotationnum' )
209 || $self->ut_foreign_key( 'pkgpart', 'part_pkg', 'pkgpart' )
210 || $self->ut_foreign_keyn( 'locationnum', 'cust_location', 'locationnum' )
211 || $self->ut_numbern('start_date')
212 || $self->ut_numbern('contract_end')
213 || $self->ut_numbern('quantity')
214 || $self->ut_moneyn('unitsetup')
215 || $self->ut_moneyn('unitrecur')
216 || $self->ut_enum('freq', \@freqs)
217 || $self->ut_enum('waive_setup', [ '', 'Y'] )
220 if ($self->locationnum eq '') {
221 # use the customer default
222 my $quotation = $self->quotation;
223 if ($quotation->custnum) {
224 $self->set('locationnum', $quotation->cust_main->ship_locationnum);
225 } elsif ($quotation->prospectnum) {
226 # use the first non-disabled location for that prospect
227 my $cust_location = qsearchs('cust_location',
228 { prospectnum => $quotation->prospectnum,
230 $self->set('locationnum', $cust_location->locationnum) if $cust_location;
231 } # else the quotation is invalid
234 return $error if $error;
239 #it looks redundant with a v4.x+ auto-generated method, but need to override
240 # FS::TemplateItem_Mixin's version
243 qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart } );
248 $self->part_pkg->pkg;
253 =item insert_discount
255 Associates this package with a discount (see L<FS::cust_pkg_discount>,
256 possibly inserting a new discount on the fly (see L<FS::discount>). Properties
257 of the discount will be taken from this object.
261 sub insert_discount {
262 #my ($self, %options) = @_;
265 foreach my $x (qw(setup recur)) {
266 if ( my $discountnum = $self->get("${x}_discountnum") ) {
267 my $cust_pkg_discount = FS::quotation_pkg_discount->new( {
268 'quotationpkgnum' => $self->quotationpkgnum,
269 'discountnum' => $discountnum,
271 #for the create a new discount case
272 'amount' => $self->get("${x}_discountnum_amount"),
273 'percent' => $self->get("${x}_discountnum_percent"),
274 'months' => $self->get("${x}_discountnum_months"),
276 if ( $x eq 'setup' ) {
277 $cust_pkg_discount->setup('Y');
278 $cust_pkg_discount->months('');
280 my $error = $cust_pkg_discount->insert;
281 return $error if $error;
289 my $setuprecur = $options{'setuprecur'};
290 # a little different from cust_bill_pkg::_item_discount, in that this one
291 # is asked specifically whether to show setup or recur discounts (because
292 # on the quotation they're separate sections entirely)
294 my @pkg_discounts = grep { $_->setuprecur eq $setuprecur }
296 return if @pkg_discounts == 0;
301 description => $self->mt('Discount'),
303 ext_description => \@ext,
304 # maybe should show quantity/unit discount?
306 foreach my $pkg_discount (@pkg_discounts) {
307 push @ext, $pkg_discount->description;
308 my $amount = $pkg_discount->get('amount');
309 $d->{amount} -= $amount;
311 $d->{amount} = sprintf('%.2f', $d->{amount} * $self->quantity);
318 return '0.00' if $self->waive_setup eq 'Y';;
319 my $discount_amount = sum(0, map { $_->amount }
320 grep { $_->setuprecur eq 'setup' }
323 ($self->unitsetup - $discount_amount) * ($self->quantity || 1);
329 sum(0, map { $_->setup_amount } $self->quotation_pkg_tax);
334 my $discount_amount = sum(0, map { $_->amount }
335 grep { $_->setuprecur eq 'recur' }
338 ($self->unitrecur - $discount_amount) * ($self->quantity || 1);
344 sum(0, map { $_->recur_amount } $self->quotation_pkg_tax);
347 =item part_pkg_currency_option OPTIONNAME
349 Returns a two item list consisting of the currency of this quotation's customer
350 or prospect, if any, and a value for the provided option. If the customer or
351 prospect has a currency, the value is the option value the given name and the
352 currency (see L<FS::part_pkg_currency>). Otherwise, if the customer or
353 prospect has no currency, is the regular option value for the given name (see
354 L<FS::part_pkg_option>).
358 #false laziness w/cust_pkg->part_pkg_currency_option
359 sub part_pkg_currency_option {
360 my( $self, $optionname ) = @_;
361 my $part_pkg = $self->part_pkg;
362 my $prospect_or_customer = $self->cust_main || $self->prospect_main;
363 if ( my $currency = $prospect_or_customer->currency ) {
364 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
366 ('', $part_pkg->option($optionname) );
372 Deletes all quotation_pkgs_details associated with this pkg (see L<FS::quotation_pkg_detail>).
379 my $oldAutoCommit = $FS::UID::AutoCommit;
380 local $FS::UID::AutoCommit = 0;
383 foreach my $detail ( qsearch('quotation_pkg_detail',{ 'billpkgnum' => $self->quotationpkgnum }) ) {
384 my $error = $detail->delete;
386 $dbh->rollback if $oldAutoCommit;
387 return "error removing old detail: $error";
391 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
396 =item set_details [ DETAIL, DETAIL, ... ]
398 Sets quotation details for this package (see L<FS::quotation_pkg_detail>).
400 If there is an error, returns the error, otherwise returns false.
405 my( $self, @details ) = @_;
407 my $oldAutoCommit = $FS::UID::AutoCommit;
408 local $FS::UID::AutoCommit = 0;
411 my $error = $self->delete_details;
413 $dbh->rollback if $oldAutoCommit;
417 foreach my $detail ( @details ) {
418 my $quotation_pkg_detail = new FS::quotation_pkg_detail {
419 'billpkgnum' => $self->quotationpkgnum,
422 $error = $quotation_pkg_detail->insert;
424 $dbh->rollback if $oldAutoCommit;
425 return "error adding new detail: $error";
429 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
434 =item cust_bill_pkg_display [ type => TYPE ]
438 sub cust_bill_pkg_display {
439 my ( $self, %opt ) = @_;
441 my $type = $opt{type} if exists $opt{type};
442 return () if $type eq 'U'; #quotations don't have usage
444 if ( $self->get('display') ) {
445 return ( grep { defined($type) ? ($type eq $_->type) : 1 }
446 @{ $self->get('display') }
451 my $setup = $self->new($self->hashref);
452 $setup->{'_NO_RECUR_KLUDGE'} = 1;
453 $setup->{'type'} = 'S';
454 my $recur = $self->new($self->hashref);
455 $recur->{'_NO_SETUP_KLUDGE'} = 1;
456 $recur->{'type'} = 'R';
458 if ( $type eq 'S' ) {
460 } elsif ( $type eq 'R' ) {
463 #return ($setup, $recur);
473 Returns the customer (L<FS::cust_main> object).
479 my $quotation = $self->quotation or return '';
480 $quotation->cust_main;
485 Returns the prospect (L<FS::prospect_main> object).
491 my $quotation = $self->quotation or return '';
492 $quotation->prospect_main;
495 sub tax_locationnum {
502 my @quotation_pkg_without_location =
503 qsearch( 'quotation_pkg', { locationnum => '' } );
504 if (@quotation_pkg_without_location) {
505 warn "setting default location on quotation_pkg records\n";
506 foreach my $quotation_pkg (@quotation_pkg_without_location) {
507 # check() will fix this
508 my $error = $quotation_pkg->replace;
510 die "quotation #".$quotation_pkg->quotationnum.": $error\n";
521 Doesn't support fees, or add-on packages.
525 L<FS::Record>, schema.html from the base documentation.