FS/FS/cust_bill_pay_pkg.pm

   1 package FS::cust_bill_pay_pkg;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 @ISA = qw(FS::Record);
   8
   9 =head1 NAME
  10
  11 FS::cust_bill_pay_pkg - Object methods for cust_bill_pay_pkg records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_bill_pay_pkg;
  16
  17   $record = new FS::cust_bill_pay_pkg \%hash;
  18   $record = new FS::cust_bill_pay_pkg { 'column' => 'value' };
  19
  20   $error = $record->insert;
  21
  22   $error = $new_record->replace($old_record);
  23
  24   $error = $record->delete;
  25
  26   $error = $record->check;
  27
  28 =head1 DESCRIPTION
  29
  30 An FS::cust_bill_pay_pkg object represents application of a payment (see
  31 L<FS::cust_bill_pay>) to a specific line item within an invoice (see
  32 L<FS::cust_bill_pkg>).  FS::cust_bill_pay_pkg inherits from FS::Record.  The
  33 following fields are currently supported:
  34
  35 =over 4
  36
  37 =item billpaypkgnum - primary key
  38
  39 =item billpaynum - Payment application to the overall invoice (see L<FS::cust_bill_pay>)
  40
  41 =item billpkgnum -  Line item to which payment is applied (see L<FS::cust_bill_pkg>)
  42
  43 =item amount - Amount of the payment applied to this line item.
  44
  45 =item setuprecur - 'setup' or 'recur', designates whether the payment was applied to the setup or recurring portion of the line item.
  46
  47 =back
  48
  49 =head1 METHODS
  50
  51 =over 4
  52
  53 =item new HASHREF
  54
  55 Creates a new record.  To add the record to the database, see L<"insert">.
  56
  57 Note that this stores the hash reference, not a distinct copy of the hash it
  58 points to.  You can ask the object for a copy with the I<hash> method.
  59
  60 =cut
  61
  62 # the new method can be inherited from FS::Record, if a table method is defined
  63
  64 sub table { 'cust_bill_pay_pkg'; }
  65
  66 =item insert
  67
  68 Adds this record to the database.  If there is an error, returns the error,
  69 otherwise returns false.
  70
  71 =cut
  72
  73 # the insert method can be inherited from FS::Record
  74
  75 =item delete
  76
  77 Delete this record from the database.
  78
  79 =cut
  80
  81 # the delete method can be inherited from FS::Record
  82
  83 =item replace OLD_RECORD
  84
  85 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  86 returns the error, otherwise returns false.
  87
  88 =cut
  89
  90 # the replace method can be inherited from FS::Record
  91
  92 =item check
  93
  94 Checks all fields to make sure this is a valid payment application.  If there
  95 is an error, returns the error, otherwise returns false.  Called by the insert
  96 and replace methods.
  97
  98 =cut
  99
 100 # the check method should currently be supplied - FS::Record contains some
 101 # data checking routines
 102
 103 sub check {
 104   my $self = shift;
 105
 106   my $error =
 107     $self->ut_numbern('billpaypkgnum')
 108     || $self->ut_foreign_key('billpaynum', 'cust_bill_pay', 'billpaynum' )
 109     || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
 110     || $self->ut_money('amount')
 111     || $self->ut_enum('setuprecur', [ 'setup', 'recur' ] )
 112   ;
 113   return $error if $error;
 114
 115   $self->SUPER::check;
 116 }
 117
 118 =back
 119
 120 =head1 BUGS
 121
 122 B<setuprecur> field is a kludge to compensate for cust_bill_pkg having separate
 123 setup and recur fields.  It should be removed once that's fixed.
 124
 125 =head1 SEE ALSO
 126
 127 L<FS::Record>, schema.html from the base documentation.
 128
 129 =cut
 130
 131 1;
 132