Payroll Object

Manages the maintenance of a Payroll. The payroll object acts as a container for all reference data. See Payroll Object Map for an overview of the complete payroll object structure.
Property Description
ABN (AU) String - Australian Business Number
ABNBrch (AU) String - Australian Business Number branch number if this is a branch of a larger organistion with a single ABN.
Address1 String - First line of company address
Address2 String - Second line of company address. Suburb (AU)
Address3 String - Third line of company address. State (AU)
Address4 String - Fourth line of company address. PostCode (AU)
AwardLeaves Collection - of all current defined AwardLeave objects
AwardRates Collection - of all current defined AwardRate objects
Awards Collection - of all current defined Award objects
Classifications Collection - of all current defined Classification objects
CompanyName String - this organisation's company name. Printed on all reports.
ContactFirst String - First name of payroll contact person
ContactLastt String - Last name of payroll contact person
ContactPhone String - Work phone number of payroll contact person
CostCodes Collection - of all current defined CostCode objects
Countries Collection - of all valid Kwik-Pay countries
Country String - country name. Must be one of Countries. Defines the statutory processing within Kwik-Pay.
CountryCode String - 2 character code for this payroll's country (Read Only)
Denoms Collection - of defined coinage denominations
Departments Collection - of all current defined Department objects
DoneTC Boolean - true if tax certificates have been printed
DoneTYD Boolean - true if tax year end summary report has been printed.
EMail String - e-mail address for company
ExpenseCodes Collection - of all current defined ExpenseCode objects
FaxNo String - company fax number
FNPFBranch (FJ) String - FNPF branch number if this company is a multi-branch organization with a single FNPF acccount number
FNPFCheckDigit (FJ) String - FNPF check digit for this company's FNPF Account number
FNPFEmployer (FJ) String - FNPF account number
GSTRate (NZ) Currency - only required for ACC premium report. Default 12.5
IRDNo (NZ) String - Company IRD number
Id Long - database identifier for this item (read only)
InvalidRegistration (Server, Connection) Boolean - true if the current payroll has more than 5 employees and the registration key does not match the company name.
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
LargeEmployer (NZ) Boolean - true if company is a large employer for IRD reporting purposes
LeaveTypes Collection - of all current defined LeaveType objects
Months Collection - of all valid month names
NPFEmployer (PG) String - company's NPF Account no
PayeeTaxCodes Collection - of all curernt defined tax codes that can be selceted for a payee
PayGroups Collection - of all current defined PayGroup objects
PayItems Collection - of all current defined PayItem objects
PayItemTemplates Collection - of all current defined PayItemTemplate objects
PayMethods Textlist object - containing a list of valid pay methods
Phone String company phone number
PostCode (AU) String - address post code (same as Address4)
Properties Properties collection - reference to this company's miscellaneous properties collection
PublicHolidays Collection - of all current defined PublicHoliday objects
Rates (NZ) Collection - of all current defined Rate objects
RegKey String - registration key
ReportFrequencies (AU) Textlist object - containing a list of valid ATO reporting frequencies
ReportFrequency (AU) String - ATO reporting frequency
Reports Collection - of all current defined Report objects
RndCash Currency - amount to which cash pay is it to be rounded
RndChq Currency - amount to which cheques are it to be rounded
RndDirCred Currency - amount to which direct credits are it to be rounded
RoundToTax Boolean - true if calculated rounding amounts are to be added to tax. The tax pay item is identifed by the Property 'AddRounding'
ScheduleItems Collection - of all current defined ScheduleItem objects
SerialNo String - system serial number
Signatory String - tax certificate signatory name
State (AU) String - address state (same as Address3)
States textlist object - containing a list of valid states
TaxAgency String - name of tax agency
TaxCodes Collection - of all current defined TaxCode objects
TaxFactors Collection - of all current defined TaxFactor objects
TaxParams Collection - of all current defined TaxParam objects
TaxRates Collection - of all current defined TaxRate objects
TaxYearStart (PayDate) Variant date - first day of the tax year in which the specified PayDate falls
TaxCategory (AU) Long - indicates the company tax category and type of payment summary to be printed
TaxStartMonth String - name of the month in which the tax year starts
Templates Collection - of all current defined Template objects
TradingName String - company's trading name, if different from CompanyName
VerNo String - Kwik-Pay version number

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.
CloseDown Releases all references to child objects and collections. Must be called before setting the Payroll object to nothing.
Create (Server, Connection) Creates a new payroll database on the specified Server. The connection string points to the new database.
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.
ImportData (Source, Server, Connection) Imports all payee data and pay history from the Source database, where Source is a connection string to connect to the source database, Server is the network machine processing the request, and Connection is the connection string to connect to the database which will receive the pay data..
Initialise (Server, Connection) Loads all the child collections with data from the database.
Load (Server, Connection, ) Loads into this object the payroll data from the database.
LoadDefaultData (Server, Connection, ) Loads into this object the default payroll data from the master Kwik-Pay database. Called after creating a new payroll database to populate the tax tables and other basic data.