Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/pay batch"
From Freeside
(import from POD) |
(import from POD) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 18: | Line 18: | ||
</code> | </code> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| − | An FS::pay_batch object represents an | + | 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; payby - CARD or CHEK; status - O (Open), I (In-transit), or R (Resolved); download -; upload - | ; batchnum - primary key; payby - CARD or CHEK; status - O (Open), I (In-transit), or R (Resolved); download -; upload - | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
| − | :Creates a new | + | :Creates a new batch. To add the batch 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. | :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. | ||
| Line 33: | Line 33: | ||
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | :Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false. | ||
; check | ; check | ||
| − | :Checks all fields to make sure this is a valid | + | :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. |
; rebalance; set_status; import_results OPTION => VALUE, ... | ; rebalance; set_status; import_results OPTION => VALUE, ... | ||
:Import batch results. | :Import batch results. | ||
Latest revision as of 17:26, 3 October 2007
Contents
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; 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.
- 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.
