1. Avionte Classic
  2. Account settings & Configuration
  3. System Type Settings

Transaction Type Properties

Updated

This article details information on the various Transaction Type properties in the system. For additional information on Transaction Types, please refer to this article: Admin Tools: Transaction Type

For information specifically on adding or editing transaction types, please see this article: Transaction Type - Add / Edit Transaction Types

BillRequired

The BillRequired property indicates whether or not a bill needs to be entered whenever a transaction is processed.

If BillRequired is set to True, then it is checked by the following Time Entry Batch DRMs:

Name Severity Displayed Message Description Fixed from... Additional Configuration
tbv_CheckDailyPayBillUnitDifference Severe "There are Transactions whose daily pay unit is different than daily bill unit." Will trigger if the transaction daily total hours not equal to bill total hours. Assignment > Detail > Pay/Bill History PayRequired ConfigOption must also be True
tbv_CheckPayBillUnitDifference Warning Transaction has pay unit different than bill unit. Will trigger if the transaction has pay unit doesn't equal the bill unit. Assignment > Detail > Pay/Bill History PayRequired ConfigOption must also be True
tbv_TotalPayAndNoTotalBill Warning "Transaction has Total Pay but no Total Bill." Will trigger if transaction has item pay but no item bill. Assignment > Detail > Pay/Bill History None

BillRequired properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: True
Valid values: True: Bill needs to be entered.
False: Bill does not need to be entered.
Where the setting is reflected... Wherever this transaction type is used

 

PayRequired

The PayRequired property. This transaction type requires that a payment (Item Pay) is entered in order for the transaction to be processed.

If PayRequired is set to True, then it is checked by the following Time Entry Batch Verifications (DRMs).

Error Message Resolution Config Option Requirement
"There are Transactions whose daily pay unit is different than daily bill unit." Change the pay and/or bill units. Or, set PayRequired to False BillRequired must also be True
"Transaction has pay unit different than bill unit." Change the pay and/or bill units. Or, set PayRequired to False BillRequired must also be True
"Transaction has Total Bill but no Total Pay" Enter in a value for TotalPay  
 

PayRequired properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: True
Valid values: True: Pay needs to be entered
False: Pay does not need to be entered
Where the setting is reflected...  

 

ShowPerHour

The ShowPerHour property controls whether the Per Hour checkbox is displayed in the Employee section's Deduction page.

ShowPerHour properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: The Per Hour checkbox is displayed for the selected transaction type.
False: The Per Hour checkbox is hidden.
Where the setting is reflected... Employee section's Payroll Deduction page.

 
 

ShowLevy

The ShowLevy property controls whether the Levy checkbox displays on the Employee Deduction page.

ShowLevy properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: The Levy checkbox is displayed for the selected transaction type.
False: The Levy checkbox is hidden.
Where the setting is reflected... Employee section's Payroll Deduction page.

 

 

IsCalculatedHours

The IsCalculatedHours property is used in worker's compensation calculations in the states of Washington and Oregon to pass the number of worker hours to Vertex. When calculating the total hours during payroll (Vertex) calculation, determines whether to calculate hours based on Item Pay. Initial total hours is sum of "Pay Total Hours" (see IncludeInOtherHours.)

IsCalculatedHours properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: If this property is True {ItemPay / [CalculationParameter]} is added to Total.
False: IsCalculatedHours is ignored in the calculation of Workers Comp
Where the setting is reflected...  
 

 

CalculationFormula

The CalculationFormula property is the second part to IsCalculatedHours and must be set to "TotalPay" in order for IsCalculatedHours to be processed.

CalculationFormula properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: TotalPay
Valid values: TotalPay or blank value
Where the setting is reflected...  

 

DefaultAgencyGUID

The DefaultAgencyGUID is used to automatically link a specific agency to a transaction type. Typically, the DefaultAgencyGUID is used for deduction or contributions purposes.

DefaultAgencyGUID properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: AlphaNumeric - Agency GUID
Where the setting is reflected... Wherever this transaction type is used
 

PayPeriodLimit

The PayPeriodLimit property sets the initial value of the Pay Period Limit field during manual entry of employee deductions and contributions.

PayPeriodLimit properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric
Where the setting is reflected... Employee section's Payroll Deduction and Contribution pages.

 
 

DefaultAmount

The DefaultAmount sets the default amount for a transaction's deductions/contribution value.

