PayGroup Object

Manages the maintenance of a Pay Group.
Property Description
AccountName String - bank account name debited with net pays
AccountNo String - bank account number debited with net pays
AccountRef String - default bank transaction reference for all payroll transactions
BankAbbrev (AU) String - Abbreviated code for bank (required by direct credit fiel)
DCPath String - name of directory in which the bank file will be created. Normally your bank software directory. If empty (""), bank file will be created in Kwik-Pay's program directory.
Description String - pay group name
DoneCoin Boolean - true if coinage report has been printed this pay period
DoneCosting Boolean - true if costing report has been printed this pay period
DoneDC Boolean - true if direct credit schedule has been printed this pay period
DoneLeave Boolean - true if leave liability report has been printed this pay period
DonePayReg Boolean - true if pay register report has been printed this pay period
DonePayslip Boolean - true if pay advices have been printed this pay period
DoneSign Boolean - true if signature list has been printed this pay period
DoneTPD Boolean - true if tax period totals report has been printed this pay period
Frequencies Textlist object - containing list of available pay frequencies
Frequency Long - number indicating pay frequency for pay group
Id Long - database identifier for this item (read only)
ImportFileType String - type of file to import. Required only by ImportPayData method
ImportFileTypes Textlist object - containing a list of valid import file types
ImportPath String - full path of the file to be imported. Required only by ImportPayData method
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
NextPayDate Variant date - pay date of next period. Required only by the Next Pay method.
NextPayPayees String - comma delimited list of payee database record identifiers of payees to include in open next pay process. Required only by the Next Pay method.
NextPayslipType Long - payslip type of pays to be created in open next pay process. Required only by the Next Pay method.
NextPayslipSequence Long - payslip sequence number to be created in open next pay process. Required only by the Next Pay method.
NextPeriodEnd Variant date - period end date of next period. Required only by the Next Pay method.
PayDate Variant date - current pay date for pay group
PayDates Collection - containing variant dates of all historical pay dates for pay group
PayerCode (AU) String - bank identifier of payer for direct credit file.
PayGroup String - pay group name
Payroll Object - reference to global payroll object. Required by NextPay and ImportPaydata methods.
PayTypes Textlist object - containing list of valid payslip types for NextPay process
PeriodEnd Variant date - current period end date for pay group
PeriodPerYear Integer - number of pay periods per year for pay group. Used by salary calculation.
PeriodWeeks Double - calculated number of weeks in a pay period, corresponding to the pay group's pay frequency.
Template Object - reference to the Template object defining the import file. Required only by ImportPayData method
UserName (AU) String - bank identifier of payer for direct credit file.
UserNo (AU) String - bank identifier of payer for direct credit file.

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.
ImportPayData (Server, Connection) Imports a set of pay data transactions, or payees defined by the ImportFileType, ImportPath and Template properties.
Load (Server, Connection, PayGroupId) Loads into this object the data from the database for the specified database record id.
NextPay (Server, Connection) Creates a set of payslip record for a new pay period, defined by the NextPayDate, NextPeriodEnd, NextPayslipType, and NextPayslipSeq properties.
ReversePay (Server, Connection) Deletes the payslips for pay group for the current pay date, and sets the pay group PayDate and PeriodEnd to the last pay date's.