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
|
package FS::cust_credit_bill;
use base qw( FS::cust_main_Mixin FS::cust_bill_ApplicationCommon );
use strict;
use vars qw( $conf );
use FS::UID;
#ask FS::UID to run this stuff for us later
FS::UID->install_callback( sub {
$conf = new FS::Conf;
} );
=head1 NAME
FS::cust_credit_bill - Object methods for cust_credit_bill records
=head1 SYNOPSIS
use FS::cust_credit_bill;
$record = new FS::cust_credit_bill \%hash;
$record = new FS::cust_credit_bill { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::cust_credit_bill object represents application of a credit (see
L<FS::cust_credit>) to an invoice (see L<FS::cust_bill>). FS::cust_credit_bill
inherits from FS::cust_bill_ApplicationCommon and FS::Record. The following
fields are currently supported:
=over 4
=item creditbillnum - primary key
=item crednum - credit being applied
=item invnum - invoice to which credit is applied (see L<FS::cust_bill>)
=item amount - amount of the credit applied
=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
L<Time::Local> and L<Date::Parse> for conversion functions.
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new cust_credit_bill. To add the cust_credit_bill to the database,
see L<"insert">.
=cut
sub table { 'cust_credit_bill'; }
sub _app_source_name { 'credit'; }
sub _app_source_table { 'cust_credit'; }
sub _app_lineitem_breakdown_table { 'cust_credit_bill_pkg'; }
sub _app_part_pkg_weight_column { 'credit_weight'; }
=item insert
Adds this cust_credit_bill to the database ("Posts" all or part of a credit).
If there is an error, returns the error, otherwise returns false.
=item delete
Currently unimplemented.
=cut
sub delete {
my $self = shift;
return "Can't delete application for closed credit"
if $self->cust_credit->closed =~ /^Y/i;
return "Can't delete application for closed invoice"
if $self->cust_bill->closed =~ /^Y/i;
$self->SUPER::delete(@_);
}
=item replace OLD_RECORD
Application of credits may not be modified.
=cut
sub replace {
return "Can't modify application of credit!"
}
=item check
Checks all fields to make sure this is a valid credit application. 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('creditbillnum')
|| $self->ut_foreign_key('crednum', 'cust_credit', 'crednum')
|| $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
|| $self->ut_numbern('_date')
|| $self->ut_money('amount')
|| $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
;
return $error if $error;
return "amount must be > 0" if $self->amount <= 0;
$self->_date(time) unless $self->_date;
return "Cannot apply more than remaining value of credit"
unless $self->amount <= $self->cust_credit->credited;
return "Cannot apply more than remaining value of invoice"
unless $self->amount <= $self->cust_bill->owed;
$self->SUPER::check;
}
=item sub cust_credit
Returns the credit (see L<FS::cust_credit>)
=back
=head1 BUGS
The delete method.
This probably should have been called cust_bill_credit.
=head1 SEE ALSO
L<FS::Record>, L<FS::cust_bill>, L<FS::cust_credit>,
schema.html from the base documentation.
=cut
1;
|
