FS::commission_rate

NAME

FS::commission_rate - Object methods for commission_rate records

SYNOPSIS

  use FS::commission_rate;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

DESCRIPTION

An FS::commission_rate object represents a commission rate (a percentage or a flat amount) that will be paid on a customer's N-th invoice. The sequence of commissions that will be paid on consecutive invoices is the parent object, FS::commission_schedule.

FS::commission_rate inherits from FS::Record. The following fields are currently supported:

commissionratenum - primary key

schedulenum - FS::commission_schedule foreign key

cycle - the ordinal of the billing cycle this commission will apply to. cycle = 1 applies to the customer's first invoice, cycle = 2 to the second, etc.

amount - the flat amount to pay per invoice in commission

percent - the percentage of the invoice amount to pay in commission

METHODS

new HASHREF

Creates a new commission rate. To add it to the database, see "insert".

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 commission rate. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

FS::Record