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) to an invoice (see L). 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) =item amount - amount of the credit applied =item _date - specified as a UNIX timestamp; see L. Also see L and L 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) =back =head1 BUGS The delete method. This probably should have been called cust_bill_credit. =head1 SEE ALSO L, L, L, schema.html from the base documentation. =cut 1;