Table: dbo.Employee_Payroll_Item
Columns
NameTypeConstraintsDescription
employee_payroll_item_KEYint (4)NOT NULLKey of payroll item
employee_KEYint (4)NOT NULLKey of employee
client_payroll_item_KEYint (4)NOT NULLClient payroll item that this item is based on.
payroll_item_calculation_type_KEYint (4)NOT NULLCalculation type.
amountdecimal (9, 2)NOT NULLAmount. See other calculation setup for the effect this has on the check.
ratedecimal (9, 4)NOT NULLrate
percentagedecimal (5, 4)NOT NULLpercentage
is_activebit (1)NOT NULLis_active
start_datesmalldatetime (4)start_date
end_datesmalldatetime (4)end_date
calculation_limitdecimal (9, 4)NOT NULLDefines an optional calculation limit for the payroll item.
limit_calculation_type_KEYnvarchar (30)The method we use to calculate a payroll item limit. For example, fixed amount or percentage of gross pay. Overrides its counterpart in the associated client payroll item.
employee_payroll_item_guiduniqueidentifier (16)NOT NULLA unique GUID key for this row
liability__gl_account_KEYint (4)Key to the gl_account table for liability account.
expense__gl_account_KEYint (4)Key to the gl_account table for expense account.
is_auto_paybit (1)NOT NULLWhen true specifies that the system automatically give this employee hours or pay when creating the check. Defaults to the automatic pay option selected on the associated client payroll item, but may be overridden at the employee level.
maximum_percentage_of_disposable_incomedecimal (5, 2)NOT NULLPercentage field that holds the maximum amount of disposable income that can be garnished for child support. Defaults to whatever the user entered in the corresponding client payroll item field, but may be overridden at the employee level.
multiple_garnishment_calculation_method_KEYint (4)When a deduction has multiple garnishment orders and the max percentage is reached, we use this option to calculate how much goes to each garnishment. If this payroll item is not a garnishment this field is null and not used. Defaults to whatever the user specified in the corresponding client payroll item field, but may be overridden at the employee level.
supports_multiple_familiesbit (1)NOT NULLTrue when a child support order deduction supports more than one family.
insurepay_employer_contribution_type_KEYint (4)Foreign key for this table. The associated Insurepay_Employer_Contribution_Type KEY.
insurepay_pay_item_type_KEYint (4)Foreign key for this table. The associated Insurepay_Pay_Item_Type KEY.
xactpay_employer_contribution_type_KEYint (4)Foreign key for this table. The associated XactPay_Employer_Contribution_Type KEY.
xactpay_multi_class_identifier_type_KEYint (4)Foreign key for this table. The associated XactPay_Multi_Class_Identifier_type KEY.
xactpay_pay_item_type_KEYint (4)Foreign key for this table. The associated XactPay_Pay_Item_Type KEY.
ot_ratedecimal (5, 4)NOT NULLrate used when calculating overtime pay related to this employee pay item.
dt_ratedecimal (5, 4)NOT NULLrate used when calculating double time pay related to this employee pay item.
limit_period_type_KEYint (4)Used for limit setup. Holds the selected limit trigger
limit_begin_datesmalldatetime (4)Date the payroll item limit began
previously_deducted_amount_limitdecimal (9, 2)NOT NULLAmount previously deducted from payroll item
subtract_from_federal_levy_basisbit (1)NOT NULLShould this deduction be subracted from the federal levy basis? Not valid for child support since it uses the order date. Cannot be used for federal levy garnishment type since it is being subtracted from it.
is_health_insurance_deductionbit (1)NOT NULLFlag to indicate if this deduction item is used for health insurance
is_dependant_health_insurance_deductionbit (1)NOT NULLFlag to indicate if this deduction item is used for dependant health insurance
health_plan_type_KEYint (4)NOT NULLThe selection for health plan type such as individual or family.
is_weighted_allocationbit (1)NOT NULLFlag that indicates the payroll item is using a weighted allocation that will be based on gross pay per location/department distribution.
is_overtime_pay_itembit (1)NOT NULLWhen set true for a pay item, amounts entered in the regular hours column will be calculated as overtime wages when figuring the workers compensation wage amounts and premiums. This is needed because many users set up overtime pay as separate pay to record overtime amounts rather than using the overtime pay column on the main pay item.
amount_exempt_from_garnishmentdecimal (9, 2)NOT NULLThe amount that will be exempt from the garnishment for pay items of garnishment type.
use_lesser_max_percent_or_amount_exceeds_min_wagebit (1)NOT NULLUse the lesser of maximun percent of disposable income or amount by which disposable income exceeds minimum wage. Only used for Other garnishment type.
use_federal_min_wage_that_exceeds_disposal_incomebit (1)NOT NULLUse federal minimum wage when determining the amount that exceeds disposable income. Only used for Other garnishment type.
apply_catch_up_limitbit (1)The apply_catch_up_limit is only used for Retirement plans. When a Retirement plan item is marked active, this column is defaulted to the Client_Payroll_Item.apply_catch_up_limit value if it has never been set before (has a null value). True indicates that catch-up contributions should be made to the Retirement plan if the employee’s age meets the catch-up criteria. False means that catch-up contributions should not be made, even if the employee’s age qualifies. This column is set to null for all items that are not Retirement plans. It may also be null for non-active Retirement plan items that have never been marked active.
alternate_minimum_wagedecimal (5, 2)The alternate minimum wage is optionally used as an default minimum wage on special tipped wages types
Primary key
NameColumnsDescription
PK_Employee_Payroll_Itememployee_payroll_item_KEY
Unique constraints
NameColumnsDescription
UK_Employee_Payroll_Item$client_payroll_item_KEY$employee_KEYclient_payroll_item_KEY, employee_KEY
UK_Employee_Payroll_Item$employee_payroll_item_guidemployee_payroll_item_guid
Foreign keys
NameColumnsReferenced tableDescription
FK_Employee_Payroll_Item__XactPay_Multi_Class_Identifier_Type__xactpay_multi_class_identifier_type_KEYxactpay_multi_class_identifier_type_KEYXactPay_Multi_Class_Identifier_Type (xactpay_multi_class_identifier_type_KEY)
FK_Employee_Payroll_Item__XactPay_Pay_Item_Type__xactpay_pay_item_type_KEYxactpay_pay_item_type_KEYXactPay_Pay_Item_Type (xactpay_pay_item_type_KEY)
FK_Employee_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEYclient_payroll_item_KEYClient_Payroll_Item (client_payroll_item_KEY)
FK_Employee_Payroll_Item__Employee__employee_KEYemployee_KEYEmployee (employee_KEY)
FK_Employee_Payroll_Item__GL_Account__expense__gl_account_KEYexpense__gl_account_KEYGL_Account (gl_account_KEY)
FK_Employee_Payroll_Item__GL_Account__liability__gl_account_KEYliability__gl_account_KEYGL_Account (gl_account_KEY)
FK_Employee_Payroll_Item__Health_Plan_Type__health_plan_type_KEYhealth_plan_type_KEYHealth_Plan_Type (health_plan_type_KEY)
FK_Employee_Payroll_Item__Insurepay_Employer_Contribution_Type__insurepay_employer_contribution_type_KEYinsurepay_employer_contribution_type_KEYInsurepay_Employer_Contribution_Type (insurepay_employer_contribution_type_KEY)
FK_Employee_Payroll_Item__Insurepay_Pay_Item_Type__insurepay_pay_item_type_KEYinsurepay_pay_item_type_KEYInsurepay_Pay_Item_Type (insurepay_pay_item_type_KEY)
FK_Employee_Payroll_Item__Limit_Calculation_Type__limit_calculation_type_KEYlimit_calculation_type_KEYLimit_Calculation_Type (limit_calculation_type_KEY)
FK_Employee_Payroll_Item__Limit_Period_Type__limit_period_type_KEYlimit_period_type_KEYLimit_Period_Type (limit_period_type_KEY)
FK_Employee_Payroll_Item__Multiple_Garnishment_Calculation_Method__multiple_garnishment_calculation_method_KEYmultiple_garnishment_calculation_method_KEYMultiple_Garnishment_Calculation_Method (multiple_garnishment_calculation_method_KEY)
FK_Employee_Payroll_Item__Payroll_Item_Calculation_Type__payroll_item_calculation_type_KEYpayroll_item_calculation_type_KEYPayroll_Item_Calculation_Type (payroll_item_calculation_type_KEY)
FK_Employee_Payroll_Item__XactPay_Employer_Contribution_Type__xactpay_employer_contribution_type_KEYxactpay_employer_contribution_type_KEYXactPay_Employer_Contribution_Type (xactpay_employer_contribution_type_KEY)
Incoming foreign keys
NameColumnsReferencing tableDescription
FK_Insurepay_Client_Class_Code_N_Employee_Payroll_Item__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYInsurepay_Client_Class_Code_N_Employee_Payroll_Item
FK_Employee_Payroll_Item_N_Payroll_Item_Special_Timing__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYEmployee_Payroll_Item_N_Payroll_Item_Special_Timing
FK_Employee_Federal_Levy_Information__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYEmployee_Federal_Levy_Information
FK_Payroll_Check_Payroll_Item_Import__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYPayroll_Check_Payroll_Item_Import
FK_Payroll_Check_Payroll_Item__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYPayroll_Check_Payroll_Item
FK_Employee_Payroll_Item_Distribution__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYEmployee_Payroll_Item_Distribution
FK_Employee_Payroll_Item_Direct_Deposit_Allocation__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYEmployee_Payroll_Item_Direct_Deposit_Allocation
FK_Creditor_Garnishment_Order__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYCreditor_Garnishment_Order
FK_Child_Employee_Payroll_Item_N_Parent_Employee_Payroll_Item__Employee_Payroll_Item__child__employee_payroll_item_KEYchild__employee_payroll_item_KEYChild_Employee_Payroll_Item_N_Parent_Employee_Payroll_Item
FK_Child_Employee_Payroll_Item_N_Parent_Employee_Payroll_Item__Employee_Payroll_Item__parent__employee_payroll_item_KEYparent__employee_payroll_item_KEYChild_Employee_Payroll_Item_N_Parent_Employee_Payroll_Item
FK_Employee_Payroll_Item_Garnishment_Order__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYEmployee_Payroll_Item_Garnishment_Order
FK_Child_Support_Order__Employee_Payroll_Item__employee_payroll_item_KEYemployee_payroll_item_KEYChild_Support_Order

Schema diagram