Payee Object

Manages the maintenance of a Payee. The payee object acts as a container for data relating to a payee. See Payee Object Map for an overview of the complete payee object structure
Property Description
ABN (AU) String - Australian Business Number
ACCClass (NZ) String - ACC employer business class
AccountName String - Net pay bank account name
AccountNo String - Net pay bank account number
AccountRef String - Net pay bank transaction reference
Address1 String - First line of payee address
Address2 String - Second line of payee address. Suburb (AU)
Address3 String - Third line of payee address. State (AU)
Address4 String - Fourth line of payee address. PostCode (AU)
AppHrs Double - Total apprentice hours for payee
Apprentice Boolean - True if payee is an apprentice
AutoPubHol Boolean - True if a public holiday pay item is to be added to the payee's pay in the open period process
AwardId Long - database identifier of the award to which this employee belongs (zero if none)
BirthDate Variant date - birth date
BfwdRnd Currency - brought forward rounding from the last pay period
CfwdRnd Currency - carried forward rounding to the next pay period
ChildSupport (NZ) Currency - amount of child support deduction for a normal pay period
ChildSupportVariation (NZ) String - code indicating the reason for a variation in child support. Set by pay calculation process.
ClassificationId Long - database record identifier of the award classification of this employee (zero if none)
Contact String - emergency contact details for this employee
CostCodeId Long - database record identifier of the default cost code for this employee
CurrentRate Object - reference to the current effective PayeeRate object for this employee
DCInd String - net pay direct credit indicator. Y if first direct credit for this payee
DepartmentId Long - database record identifier of the department for this employee
EMail String E-mail address
EmplType String - employee type (full-time, part-time, casual)
EndDate Variant Date - termination date, or empty string if none
ETPDaysPost83 (AU) Integer - number of days after dd mmm 83 for ETP calculation
ETPDaysPre83 (AU) Integer - number of days before dd mmm 83 for ETP calculation
ETPPaid (AU) Variant date - date ETP paid
ETPStart (AU) Variant date - start date of ETP service
ExtraEmolumentRate (NZ) Currency - overriding percentage rate for extra emolument tax
FirstName String - payee's first names
FNPFAccount (FJ) String - FNPF account number
FNPFAccountSuffix (FJ) String - FNPF account number suffix
HECS (AU) Currency - overriding percentage rate of HECS for this payee
HrsPerDay Currency - normal work hours per day
HrsPerWeek Currency - normal work hours per week
Id Long - database identifier for this item (read only)
IR23CertNo (NZ) String - IR23 certificate number
IR348 (NZ) Boolean - true if payee not to be included in IR348 reporting
IRArrearsBalance (NZ) Currency - amount of remaining IR arrears balance
IRArrearsTotal (NZ) Currency - amount of IR arrears to recover as notified by IRD
IRDNo (NZ) String - IRD number
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
LastName String - payee last name
LastName String - payee last name
LoanDednRate (NZ) Currency - overriding percentage rate of student loan deduction
MedicareAdj (AU) Long - indicator for Medicare adjustment
MedicareAdjs (AU) TextList object - containing list of valid Medicare adjustment options
Mobile String - mobile phone number
NoDeps (AU) Integer - number of dependents for Medicare rebate calculation
NoDepsList (AU) Textlist object - containing list of valid NoDeps values
Notes PayeeNotes collection - reference to this payee's notes collection
NotValid (FieldName) Boolean - true if the specified field is not valid
NPFAccount (PG) String - NPF account number
NPFRate (PG) Currency percentage rate of employee voluntary NPF contribution
NumDependents (PG) Integer - number of dependents for PNG dependent rebate calculation
Occupation String - employee occupation
PaidTo Variant date - date paid up to
PayeeCode String - payee code for data import purposes
PayeeLeave PayeeLeave collection - reference to this payee's leave entitlements collection
PayGroupId Long - database record identifier of the pay group to which this payee belongs
PayMethod Long - indicates net pay disbursement method
PayMethods Textlist object - containing a list of valid pay methods
PayPoint String - code used to sort pay advices
PayRates PayeeRates collection - reference to this payee's pay rates collection
Payroll Payroll object - set to the global Payroll object, so that reference data can be retrieved by the Payee object
PayrollTaxState (AU) String - the state to which this payee's payroll tax is due
PercntNorm (AU, FJ, PG) Currency - percentage of normal tax to be deducted from payee's pay
PNGNational (PG) Boolean - true if payee is a resident for tax purposes
PostCode (AU) String - address post code (same as Address4)
Properties Properties collection - reference to this payee's miscellaneous properties collection
Proprietor (NZ) Boolean - true if payee is company proprietor for employment survey reporting
RDOCash (AU) Currency - total of rostered day off cash accumulated
RDOCycle (AU) String - rostered day off cycle (monthly, etc)
RDOCycles (AU) Textlist object - list of valid RDO cycles
RDODate (AU) Variant date - date of next rostered day off
RDOPaymentID (AU) Long - database record identifier of pay item to be used to pay rostered day off
RDOUnits (AU) Double - number of rostered day off units accumulated (hours or days)
RebateDeps (AU) Currency - amount of dependent rebate claimed
RebateZone (AU) Currency - amount of remote zone rebate claimed for tax rebate calculation
Sex String - payee sex (M, F)
StandardPays StandardPays collection - reference to this payee's standard pay items collection
StartDate Variant date - payee's ermployment start date
State (AU) String - address state (same as Address3)
States textlist object - containing a list of valid states
SuperMemberNo (AU) String - superannuation scheme member account number
TaxCategories (AU) Textlist object - containing a list of valid tax ccategories (employee, voluntary agreement, etc)
TaxCategory (AU) Long - indicates the payee tax category and type of payment summary to be printed
TaxFileNo (AU) String - payee's ATO tax file number
TaxIdentityNo (FJ, PG) String - payee's tax reference number
TaxRate Currency - overriding percentage of tax to be calculated for payee
TaxScaleId Long - database record idenifier of the payee tax scale (or tax code)
WorkPhone String - payee's work phone number
Zone (AU) Long - nidicates the payee's remote zone for tax rebate calculation
Zones textlist object - containing a list of valid zones

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, PayeeId, PayRun) Loads into this object the data from the database for the specified database record id. If PayRun is true, the PayeeNotes collection is not loaded.
Load Rs(rsPayees, rsPayRates, rsStandardPays, rsLeaves, rsProperties) Loads into this object the data from the ADO recordsets provided. When processing a large number of payees, this is more efficient than loading each payee separately using the Load method.
OpenPayslip(Server, Connection, PayType, Seq) Loads the specified payslip for the current pay period. Payroll property must be set prior to calling this method.
UpdatePayslip(Server, Connection, PayslipItem) Adds the specified pay item to the payee's payslip loaded with the OpenPayslip method, recalculates the pay, and saves all changes.