PayItemTemplate Object

Manages the maintenance of a Pay ItemTemplate object.
Property Description
Basis Long - Pay item's basis, or units
Bases Textlist object - containing a list of valid Basis
CalcMethod String - One a set of pre-defined calculation methods. Defines how the cash and/or units for a pay item is calculated.
CalcMethods Textlist object - containing a list of valid CalcMethods
CostCodeId Long - database identifier for the cost code associated with this item
Deduction Boolean - true if this pay item is subtracted from a payee's pay calculation.
Description String - Item description
ExpenseCodeId Long - database identifier for the expense code associated with this item
Id Long - database identifier for this item (read only)
IsDeleted True/False - item has been flagged for deletion
IsDirty True/False - item has been modified but not saved yet
IsEditing True/false - item is in the process of being edited
IsNew True/false - item is new and has not been saved
IsValid True/false - indicates if the item has any errors
LeaveTypeId Long - database identifier for the leave type code associated with this item. Zero if none.
Maximum Currency - maximum value for the calculated amount of this pay item.
Benefit Boolean - true if this pay item is an benefit (employer sponsored, or overhead)
PayItemTemplateProperties Collection - containing a set of pay item template property objects
Repeating Boolean - true if this pay item is carried forward automatically to the next pay period by the open period process.

In order to apply any changes to an object, the BeginEdit method must be called setting any property values. To save the changes, call the ApplyEdit method, and to undo the changes call the CancelEdit method.

Method Description
ApplyEdit(Server, Connection) Saves the item in the database. Server is a string containing the name of the network server to provide the data, and Connection is the ADO connection string to establish a connection with the database on that server.
BeginEdit Prepares the item for updating.
CancelEdit Reverses the changes in the current edit session and restores the state of the item to that preceding the last BeginEdit.
Delete Flags the item for deletion. The item will be deleted from the database when the next ApplyEdit is called. A Delete must be preceded by a BeginEdit.
Load(Server, Connection, PayItemTemplateId) Loads into this object the data from the database for the specified database record id.