DefaultAmount properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric
Where the setting is reflected... Deductions and Contributions

 

DefaultFrequency

The DefaultFrequency property sets the default frequency for the automatic generation of Employee Deduction records (eg. AdvanceBank, CheckReissueFee, etc.) during the processing of paycheck corrections. This also sets the initial value displayed in the Deduction Pay Cycle field when adding a new deduction to employees.

DefaultFrequency properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 37
Valid values: 36 (daily)
37 (weekly)
38 (biweekly)
39 (monthly)
40 (semi-monthly)
41 (yearly)
981 (hourly)
Where the setting is reflected... Paycheck corrections.

 

IncludeInACAHours

The IncludeInACAHours property determines whether a transaction should be included in the calculation of Affordable Care Act (ACA) service hours. This property directly impacts ACA eligibility measurements and is reflected on the ACA Census AQ report.

When set to True, the transaction's hours will count toward an employee's measured hours for ACA eligibility purposes, which will affect Form 1095-C reporting if the employee is measured as full-time. Regular hours (REG) and overtime hours (OT) should typically have this property set to True.

When set to False, the transaction's hours are excluded from ACA calculations. Examples where this would be appropriate include equipment deductions or other non-working hour transactions.

IncludeInACAHours properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: Included in calculation of ACA hours
False: Excluded from ACA hours
Where the setting is reflected... ACA Census AQ report and Form 1095-C

 

CalculationParameter

The CalculationParameter property is the third part to IsCalculatedHours, and is the amount by which to divide ItemPay.

CalculationParameter properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0.00
Valid values: Numeric
Where the setting is reflected...  

 

IncludeInOtherHours

The IncludeInOtherHours property determines if and how transaction types are tracked in the system by indicating whether to include Pay and Bill Units in a particular Transaction's 'Other Hours'.

When set to True:

  • The hours will be stored in the Transaction Detail table, which is used in various reports
  • This setting is required for vacation and holiday transaction types (in addition to using the system names of vac/hol)
  • The hours are included in the Accrued Hours Report and Gross Profit Report calculations

A transaction's Total Hours, which is used primarily for Worker Compensation calculations, is the sum of Reg, OT, DT, and Other Hours.

IncludeInOtherHours properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: Hours are included in "Other Hours"
False: Hours are excluded from "Other Hours"
Where the setting is reflected... Accrued Hours Report, Gross Profit Report, and other reports that use the Transaction Detail table

 

GPCalculation

The GPCalculation property dictates whether to include the transaction in the calculation of Gross Profit. This property determines how transaction types are tracked in the system and how amounts are categorized on the Gross Profit report.

When set to False:

  • The transaction will not be included in Gross Profit calculations
  • This is typically used for costs that should not impact gross profit (such as equipment costs)
Note: Any taxable pay code will always affect the GP (Gross Profit) regardless of this property's value setting. The GPCalculation property value is only regarded by items with non-taxable pay codes.

GPCalculation properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: True
Valid values: True: Transaction is used in GP calculation
False: Transaction is not used in GP calculation
Where the setting is reflected... Gross Profit Report

 

LifeTimeLimit

The LifeTimeLimit property sets the initial value of the Life Time Limit field during manual entry of employee deductions and contributions.

LifeTimeLimit properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric
Where the setting is reflected... Employee section's Payroll Deduction and Contribution pages.

 

YearlyLimit

The YearlyLimit property sets the initial value of the Yearly Limit field during manual entry of employee deductions.

YearlyLimit properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric monetary value.
Where the setting is reflected... Employee section's Payroll Deduction and Contribution pages.

 

 

CalculateWorkerCompCost

The CalculateWorkerCompCost property determines if Rate percent (Rate%) should be figured into a worker's compensation calculation.

Note: This calculation only affects wages, not adjustments.

If the value is set to True, workers compensation is equal to Rate% * Total Item Pay of the transaction.

Notes A non-taxable pay code will never affect Worker's Comp Wages. The system calculates Worker's Comp Cost on taxable pay codes only. 
Any taxable pay codes (other than Reg, OT, and DT) are included in Worker's Comp Calculation based on this property's setting.
Worker's Comp Calculated is based on the processing method defined on Worker Comp Setup. Visit the WcCode Tab (Worker's Compensation) article to view calculations. 
Worker's Compensation is calculated differently in Washington and Oregon, so this should be set to false to stay in compliance.

