FS/FS/cust_credit_bill.pm

   1 package FS::cust_credit_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $conf );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::cust_main_Mixin;
   7 use FS::cust_bill_ApplicationCommon;
   8 use FS::cust_bill;
   9 use FS::cust_credit;
  10 use FS::cust_pkg;
  11
  12 @ISA = qw( FS::cust_main_Mixin FS::cust_bill_ApplicationCommon );
  13
  14 #ask FS::UID to run this stuff for us later
  15 FS::UID->install_callback( sub {
  16   $conf = new FS::Conf;
  17 } );
  18
  19 =head1 NAME
  20
  21 FS::cust_credit_bill - Object methods for cust_credit_bill records
  22
  23 =head1 SYNOPSIS
  24
  25   use FS::cust_credit_bill;
  26
  27   $record = new FS::cust_credit_bill \%hash;
  28   $record = new FS::cust_credit_bill { 'column' => 'value' };
  29
  30   $error = $record->insert;
  31
  32   $error = $new_record->replace($old_record);
  33
  34   $error = $record->delete;
  35
  36   $error = $record->check;
  37
  38 =head1 DESCRIPTION
  39
  40 An FS::cust_credit_bill object represents application of a credit (see
  41 L<FS::cust_credit>) to an invoice (see L<FS::cust_bill>).  FS::cust_credit_bill
  42 inherits from FS::cust_bill_ApplicationCommon and FS::Record.  The following
  43 fields are currently supported:
  44
  45 =over 4
  46
  47 =item creditbillnum - primary key
  48
  49 =item crednum - credit being applied
  50
  51 =item invnum - invoice to which credit is applied (see L<FS::cust_bill>)
  52
  53 =item amount - amount of the credit applied
  54
  55 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  56 L<Time::Local> and L<Date::Parse> for conversion functions.
  57
  58 =back
  59
  60 =head1 METHODS
  61
  62 =over 4
  63
  64 =item new HASHREF
  65
  66 Creates a new cust_credit_bill.  To add the cust_credit_bill to the database,
  67 see L<"insert">.
  68
  69 =cut
  70
  71 sub table { 'cust_credit_bill'; }
  72
  73 sub _app_source_name  { 'credit'; }
  74 sub _app_source_table { 'cust_credit'; }
  75 sub _app_lineitem_breakdown_table { 'cust_credit_bill_pkg'; }
  76 sub _app_part_pkg_weight_column { 'credit_weight'; }
  77
  78 =item insert
  79
  80 Adds this cust_credit_bill to the database ("Posts" all or part of a credit).
  81 If there is an error, returns the error, otherwise returns false.
  82
  83 =item delete
  84
  85 Currently unimplemented.
  86
  87 =cut
  88
  89 sub delete {
  90   my $self = shift;
  91   return "Can't delete application for closed credit"
  92     if $self->cust_credit->closed =~ /^Y/i;
  93   return "Can't delete application for closed invoice"
  94     if $self->cust_bill->closed =~ /^Y/i;
  95   $self->SUPER::delete(@_);
  96 }
  97
  98 =item replace OLD_RECORD
  99
 100 Application of credits may not be modified.
 101
 102 =cut
 103
 104 sub replace {
 105   return "Can't modify application of credit!"
 106 }
 107
 108 =item check
 109
 110 Checks all fields to make sure this is a valid credit application.  If there
 111 is an error, returns the error, otherwise returns false.  Called by the insert
 112 and replace methods.
 113
 114 =cut
 115
 116 sub check {
 117   my $self = shift;
 118
 119   my $error =
 120     $self->ut_numbern('creditbillnum')
 121     || $self->ut_foreign_key('crednum', 'cust_credit', 'crednum')
 122     || $self->ut_foreign_key('invnum', 'cust_bill', 'invnum' )
 123     || $self->ut_numbern('_date')
 124     || $self->ut_money('amount')
 125     || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
 126   ;
 127   return $error if $error;
 128
 129   return "amount must be > 0" if $self->amount <= 0;
 130
 131   $self->_date(time) unless $self->_date;
 132
 133   return "Cannot apply more than remaining value of credit"
 134     unless $self->amount <= $self->cust_credit->credited;
 135
 136   return "Cannot apply more than remaining value of invoice"
 137     unless $self->amount <= $self->cust_bill->owed;
 138
 139   $self->SUPER::check;
 140 }
 141
 142 =item sub cust_credit
 143
 144 Returns the credit (see L<FS::cust_credit>)
 145
 146 =cut
 147
 148 sub cust_credit {
 149   my $self = shift;
 150   qsearchs( 'cust_credit', { 'crednum' => $self->crednum } );
 151 }
 152
 153 =back
 154
 155 =head1 BUGS
 156
 157 The delete method.
 158
 159 This probably should have been called cust_bill_credit.
 160
 161 =head1 SEE ALSO
 162
 163 L<FS::Record>, L<FS::cust_bill>, L<FS::cust_credit>,
 164 schema.html from the base documentation.
 165
 166 =cut
 167
 168 1;
 169