Freeside:3:Documentation:Developer/FS/pay batch

NAME

FS::pay_batch - Object methods for pay_batch records

SYNOPSIS

 use FS::pay_batch;

 $record = new FS::pay_batch \%hash;
 $record = new FS::pay_batch { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::pay_batch object represents an payment batch. FS::pay_batch inherits from FS::Record. The following fields are currently supported:

batchnum - primary key; agentnum - optional agent number for agent batches; payby - CARD or CHEK; status - O (Open), I (In-transit), or R (Resolved); download -; upload -

METHODS

new HASHREF

Creates a new batch. To add the batch to the database, see "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 batch. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

agent

Returns the FS::agent object for this template.

rebalance; set_status; import_results OPTION => VALUE, ...

Import batch results.

Options are:

filehandle - open filehandle of results file.

format - "csv-td_canada_trust-merchant_pc_batch", "csv-chase_canada-E-xactBatch", "ach-spiritone", or "PAP"

BUGS

status is somewhat redundant now that download and upload exist

SEE ALSO

FS::Record, schema.html from the base documentation.