summaryrefslogtreecommitdiff
path: root/FS/FS/quotation_pkg_tax.pm
blob: c6222ac33a83c268fc8631b88cc23ae09e6cc825 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
package FS::quotation_pkg_tax;

use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
use FS::cust_main_county;
use FS::quotation_pkg;

=head1 NAME

FS::quotation_pkg_tax - Object methods for quotation_pkg_tax records

=head1 SYNOPSIS

  use FS::quotation_pkg_tax;

  $record = new FS::quotation_pkg_tax \%hash;
  $record = new FS::quotation_pkg_tax { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::quotation_pkg_tax object represents tax on a quoted package. 
FS::quotation_pkg_tax inherits from FS::Record (though it should eventually
inherit from some shared superclass of L<FS::cust_bill_pkg_tax_location>). 
The following fields are currently supported:

=over 4

=item quotationtaxnum - primary key

=item quotationpkgnum - the L<FS::quotation_pkg> record that the tax applies 
to.

=item itemdesc - the name of the tax

=item setup_amount - the amount of tax calculated on one-time charges

=item recur_amount - the amount of tax calculated on recurring charges

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new estimated tax amount.  To add the record to the database, 
see L<"insert">.

=cut

sub table { 'quotation_pkg_tax'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=item replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=item check

Checks all fields to make sure this is a valid example.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('quotationtaxnum')
    || $self->ut_foreign_key('quotationpkgnum', 'quotation_pkg', 'quotationpkgnum')
    || $self->ut_text('itemdesc')
    || $self->ut_money('setup_amount')
    || $self->ut_money('recur_amount')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;