View source for Freeside:4:Documentation:Developer/FS/cust bill batch option

==NAME==
FS::cust_bill_batch_option - Object methods for cust_bill_batch_option records

==SYNOPSIS==
<code>
  use FS::cust_bill_batch_option;
 
  $record = new FS::cust_bill_batch_option \%hash;
  $record = new FS::cust_bill_batch_option { 'column' => 'value' };
 
  $error = $record->insert;
 
  $error = $new_record->replace($old_record);
 
  $error = $record->delete;
 
  $error = $record->check;
</code>
==DESCRIPTION==
An FS::cust_bill_batch_option object represents an option key and value for an invoice batch entry. FS::cust_bill_batch_option inherits from FS::Record. The following fields are currently supported:

; optionnum - primary key; billbatchnum -; optionname -; optionvalue -
==METHODS==
; new HASHREF
:Creates a new option. To add the option to the database, see [[#insert|"insert"]].

:Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the ''hash'' method.
; insert
:Adds this record to the database. If there is an error, returns the error, otherwise returns false.
; delete
:Delete this record from the database.
; replace OLD_RECORD
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
; check
:Checks all fields to make sure this is a valid option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

==BUGS==
==SEE ALSO==
[[Freeside:4:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.