summaryrefslogtreecommitdiff
path: root/FS/FS/rt_field_charge.pm
blob: fb01f810e27949ca1ca0ae17f93ec9b38be7180a (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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
package FS::rt_field_charge;
use base qw( FS::Record );

use strict;
use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::rt_field_charge - Object methods for rt_field_charge records

=head1 SYNOPSIS

  use FS::rt_field_charge;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::rt_field_charge object represents an individual charge
that has been added to an invoice by a package with the rt_field price plan.
FS::rt_field_charge inherits from FS::Record.
The following fields are currently supported:

=over 4

=item rtfieldchargenum - primary key

=item pkgnum - cust_pkg that generated the charge

=item ticketid - RT ticket that generated the charge

=item rate - the rate per unit for the charge

=item units - quantity of units being charged

=item charge - the total amount charged

=item _date - billing date for the charge

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new object.  To add the object to the database, see L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'rt_field_charge'; }

=item insert

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

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=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.

=cut

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid object.  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('rtfieldchargenum')
    || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum' )
    || $self->ut_number('ticketid')
    || $self->ut_money('rate')
    || $self->ut_float('units')
    || $self->ut_money('charge')
    || $self->ut_number('_date')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS



=head1 SEE ALSO

L<FS::Record>

=cut

1;