1 package FS::quotation_pkg;
4 use base qw( FS::TemplateItem_Mixin FS::Record );
5 use FS::Record qw( qsearch qsearchs dbh );
9 use FS::quotation_pkg_discount; #so its loaded when TemplateItem_Mixin needs it
10 use FS::quotation_pkg_detail;
11 use List::Util qw(sum);
15 FS::quotation_pkg - Object methods for quotation_pkg records
19 use FS::quotation_pkg;
21 $record = new FS::quotation_pkg \%hash;
22 $record = new FS::quotation_pkg { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::quotation_pkg object represents a quotation package.
35 FS::quotation_pkg inherits from FS::Record. The following fields are currently
46 pkgpart (L<FS::part_pkg>) of the package
50 locationnum (L<FS::cust_location>) where the package will be in service
54 expected start date for the package, as a timestamp
66 'Y' to waive the setup fee
70 The amount per package that will be charged in setup/one-time fees.
74 The amount per package that will be charged per billing cycle.
84 Creates a new quotation package. To add the quotation package to the database,
87 Note that this stores the hash reference, not a distinct copy of the hash it
88 points to. You can ask the object for a copy with the I<hash> method.
92 sub table { 'quotation_pkg'; }
94 sub display_table { 'quotation_pkg'; }
96 #forget it, just overriding cust_bill_pkg_display entirely
97 #sub display_table_orderby { 'quotationpkgnum'; } # something else?
98 # # (for invoice display order)
100 sub discount_table { 'quotation_pkg_discount'; }
101 sub detail_table { 'quotation_pkg_detail'; }
105 Adds this record to the database. If there is an error, returns the error,
106 otherwise returns false.
111 my ($self, %options) = @_;
114 my $oldAutoCommit = $FS::UID::AutoCommit;
115 local $FS::UID::AutoCommit = 0;
117 my $error = $self->SUPER::insert;
119 if ( !$error and $self->discountnum ) {
120 $error = $self->insert_discount;
121 $error .= ' (setting discount)' if $error;
124 # update $self and any discounts with their amounts
126 $error = $self->estimate;
127 $error .= ' (calculating charges)' if $error;
131 $dbh->rollback if $oldAutoCommit;
134 $dbh->commit if $oldAutoCommit;
141 Delete this record from the database.
149 my $oldAutoCommit = $FS::UID::AutoCommit;
150 local $FS::UID::AutoCommit = 0;
152 my $error = $self->delete_details;
154 $dbh->rollback if $oldAutoCommit;
158 foreach ($self->quotation_pkg_discount, $self->quotation_pkg_tax) {
161 $dbh->rollback if $oldAutoCommit;
162 return $error . ' (deleting discount)';
166 $error = $self->SUPER::delete;
168 $dbh->rollback if $oldAutoCommit;
171 $dbh->commit if $oldAutoCommit;
177 =item replace OLD_RECORD
179 Replaces the OLD_RECORD with this one in the database. If there is an error,
180 returns the error, otherwise returns false.
184 Checks all fields to make sure this is a valid quotation package. If there is
185 an error, returns the error, otherwise returns false. Called by the insert
194 $self->ut_numbern('quotationpkgnum')
195 || $self->ut_foreign_key( 'quotationnum', 'quotation', 'quotationnum' )
196 || $self->ut_foreign_key( 'pkgpart', 'part_pkg', 'pkgpart' )
197 || $self->ut_foreign_keyn( 'locationnum', 'cust_location', 'locationnum' )
198 || $self->ut_numbern('start_date')
199 || $self->ut_numbern('contract_end')
200 || $self->ut_numbern('quantity')
201 || $self->ut_moneyn('unitsetup')
202 || $self->ut_moneyn('unitrecur')
203 || $self->ut_enum('waive_setup', [ '', 'Y'] )
206 if ($self->locationnum eq '') {
207 # use the customer default
208 my $quotation = $self->quotation;
209 if ($quotation->custnum) {
210 $self->set('locationnum', $quotation->cust_main->ship_locationnum);
211 } elsif ($quotation->prospectnum) {
212 # use the first non-disabled location for that prospect
213 my $cust_location = qsearchs('cust_location',
214 { prospectnum => $quotation->prospectnum,
216 $self->set('locationnum', $cust_location->locationnum) if $cust_location;
217 } # else the quotation is invalid
220 return $error if $error;
227 qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart } );
232 $self->part_pkg->pkg;
237 Update the quotation_pkg record with the estimated setup and recurring
238 charges for the package. Returns nothing on success, or an error message
245 my $part_pkg = $self->part_pkg;
246 my $quantity = $self->quantity || 1;
247 my ($unitsetup, $unitrecur);
248 # calculate base fees
249 if ( $self->waive_setup eq 'Y' || $self->{'_NO_SETUP_KLUDGE'} ) {
252 $unitsetup = $part_pkg->option('setup_fee',1) || '0.00'; # XXX 3.x only
254 if ( $self->{'_NO_RECUR_KLUDGE'} ) {
257 $unitrecur = $part_pkg->base_recur;
262 $self->set('unitsetup', $unitsetup);
263 $self->set('unitrecur', $unitrecur);
264 my $error = $self->replace;
265 return $error if $error;
267 # semi-duplicates calc_discount
268 my $setup_discount = 0;
269 my $recur_discount = 0;
271 my %setup_discounts; # quotationpkgdiscountnum => amount
272 my %recur_discounts; # quotationpkgdiscountnum => amount
274 # XXX the order of applying discounts is ill-defined, which matters
275 # if there are percentage and amount discounts on the same package.
277 # but right now there can only be one discount on any package, so
279 foreach my $pkg_discount ($self->quotation_pkg_discount) {
281 my $discount = $pkg_discount->discount;
282 my $this_setup_discount = 0;
283 my $this_recur_discount = 0;
285 if ( $discount->percent > 0 ) {
287 if ( $discount->setup ) {
288 $this_setup_discount = ($discount->percent * $unitsetup / 100);
290 $this_recur_discount = ($discount->percent * $unitrecur / 100);
292 } elsif ( $discount->amount > 0 ) {
294 my $discount_left = $discount->amount;
295 if ( $discount->setup ) {
296 if ( $discount_left > $unitsetup - $setup_discount ) {
297 # then discount the setup to zero
298 $discount_left -= $unitsetup - $setup_discount;
299 $this_setup_discount = $unitsetup - $setup_discount;
301 # not enough discount to fully cover the setup
302 $this_setup_discount = $discount_left;
306 # same logic for recur
307 if ( $discount_left > $unitrecur - $recur_discount ) {
308 $this_recur_discount = $unitrecur - $recur_discount;
310 $this_recur_discount = $discount_left;
315 # increment the total discountage
316 $setup_discount += $this_setup_discount;
317 $recur_discount += $this_recur_discount;
318 # and update the pkg_discount object
319 $pkg_discount->set('setup_amount', sprintf('%.2f', $setup_discount));
320 $pkg_discount->set('recur_amount', sprintf('%.2f', $recur_discount));
321 my $error = $pkg_discount->replace;
322 return $error if $error;
328 =item insert_discount
330 Associates this package with a discount (see L<FS::cust_pkg_discount>,
331 possibly inserting a new discount on the fly (see L<FS::discount>). Properties
332 of the discount will be taken from this object.
336 sub insert_discount {
337 #my ($self, %options) = @_;
340 my $quotation_pkg_discount = FS::quotation_pkg_discount->new( {
341 'quotationpkgnum' => $self->quotationpkgnum,
342 'discountnum' => $self->discountnum,
343 #for the create a new discount case
344 '_type' => $self->discountnum__type,
345 'amount' => $self->discountnum_amount,
346 'percent' => $self->discountnum_percent,
347 'months' => $self->discountnum_months,
348 'setup' => $self->discountnum_setup,
351 $quotation_pkg_discount->insert;
356 my @pkg_discounts = $self->pkg_discount;
357 return if @pkg_discounts == 0;
362 description => $self->mt('Discount'),
366 ext_description => \@ext,
367 # maybe should show quantity/unit discount?
369 foreach my $pkg_discount (@pkg_discounts) {
370 push @ext, $pkg_discount->description;
371 $d->{setup_amount} -= $pkg_discount->setup_amount;
372 $d->{recur_amount} -= $pkg_discount->recur_amount;
374 $d->{setup_amount} *= $self->quantity || 1;
375 $d->{recur_amount} *= $self->quantity || 1;
376 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
383 ($self->unitsetup - sum(0, map { $_->setup_amount } $self->pkg_discount))
384 * ($self->quantity || 1);
387 sub setup_show_zero {
389 return $self->part_pkg->setup_show_zero;
394 ($self->unitrecur - sum(0, map { $_->recur_amount } $self->pkg_discount))
395 * ($self->quantity || 1);
398 sub recur_show_zero {
400 return $self->part_pkg->recur_show_zero;
405 Deletes all quotation_pkgs_details associated with this pkg (see L<FS::quotation_pkg_detail>).
412 my $oldAutoCommit = $FS::UID::AutoCommit;
413 local $FS::UID::AutoCommit = 0;
416 foreach my $detail ( qsearch('quotation_pkg_detail',{ 'quotationpkgnum' => $self->quotationpkgnum }) ) {
417 my $error = $detail->delete;
419 $dbh->rollback if $oldAutoCommit;
420 return "error removing old detail: $error";
424 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
429 =item set_details PARAM
431 Sets new quotation details for this package (see L<FS::quotation_pkg_detail>),
432 removing existing details.
434 Recognizes the following parameters:
436 details - arrayref of strings, one for each new detail
438 copy_on_order - if true, sets copy_on_order flag on new details
440 If there is an error, returns the error, otherwise returns false.
448 $opt{'details'} ||= [];
449 my @details = @{$opt{'details'}};
451 my $oldAutoCommit = $FS::UID::AutoCommit;
452 local $FS::UID::AutoCommit = 0;
455 my $error = $self->delete_details;
457 $dbh->rollback if $oldAutoCommit;
461 foreach my $detail ( @details ) {
462 my $quotation_pkg_detail = new FS::quotation_pkg_detail {
463 'quotationpkgnum' => $self->quotationpkgnum,
465 'copy_on_order' => $opt{'copy_on_order'} ? 'Y' : '',
467 $error = $quotation_pkg_detail->insert;
469 $dbh->rollback if $oldAutoCommit;
470 return "error adding new detail: $error";
474 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
483 =item cust_bill_pkg_display [ type => TYPE ]
487 sub cust_bill_pkg_display {
488 my ( $self, %opt ) = @_;
490 my $type = $opt{type} if exists $opt{type};
491 return () if $type eq 'U'; #quotations don't have usage
493 if ( $self->get('display') ) {
494 return ( grep { defined($type) ? ($type eq $_->type) : 1 }
495 @{ $self->get('display') }
500 my $setup = $self->new($self->hashref);
501 $setup->{'_NO_RECUR_KLUDGE'} = 1;
502 $setup->{'type'} = 'S';
503 my $recur = $self->new($self->hashref);
504 $recur->{'_NO_SETUP_KLUDGE'} = 1;
505 $recur->{'type'} = 'R';
507 if ( $type eq 'S' ) {
509 } elsif ( $type eq 'R' ) {
512 #return ($setup, $recur);
522 Returns the customer (L<FS::cust_main> object).
528 my $quotation = FS::quotation->by_key($self->quotationnum) or return '';
529 $quotation->cust_main;
532 sub tax_locationnum {
541 FS::quotation->by_key($self->quotationnum);
544 sub quotation_pkg_detail {
546 sort { $a->detailnum <=> $b->detailnum }
547 qsearch('quotation_pkg_detail', { quotationpkgnum => $self->quotationpkgnum });
550 sub quotation_pkg_discount {
552 qsearch('quotation_pkg_discount', { quotationpkgnum => $self->quotationpkgnum });
555 sub quotation_pkg_tax {
557 qsearch('quotation_pkg_tax', { quotationpkgnum => $self->quotationpkgnum });
562 $self->locationnum ? qsearchs('cust_location', { locationnum => $self->locationnum }) : '';
568 my @quotation_pkg_without_location =
569 qsearch( 'quotation_pkg', { locationnum => '' } );
570 if (@quotation_pkg_without_location) {
571 warn "setting default location on quotation_pkg records\n";
572 foreach my $quotation_pkg (@quotation_pkg_without_location) {
573 # check() will fix this
574 my $error = $quotation_pkg->replace;
576 die "quotation #".$quotation_pkg->quotationnum.": $error\n";
587 Doesn't support fees, or add-on packages.
591 L<FS::Record>, schema.html from the base documentation.