CalculateWorkerCompCost properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: The amount will be figured into the workers compensation calculation.
False: If ItemPay / [CalculationParameter] = 0, that record is not passed to Vertex.
Where the setting is reflected... Employee wage calculations.
 

UnitsToHoursMultiplier

The UnitsToHoursMultiplier property allows for units to be converted into hours for inclusion in ACA calculation and accrual plans. This multiplier is particularly useful for salary-based or piece work transactions.

This property determines how transaction units are converted to hours:

  • If left blank: 1 unit equals 1 hour
  • If set to a whole number greater than zero: 1 unit equals multiple hours (the number entered)
  • If set to a decimal: 1 unit equals a partial hour (the decimal entered)

Examples:

  • For weekly salaried employees: Set to 40 so that recording 1 unit of pay in Time Entry will add 40 hours for ACA tracking
  • For piece work: If an employee is paid per completed item (e.g., 10 boxes assembled in 1 hour), set to 0.1 so that each piece counts as the appropriate fraction of an hour

This multiplier is also utilized with Accrual Plans that include a 'Salary' configured transaction type [Admin Tools > Accrual Plan > Accrual Plan Accrue sub-tab]. The system uses the UnitsToHoursMultiplier to determine the accrual value for the transaction type entered in Time Entry as 1 Pay Unit with the Salary Pay Rate.

UnitsToHoursMultiplier properties

