Table: dbo.Client_Payroll_Item
Columns
Name | Type | Constraints | Description
client_payroll_item_KEY | int (4) | NOT NULL | Key for the record
description | nvarchar (60) | NOT NULL | Item description, which must be unique within the scope of the items for the client
alternate_description | nvarchar (60) | NOT NULL | This allows a user to optionally display a different description on checks and reports.
client_KEY | int (4) | NOT NULL | Client the item applies to.
payroll_item_type_KEY | int (4) | NOT NULL | Key of item type.
payroll_item_calculation_type_KEY | int (4) | NOT NULL | Key of calculation type.
amount | decimal (9, 2) | NOT NULL | Default amount copied to employee payroll item when the system adds the item to an employee.
percentage | decimal (5, 4) | NOT NULL | Default percentage copied to employee payroll item when the system adds the item to an employee.
rate | decimal (9, 4) | NOT NULL | Default rate copied to employee payroll item when the system adds the item to an employee.
is_excluded_from_gross_pay_amount | bit (1) | NOT NULL | Indicates if item amount is excluded from gross pay
is_excluded_from_net_pay | bit (1) | NOT NULL | is_excluded_net_pay
wage_type_KEY | nvarchar (30) |  | Key of wage type.
ot_dt_amounts_are_supplemental_wages | bit (1) | NOT NULL | are_ot_dt_amts_supplemental_wages
vendor_KEY | int (4) |  | Vendor to which payables are generated for this item.
special__deduction_type_KEY | int (4) |  | Holds benefit type for this deduction item
related_payroll_item__client_payroll_item_KEY | int (4) |  | Reference of a deduction item to a employer contribution payroll item
limit_calculation_type_KEY | nvarchar (30) |  | Used for limit setup. Holds limit calculation type
calculation_limit | decimal (9, 2) | NOT NULL | Defines an optional calculation limit for the payroll item.
calculation_limit_related_item__client_payroll_item_KEY | int (4) |  | Key of a deduction item which a user may optionally use to specify a calculation limit for a payroll item.
federal_unemployment_tax_exemption_type_KEY | int (4) |  | Optional federal unemployment tax exemption.
inactive | bit (1) | NOT NULL | Flags the payroll item as inactive, which means the user does not want to use it but does not want to delete it either.
is_other_wages | bit (1) | NOT NULL | Flag indicating whether or not this payroll item is not regular wages, but rather other wages.
client_payroll_item_guid | uniqueidentifier (16) | NOT NULL | A unique GUID key for this row
worker_compensation_class_code_detail_KEY | int (4) |  | worker compensation class code this deduction is for
selection_scope_KEY | int (4) | NOT NULL | worker compensation exemption type key
liability__gl_account_KEY | int (4) |  | Key to the gl_account table for liability account.
expense__gl_account_KEY | int (4) |  | Key to the gl_account table for expense account.
is_auto_pay | bit (1) | NOT NULL | Flag when true specifies that the system automatically give this employee hours or pay when creating the check.
garnishment_type_KEY | int (4) |  | If this payroll item is a garnishment, this says what kind. If not a garnishment this field should be null and not used.
is_w2_dependent_care_benefit | bit (1) | NOT NULL | Flag pay and deduction item amount for display in W-2 Dependent Care Benefits box.
w2_compensation_code_type_KEY | int (4) |  | W-2 compensation code, optional for all payroll item types. When used on a payroll item, the code and associated description appear on the employee W-2.
is_w2_retirement_plan | bit (1) | NOT NULL | W-2 processing uses this flag to know when to mark the W-2 retirement plan check box. Applicable to deduction and employer contribution items.
w2_other_description | nvarchar (30) | NOT NULL | Optional description (determined by the user) for use in the W-2 other description box. Applicable to all payroll item types.
sequence_number | int (4) | NOT NULL | This user defined sequence number which defines the order which the payroll item should be presented.
special_type_KEY | int (4) | NOT NULL | The payroll item special type if needed.
accruable_benefits__selection_scope_KEY | int (4) | NOT NULL | Shows which type of accruable benefits to exclude from pay check calculations
payroll_item_special_timing_KEY | int (4) | NOT NULL | Foreign key into the Payroll Item Special timing table.
limit_period_type_KEY | int (4) |  | Used for limit setup. Holds the selected limit triggert
is_excluded_from_garnishment_disposable_income | bit (1) | NOT NULL | Indicates if we should exclude this payroll item from garnishment disposal income.
pay_items_exclude_all_regular | bit (1) | NOT NULL | Indicates that the client payroll item should exclude regular wages from all pay items for this client.
pay_items_exclude_all_OT | bit (1) | NOT NULL | Indicates that the client payroll item should exclude overtime wages from all pay items for this client.
pay_items_exclude_all_DT | bit (1) | NOT NULL | Indicates that the client payroll item should exclude doubletime wages from all pay items for this client.
pay_items_exclude_all_accruable_benefits | bit (1) | NOT NULL | Indicates that the client payroll item should exclude accruable benefit wages from all pay items for this client.
is_exclude_premium_wages | bit (1) | NOT NULL | Indicates that the client payroll item should calculate assuming 1.0 as both the OT and DT multipliers when excluding wages.
w2_nonqualified_deferred_compensation_type_KEY | int (4) |  | Optional type of nonqualified deferred compensation. Used for W2 processing.
health_plan_type_KEY | int (4) | NOT NULL | The selection for health plan type such as individual or family.
is_subject_to_health_savings_account_limit | bit (1) | NOT NULL | Used only for employer contribution payroll item types to indicate if the item is subject to the health savings account limit.
is_excluded_from_gross_pay_hours | bit (1) | NOT NULL | Indicates if item hours are excluded from gross pay
is_weighted_allocation | bit (1) | NOT NULL | Flag that indicates the payroll item is using a weighted allocation that will be based on gross pay per location/department distribution.
maximum_percentage_of_disposable_income | decimal (5, 2) | NOT NULL | Percentage field that holds the maximum percentage of disposable income that can be garnished for pay items of garnishment type.
use_lesser_max_percent_or_amount_exceeds_min_wage | bit (1) | NOT NULL | Use 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_income | bit (1) | NOT NULL | Use federal minimum wage when determining the amount that exceeds disposable income. Only valid for Other garnishment type. Only used for Other garnishment type.
apply_catch_up_limit | bit (1) |  | The apply_catch_up_limit is only used for Retirement plans. 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.
client_payroll_item_version | timestamp (8) | NOT NULL | The version of this row. It's an aid in versioning the row.
client_payroll_item_force_new_version_toggle | bit (1) | NOT NULL | A bit to toggle that causes the client_payroll_item_version to update. Flip this bit when a subordinate tables are changed.
alternate_minimum_wage | decimal (5, 2) |  | The alternate minimum wage is optionally used as an default minimum wage on special tipped wages types
subtract_cafeteria_125_deduction_before_calculating | bit (1) | NOT NULL | This flag determines whether or not to subtract the Section 125 Cafeteria deduction before calculating retirement plans.
require_direct_deposit_allocation | bit (1) | NOT NULL | If (true), direct deposit allocations are required.
is_deferred_fica_ss_repayment | bit (1) | NOT NULL | Flag that will indicate if this client payroll item is a special type of deduction item.

