PayslipItem Object

Manages the maintenance of a Payslip Item within a Payslip object.
Property Description
AccountName String - Deduction bank account name
AccountNo String - Deduction bank account number
AccountRef String - Deduction bank transaction reference
CalculateDefaultCash Currency - cash amount according to pay item definition, payee data and payslip item's units.
CalculateDefaultUnits Currency - number of units according to pay item definition and payee data.
Cash Currency - calculated cash amount for this pay item
CashOverride Currency - manual override of cash amount for this pay item
Comments String - leave spell comment if this is a leave taken pay item
CostCodeId Long - database record identifier for this object's cost code
CurrentCash Currency - amount of cash to be paid.
DCInd String - Y if this is the first direct credit to the deduction's bank account
Disbursement Long - indicates how this deduction will be disbursed
EndDate Variant date - end date of leave spell if this is a leave taken pay item
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
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
Payslip Payslip object - reference to this payslip item's host payslip. Required before the cash can be calculated
PayslipId Long - database record identifier for this object's parent payslip
Priority Integer - the pay calculation sequence for the pay item
ReducingBalance Currency - outstanding balance for the pay item, if this is a 'ReducingBalance' deduction
StartDate Variant date - start date of leave spell if this is a leave taken pay item
TaxPer Currency - number of tax periods over which this pay item's cash amount will be taxed.
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
ApplyChildEdit Completes an edit session for the object.
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.
BeginChildEdit Prepares the item for updating.
CancelChildEdit 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, PayslipItemId) Loads into this object the data from the database for the specified database payslip item record id.
SetPayslipItem (PayslipItem) Copies the properties of the specified PayslipItem object into this obect. Does not require BeginChildEdit/ApplyChildEdit.
SetScheduleItem (ScheduleItem) Copies the properties of the specified ScheduleItem object into this obect. Does not require BeginChildEdit/ApplyChildEdit.
SetStandardPayItem (StandardPayItem) Copies the properties of the specified StandardPay object into this obect. Does not require BeginChildEdit/ApplyChildEdit.
TotalProperty (Property, TotalBy, Id, FromDate, ToDate) Sets the units and cash to the total of all payslip items with a pay date on or after the StartDate and on or before the EndDate, grouped by Company, PayGroup or Payee where the Id is a PayGroup or Payee Id.