| Property | Description |
| AccountName | String - Deduction bank account name |
| AccountNo | String - Deduction bank account number |
| AccountRef | String - Deduction bank transaction reference |
| Basis | Long - Pay item's basis, or units |
| Bases | Textlist object - containing a list of valid Basis |
| CalcMethod | String - One a set of pre-defined calculation methods. Defines how the cash and/or units for a pay item is calculated. |
| CalcMethods | Textlist object - containing a list of valid CalcMethods |
| Code | String - unique short code identifying the pay item. Required for pay data imports. |
| CostCodeId | Long - database identifier for the cost code associated with this item |
| DCInd | String - Y if this is the first direct credit for this item |
| Deduction | Boolean - true if this pay item is subtracted from a payee's pay calculation. |
| Description | String - Item description |
| Disbursement | Long - the payment method for this pay item if it is a deduction. (Cash, cheque, direct credit or retained) |
| Disbursements | Textlist object - containing a list of valid disbursements |
| ExpenseCodeId | Long - database identifier for the expense code associated with this item |
| Factor | Currency - factor used in pay calculation, depending on CalcMethod of pay item. i.e. for an overtime pay item, with a calc method of Hourly, it might contain 1.5 or 2 for time and a half, or double time. |
| Id | Long - database identifier for this item (read only) |
| 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 |
| LeaveTypeId | Long - database identifier for the leave type code associated with this item. Zero if none. |
| Maximum | Currency - maximum value for the calculated amount of this pay item. |
| Benefit | Boolean - true if this pay item is an benefit (employer sponsored, or overhead) |
| PayItemProperties | Collection - containing a set of pay item property objects |
| PayItemTemplateId | Long - database identifier for the pay item template associated with this item (zero if none) |
| Priority | Integer - number indicating the sequence in which the pay item is calculated within a pay slip. Lower numbers calculated first. |
| ReduceBalance | Boolean - True if this pay item has a remaining balance whcih is reduced until it is zero, at which point the deduciton ceases. |
| Repeating | Boolean - true if this pay item is carried forward automatically to the next pay period by the open period process. |
| SequenceNo | Long - number used to resequence a collection of pay item objects |
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, PayItemId) | Loads into this object the data from the database for the specified database record id. |
| SetTemplate (Server, Connection, PayItemTemplate) | Sets the properties of this pay item to those of the specified pay item template object |