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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
package FS::cust_bill_void;
use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
use strict;
use FS::Record qw( qsearchs ); #qsearch );
use FS::cust_main;
use FS::cust_statement;
use FS::access_user;
=head1 NAME
FS::cust_bill_void - Object methods for cust_bill_void records
=head1 SYNOPSIS
use FS::cust_bill_void;
$record = new FS::cust_bill_void \%hash;
$record = new FS::cust_bill_void { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_bill_void object represents a voided invoice. FS::cust_bill_void
inherits from FS::Record. The following fields are currently supported:
=over 4
=item invnum
primary key
=item custnum
custnum
=item _date
_date
=item charged
charged
=item invoice_terms
invoice_terms
=item previous_balance
previous_balance
=item billing_balance
billing_balance
=item closed
closed
=item statementnum
statementnum
=item agent_invid
agent_invid
=item promised_date
promised_date
=item void_date
void_date
=item reason
reason
=item void_usernum
void_usernum
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new voided invoice. To add the voided invoice 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
sub table { 'cust_bill_void'; }
sub notice_name { 'VOIDED Invoice'; }
#XXXsub template_conf { 'quotation_'; }
=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 voided invoice. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_number('invnum')
|| $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
|| $self->ut_numbern('_date')
|| $self->ut_money('charged')
|| $self->ut_textn('invoice_terms')
|| $self->ut_moneyn('previous_balance')
|| $self->ut_moneyn('billing_balance')
|| $self->ut_enum('closed', [ '', 'Y' ])
|| $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum')
|| $self->ut_numbern('agent_invid')
|| $self->ut_numbern('promised_date')
|| $self->ut_numbern('void_date')
|| $self->ut_textn('reason')
|| $self->ut_numbern('void_usernum')
;
return $error if $error;
$self->void_date(time) unless $self->void_date;
$self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
unless $self->void_usernum;
$self->SUPER::check;
}
=item display_invnum
Returns the displayed invoice number for this invoice: agent_invid if
cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
=cut
sub display_invnum {
my $self = shift;
my $conf = $self->conf;
if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
return $self->agent_invid;
} else {
return $self->invnum;
}
}
=item void_access_user
Returns the voiding employee object (see L<FS::access_user>).
=cut
sub void_access_user {
my $self = shift;
qsearchs('access_user', { 'usernum' => $self->void_usernum } );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
