ScheduleItem Object

Manages the maintenance of a Schedule Item within a ScheduleItems collection.
Property Description
AccountName String - Deduction bank account name
AccountNo String - Deduction bank account number
AccountRef String - Deduction bank transaction reference
Cash Currency - calculated cash amount for this pay item
CashOverride Currency - manual override of cash amount for this pay item
CostCodeId Long - database record identifier for this object's cost code
DCInd String - Y if this is the first direct credit to the deduction's bank account
Id Long - database identifier for this item (read only)
Index Long - subscript of this item within a PayeeRates collection
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
NextDate Variant date - next date that the scheduled item is to be processed
NextDateInRange (StartDate, EndDate, Save) Boolean - true if one of the scheduled item dates is in the Start/End date range according to the current NextDate and the item's frequency.
Occurrences Long - the remaining number of occurrences that the item will be processed
PayeeId Long - database record identifier for this object's payee
PayGroupId Long - database record identifier for this object's pay group
PayItemId Long - database record identifier for this object's pay item
PayType Long - the type of payslip that the scheduled item is to be added
PayTypes Textlist object - containing a list of valid pay types
Processed Boolean - true if this item has been processed in the current pay
ReducingBalance Currency - outstanding balance for the pay item, if this is a 'ReducingBalance' deduction
ScheduleFrequencies Textlist object - containing a list of valid schedule frequencies
ScheduleFrequency Long - value indicating the frequency at which the item will be repeated
ScheduleNextDate (ThisDate, ScheduleFrequency) Variant date - returns the next date after the specified date at the specfied frequency.
TaxPer Integer - the number of tax periods over which the item's tax will be averaged
Units Currency - number of units for this pay item

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, ScheduleItemId) Loads into this object the data from the database for the specified database item record id.