Difference between revisions of "Freeside:3:Documentation:Developer/FS/vend pay"

Latest revision as of 06:37, 24 March 2015

NAME

FS::vend_pay - Object methods for vend_pay records

SYNOPSIS

 use FS::vend_pay;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::vend_pay object represents a vendor payment. FS::vend_pay inherits from FS::Record. The following fields are currently supported:

vendpaynum

primary key

vendnum

vendnum

_date

_date

paid

paid

METHODS

new HASHREF

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

BUGS

SEE ALSO

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