1 package FS::cust_credit_bill_pkg;
5 use FS::Record qw( qsearch qsearchs );
11 FS::cust_credit_bill_pkg - Object methods for cust_credit_bill_pkg records
15 use FS::cust_credit_bill_pkg;
17 $record = new FS::cust_credit_bill_pkg \%hash;
18 $record = new FS::cust_credit_bill_pkg { 'column' => 'value' };
20 $error = $record->insert;
22 $error = $new_record->replace($old_record);
24 $error = $record->delete;
26 $error = $record->check;
30 An FS::cust_credit_bill_pkg object represents application of a credit (see
31 L<FS::cust_credit_bill>) to a specific line item within an invoice
32 (see L<FS::cust_bill_pkg>). FS::cust_credit_bill_pkg inherits from FS::Record.
33 The following fields are currently supported:
37 =item creditbillpkg - primary key
39 =item creditbillnum - Credit application to the overall invoice (see L<FS::cust_credit::bill>)
41 =item billpkgnum - Line item to which credit is applied (see L<FS::cust_bill_pkg>)
43 =item amount - Amount of the credit applied to this line item.
45 =item setuprecur - 'setup' or 'recur', designates whether the payment was applied to the setup or recurring portion of the line item.
47 =item sdate - starting date of recurring fee
49 =item edate - ending date of recurring fee
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.
62 Creates a new example. To add the example to the database, see L<"insert">.
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.
69 # the new method can be inherited from FS::Record, if a table method is defined
71 sub table { 'cust_credit_bill_pkg'; }
75 Adds this record to the database. If there is an error, returns the error,
76 otherwise returns false.
80 # the insert method can be inherited from FS::Record
84 Delete this record from the database.
88 # the delete method can be inherited from FS::Record
90 =item replace OLD_RECORD
92 Replaces the OLD_RECORD with this one in the database. If there is an error,
93 returns the error, otherwise returns false.
97 # the replace method can be inherited from FS::Record
101 Checks all fields to make sure this is a valid credit applicaiton. If there is
102 an error, returns the error, otherwise returns false. Called by the insert
107 # the check method should currently be supplied - FS::Record contains some
108 # data checking routines
114 $self->ut_numbern('creditbillpkgnum')
115 || $self->ut_foreign_key('creditbillnum', 'cust_credit_bill', 'creditbillnum')
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')
122 return $error if $error;
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.
136 L<FS::Record>, schema.html from the base documentation.