Primary key
Name | Columns | Description
PK_Client_Payroll_Item | client_payroll_item_KEY |
Unique constraints
Name | Columns | Description
UK_Client_Payroll_Item$client_KEY$payroll_item_type_KEY$description | client_KEY, payroll_item_type_KEY, description |
UK_Client_Payroll_Item$client_payroll_item_guid | client_payroll_item_guid |
UK_Client_Payroll_Item$payroll_item_special_timing_KEY | payroll_item_special_timing_KEY |

Foreign keys
Name | Columns | Referenced table | Description
FK_Client_Payroll_Item__Client__client_KEY | client_KEY | Client (client_KEY) |
FK_Client_Payroll_Item__Client_Payroll_Item__calculation_limit_related_item__client_payroll_item_KEY | calculation_limit_related_item__client_payroll_item_KEY | Client_Payroll_Item (client_payroll_item_KEY) |
FK_Client_Payroll_Item__Client_Payroll_Item__related_payroll_item__client_payroll_item_KEY | related_payroll_item__client_payroll_item_KEY | Client_Payroll_Item (client_payroll_item_KEY) |
FK_Client_Payroll_Item__Deduction_Type__special__deduction_type_KEY | special__deduction_type_KEY | Deduction_Type (deduction_type_KEY) |
FK_Client_Payroll_Item__Federal_Unemployment_Tax_Exemption_Type__federal_unemployment_tax_exemption_type_KEY | federal_unemployment_tax_exemption_type_KEY | Federal_Unemployment_Tax_Exemption_Type (federal_unemployment_tax_exemption_type_KEY) |
FK_Client_Payroll_Item__Garnishment_Type__garnishment_type_KEY | garnishment_type_KEY | Garnishment_Type (garnishment_type_KEY) |
FK_Client_Payroll_Item__GL_Account__expense__gl_account_KEY | expense__gl_account_KEY | GL_Account (gl_account_KEY) |
FK_Client_Payroll_Item__GL_Account__liability__gl_account_KEY | liability__gl_account_KEY | GL_Account (gl_account_KEY) |
FK_Client_Payroll_Item__Health_Plan_Type__health_plan_type_KEY | health_plan_type_KEY | Health_Plan_Type (health_plan_type_KEY) |
FK_Client_Payroll_Item__Limit_Calculation_Type__limit_calculation_type_KEY | limit_calculation_type_KEY | Limit_Calculation_Type (limit_calculation_type_KEY) |
FK_Client_Payroll_Item__Limit_Period_Type__limit_period_type_KEY | limit_period_type_KEY | Limit_Period_Type (limit_period_type_KEY) |
FK_Client_Payroll_Item__Payroll_Item_Calculation_Type__payroll_item_calculation_type_KEY | payroll_item_calculation_type_KEY | Payroll_Item_Calculation_Type (payroll_item_calculation_type_KEY) |
FK_Client_Payroll_Item__Payroll_Item_Special_Timing__payroll_item_special_timing_KEY | payroll_item_special_timing_KEY | Payroll_Item_Special_Timing (payroll_item_special_timing_KEY) |
FK_Client_Payroll_Item__Payroll_Item_Special_Type__special_type_KEY | special_type_KEY | Payroll_Item_Special_Type (payroll_item_special_type_KEY) |
FK_Client_Payroll_Item__Payroll_Item_Type__payroll_item_type_KEY | payroll_item_type_KEY | Payroll_Item_Type (payroll_item_type_KEY) |
FK_Client_Payroll_Item__Selection_Scope__accruable_benefits__selection_scope_KEY | accruable_benefits__selection_scope_KEY | Selection_Scope (selection_scope_KEY) |
FK_Client_Payroll_Item__Selection_Scope__selection_scope_KEY | selection_scope_KEY | Selection_Scope (selection_scope_KEY) |
FK_Client_Payroll_Item__Vendor__vendor_KEY | vendor_KEY | Vendor (vendor_KEY) |
FK_Client_Payroll_Item__W2_Compensation_Code_Type__w2_compensation_code_type_KEY | w2_compensation_code_type_KEY | W2_Compensation_Code_Type (w2_compensation_code_type_KEY) |
FK_Client_Payroll_Item__W2_Nonqualified_Deferred_Compensation_Type__w2_nonqualified_deferred_compensation_type_KEY | w2_nonqualified_deferred_compensation_type_KEY | W2_Nonqualified_Deferred_Compensation_Type (w2_nonqualified_deferred_compensation_type_KEY) |
FK_Client_Payroll_Item__Wage_Type__wage_type_KEY | wage_type_KEY | Wage_Type (wage_type_KEY) |
FK_Client_Payroll_Item__Worker_Compensation_Class_Code_Detail__worker_compensation_class_code_detail_KEY | worker_compensation_class_code_detail_KEY | Worker_Compensation_Class_Code_Detail (worker_compensation_class_code_detail_KEY) |