Numeric Value Entered In Result Example
Nothing or blank 1 unit = 1 hour  
Integer greater than zero 1 unit = multiple hours (# provided) Entered 2 = 1 unit is equal to 2 hours
Decimal 1 unit = Partial hour (# provided) Entered .5 = 1 unit is equal to 30 minutes (half hour)

 

DefaultMarkup

The DefaultMarkup property sets the default amount that will be multiplied with the pay rate to find the bill rate for an order.

DefaultMarkup properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric.
Where the setting is reflected... Finding the bill rate for an order

 

CostRate

The CostRate is used to determine a default cost for a transaction. Generally, CostRate is used for reporting purposes and may not be used in your system.

CostRate properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric
Where the setting is reflected... Reporting

 

ExcludeInMinimumWageCalculation

The ExcludeInMinimumWageCalculation property helps to determine whether or not to exclude pay codes from federal minimum wage check while verifying time entry batches.

In practice, employees such as bartenders and waiters might only get paid $2.15 per hour because they are expected to make up the difference from tips and gratuity. For these individuals, instead of using the REG (regular) pay code, the pay code FSREG – FoodService REG is used, and the value of ExcludeInMinimumWageCalculation is set to True. If they don't make enough in tips, staffing companies will then be prevented from not paying the minimum wage.

ExcludeInMinimumWageCalculation properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: False
Valid values: True: Use this value for FoodService REG (FSREG) pay rate. This setting will exclude pay codes from the federal minimum wage check when verifying time entry batches.
False: Use this value for regular, overtime, and double-time pay rates.
Where the setting is reflected... Time Entry batch verification

Time Entry Section

In order for this to work, transactions are required to have one of the following transaction types along with FSREG:

  • REG
  • OT
  • DT

For the net weighted pay rate, the item pay is combined for all transaction types having ExcludeInMinimumWageCalculation set to True, and then the total item pay is divided by sum of REG, OT, and DT Hours.

Example:

In the example image below, there are four different transaction types. ExcludeInMinimumWageCalculation of Reg Time, OT and Boots are set to False, and FSREG is set to True. To calculate net weighted pay rate, it sums up the item pay of Reg time and OT, and subtracts the item pay of Boots (since the amount is negative), and divides the total item pay by sum of Reg and OT hours.



 

  • (Reg Time + OT – Boots) / (Reg Unit + OT Unit) = (4.00 + 5.00 – 5.00) / (1 + 1) = 4.00/2 = 2.00

Since the calculated pay rate (2.00) is less than the federal wage, an error message would be displayed while verifying the batch.

 

 

MonthlyLimit

The MonthlyLimit property sets the initial value of the Monthly Limit field during manual entry of employee deductions.

MonthlyLimit properties

Admin Tools location: System Category > Transaction Type > Property tab
Default: 0
Valid values: Numeric
Where the setting is reflected... Employee section's Payroll Deduction page.

 

 

Levy "All But" Deduction Setup

An "All But" levy is a DI (Disposable Income) exempt deduction that removes "All But" a specific value or percent from a paycheck (ex. child support, court order, etc.).

Levy deductions are created in Admin Tools and can be applied to specific employees, or as a system-wide deduction, after creation.

Note: In this example, the deduction is configured to deduct 25% from a paycheck, with a minimum "all but" of $217.50.

 

Admin Tools Setup

  1. Navigate to Admin Tools and open the Transaction Type section.
  2. Click Add New below the Transaction Type grid.
  3. Enter a Name, Description, and System Name.
  4. Select the Type of Permanent Deduction.
  5. Mark the IsTiered checkbox.

  6. Select the Deduction Category of Garnishment.
  7. Select the correct Pre Tax Deduction status. For this example, the status is None.

  8. Enter other required information based on your company. This may include:

    Vertex CMP Code Your Company Code as recorded with Vertex.
    W2Box The number of the field on the W2 form where the total amount accrued by this deduction will be displayed.
    W2Label The alphanumeric value (e.g. AA, B.b, B.B) of the sub-field of the W2Box value above. Consult your employer W2 for more information.
  9. Click Save.

 

Once saved, there are two ways to implement the levy:

  • Configure the tiering in Admin Tools on the transaction itself, included in each supported pay cycle (weekly, biweekly, semi-monthly, monthly).
  • Configure the tier for an individual employee by selecting it in Employee > Rates and modifying it there.

 

Configuration for System-Wide Use

When entering values, all numbers are entered as per-year numbers rather than per-paycheck numbers. Multiply by 52 for weekly pay, 26 for biweekly, and 24 for semimonthly. For example, a tier applying to the $0–$217.50 range on a weekly per-check basis uses $11,310 as the annualized value.

  1. Navigate to Admin Tools and open the Transaction Type section.
  2. Select the Tiers tab.

  3. Enter the following three tiers into the lower grid:

    1. Tier 1: Enter a flat-rate deduction of $0 for the range of $0.00 to [annual minimum].
    2. Tier 2: Enter an IsLevy deduction of the minimum allowed deduction for the range of [annual minimum + $0.01] to [annual minimum × (1 − deduction percent)].
    3. Tier 3: Enter an IsPercent deduction of the deduction percent for the range of [annual minimum × (1 − deduction percent) + $0.01] to MAX.

    Note: Using the 25% example with all values annualized (× 52):

    • Tier 1: Flat-rate of $0 for $0.00–$11,310.00
    • Tier 2: IsLevy of $11,310.00 for $11,310.01–$15,080.00
    • Tier 3: IsPercent of 25.00% for $15,080.01–$99,999,999.00

  4. Tab off the last row to save.

 

Configuration for Individual Employee Use

When entering values, all numbers are entered as per-year numbers rather than per-paycheck numbers. Multiply by 52 for weekly pay, 26 for biweekly, and 24 for semimonthly.

  1. Open the employee record for the employee who will use this deduction.
  2. Navigate to the deduction sub-section.

  3. Click New Deduction to clear the fields.

  4. Enter all required information. Be sure to set the following fields:

    Note: There is no need to enter a fixed amount — the tier handles that.

    Sequence The order in which this deduction will be processed during payroll.
    Pay Cycle Weekly, Bi-Weekly, Monthly, or a custom cycle.
    Lifetime Limit The maximum amount allowed to be deducted during the time this deduction is in use.
    Agency The agency this deduction is being applied through.
    Start Date The date this deduction takes effect for this employee.
  5. Navigate to the Rates tab to enter the tiers.

  6. Enter the following three tiers into the lower grid:

    1. Tier 1: Flat-rate deduction of $0 for $0.00 to [annual minimum].
    2. Tier 2: IsLevy deduction of the minimum allowed for [annual minimum + $0.01] to [annual minimum × (1 − deduction percent)].
    3. Tier 3: IsPercent deduction of the deduction percent for [annual minimum × (1 − deduction percent) + $0.01] to MAX.

    Note: Using the 25% example with all values annualized (× 52):

    • Tier 1: $0 for $0.00–$11,310.00
    • Tier 2: IsLevy of $11,310.00 for $11,310.01–$15,080.00
    • Tier 3: 25.00% for $15,080.01–$99,999,999.00

  7. Tab off the last row to save. The deduction will appear on paychecks issued after the start date entered in step 4.

Articles in this section

See more
Was this article helpful?
0 out of 0 found this helpful
Share

Comments

0 comments

Article is closed for comments.