1 package FS::cust_credit_bill;
4 use vars qw( @ISA $conf );
5 use FS::UID qw( getotaker );
6 use FS::Record qw( qsearch qsearchs );
7 use FS::cust_bill_ApplicationCommon;
11 @ISA = qw( FS::cust_bill_ApplicationCommon );
13 #ask FS::UID to run this stuff for us later
14 FS::UID->install_callback( sub {
20 FS::cust_credit_bill - Object methods for cust_credit_bill records
24 use FS::cust_credit_bill;
26 $record = new FS::cust_credit_bill \%hash;
27 $record = new FS::cust_credit_bill { 'column' => 'value' };
29 $error = $record->insert;
31 $error = $new_record->replace($old_record);
33 $error = $record->delete;
35 $error = $record->check;
39 An FS::cust_credit_bill object represents application of a credit (see
40 L<FS::cust_credit>) to an invoice (see L<FS::cust_bill>). FS::cust_credit_bill
41 inherits from FS::cust_bill_ApplicationCommon and FS::Record. The following
42 fields are currently supported:
46 =item creditbillnum - primary key
48 =item crednum - credit being applied
50 =item invnum - invoice to which credit is applied (see L<FS::cust_bill>)
52 =item amount - amount of the credit applied
54 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
55 L<Time::Local> and L<Date::Parse> for conversion functions.
65 Creates a new cust_credit_bill. To add the cust_credit_bill to the database,
70 sub table { 'cust_credit_bill'; }
72 sub _app_source_name { 'credit'; }
73 sub _app_source_table { 'cust_credit'; }
74 sub _app_lineitem_breakdown_table { 'cust_credit_bill_pkg'; }
78 Adds this cust_credit_bill to the database ("Posts" all or part of a credit).
79 If there is an error, returns the error, otherwise returns false.
83 Currently unimplemented.
89 return "Can't delete application for closed credit"
90 if $self->cust_credit->closed =~ /^Y/i;
91 return "Can't delete application for closed invoice"
92 if $self->cust_bill->closed =~ /^Y/i;
93 $self->SUPER::delete(@_);
96 =item replace OLD_RECORD
98 Application of credits may not be modified.
103 return "Can't modify application of credit!"
108 Checks all fields to make sure this is a valid credit application. If there
109 is an error, returns the error, otherwise returns false. Called by the insert
118 $self->ut_numbern('creditbillnum')
119 || $self->ut_foreign_key('crednum', 'cust_credit', 'crednum')
120 || $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
121 || $self->ut_numbern('_date')
122 || $self->ut_money('amount')
124 return $error if $error;
126 return "amount must be > 0" if $self->amount <= 0;
128 $self->_date(time) unless $self->_date;
130 return "Cannot apply more than remaining value of credit"
131 unless $self->amount <= $self->cust_credit->credited;
133 return "Cannot apply more than remaining value of invoice"
134 unless $self->amount <= $self->cust_bill->owed;
139 =item sub cust_credit
141 Returns the credit (see L<FS::cust_credit>)
147 qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
156 This probably should have been called cust_bill_credit.
160 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_credit>,
161 schema.html from the base documentation.