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 =item sdate - starting date of recurring fee
  48
  49 =item edate - ending date of recurring fee
  50
  51 =back
  52
  53 sdate and edate are specified as UNIX timestamps; see L<perlfunc/"time">.  Also
  54 see L<Time::Local> and L<Date::Parse> for conversion functions.
  55
  56 =head1 METHODS
  57
  58 =over 4
  59
  60 =item new HASHREF
  61
  62 Creates a new record.  To add the record to the database, see L<"insert">.
  63
  64 Note that this stores the hash reference, not a distinct copy of the hash it
  65 points to.  You can ask the object for a copy with the I<hash> method.
  66
  67 =cut
  68
  69 # the new method can be inherited from FS::Record, if a table method is defined
  70
  71 sub table { 'cust_bill_pay_pkg'; }
  72
  73 =item insert
  74
  75 Adds this record to the database.  If there is an error, returns the error,
  76 otherwise returns false.
  77
  78 =cut
  79
  80 # the insert method can be inherited from FS::Record
  81
  82 =item delete
  83
  84 Delete this record from the database.
  85
  86 =cut
  87
  88 # the delete method can be inherited from FS::Record
  89
  90 =item replace OLD_RECORD
  91
  92 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  93 returns the error, otherwise returns false.
  94
  95 =cut
  96
  97 # the replace method can be inherited from FS::Record
  98
  99 =item check
 100
 101 Checks all fields to make sure this is a valid payment application.  If there
 102 is an error, returns the error, otherwise returns false.  Called by the insert
 103 and replace methods.
 104
 105 =cut
 106
 107 # the check method should currently be supplied - FS::Record contains some
 108 # data checking routines
 109
 110 sub check {
 111   my $self = shift;
 112
 113   my $error =
 114     $self->ut_numbern('billpaypkgnum')
 115     || $self->ut_foreign_key('billpaynum', 'cust_bill_pay', 'billpaynum' )
 116     || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum' )
 117     || $self->ut_money('amount')
 118     || $self->ut_enum('setuprecur', [ 'setup', 'recur' ] )
 119     || $self->ut_numbern('sdate')
 120     || $self->ut_numbern('edate')
 121   ;
 122   return $error if $error;
 123
 124   $self->SUPER::check;
 125 }
 126
 127 =back
 128
 129 =head1 BUGS
 130
 131 B<setuprecur> field is a kludge to compensate for cust_bill_pkg having separate
 132 setup and recur fields.  It should be removed once that's fixed.
 133
 134 =head1 SEE ALSO
 135
 136 L<FS::Record>, schema.html from the base documentation.
 137
 138 =cut
 139
 140 1;
 141