Incoming foreign keys
Name | Columns | Referencing table | Description
FK_Client_Payroll_Item__Client_Payroll_Item__calculation_limit_related_item__client_payroll_item_KEY | calculation_limit_related_item__client_payroll_item_KEY | Client_Payroll_Item |
FK_Client_Payroll_Item__Client_Payroll_Item__related_payroll_item__client_payroll_item_KEY | related_payroll_item__client_payroll_item_KEY | Client_Payroll_Item |
FK_Shortfall_Deduction_Treatment_Selection__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Shortfall_Deduction_Treatment_Selection |
FK_Graduated_Payroll_Item_Tier__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Graduated_Payroll_Item_Tier |
FK_Deduction_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Deduction_Item |
FK_Import_Template_Column_Payroll_Item_Data__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Import_Template_Column_Payroll_Item_Data |
FK_Federal_Tax_Exemption__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Federal_Tax_Exemption |
FK_State_Tax_Exemption__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | State_Tax_Exemption |
FK_Import_Template_Column_Employee_Data__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Import_Template_Column_Employee_Data |
FK_Pay_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Pay_Item |
FK_Local_Tax_Exemption__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Local_Tax_Exemption |
FK_Payroll_Check_Entry_Option_Payroll_Item_Exclusion__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Payroll_Check_Entry_Option_Payroll_Item_Exclusion |
FK_Payroll_Item_Worker_Compensation_Exemption__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Payroll_Item_Worker_Compensation_Exemption |
FK_ATF_Payroll_Check_Entry_Option_Pay_And_Tax_Item_Definition__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | ATF_Payroll_Check_Entry_Option_Pay_And_Tax_Item_Definition |
FK_Ascii_Time_Clock_Client_Payroll_Item_Id_Map__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Ascii_Time_Clock_Client_Payroll_Item_Id_Map |
FK_Quick_Books_Payroll_Item_N_Client_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Quick_Books_Payroll_Item_N_Client_Payroll_Item |
FK_Payroll_Check_Entry_Option_Payroll_Item_Definition__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Payroll_Check_Entry_Option_Payroll_Item_Definition |
FK_Payroll_Check_Entry_Option_Shortfall_Deduction_Treatment__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Payroll_Check_Entry_Option_Shortfall_Deduction_Treatment |
FK_Employer_Contribution_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Employer_Contribution_Item |
FK_Employee_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Employee_Payroll_Item |
FK_Insurepay_Client_Class_Code_N_Client_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Insurepay_Client_Class_Code_N_Client_Payroll_Item |
FK_Benefit_Accrual_Exclusion_Detail__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Benefit_Accrual_Exclusion_Detail |
FK_Pay_Item_Exclusion_Detail__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Pay_Item_Exclusion_Detail |
FK_Pay_Item_Exclusion_Detail__Client_Payroll_Item__excluded__client_payroll_item_KEY | excluded__client_payroll_item_KEY | Pay_Item_Exclusion_Detail |
FK_Payroll_Check_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Payroll_Check_Payroll_Item |
FK_Shortfall_Transaction_N_Client_Payroll_Item__Client_Payroll_Item__client_payroll_item_KEY | client_payroll_item_KEY | Shortfall_Transaction_N_Client_Payroll_Item |