Report Designer: Payroll Item variables

Show expandable text

We moved!

Help articles have been migrated to the new Help and Support. You can find help for your products and accounts, discover FAQs, explore training, and contact us!

The Report Designer Payroll Item variables display information on reports about the setup of payroll items. The following tables list all of the currently available variables, what they output, and where the information is retrieved from within the application.

See also: Variables overview

Workpapers CS users: This section of variables is visible in the Design Tools frame in the Report Designer, but will not output any information. If any of these variables are inserted, the report or other document may display as "This report contains no data."

Payroll Item

Variable name Data content/source Format Variable syntax
Agent ID The Agent ID of the agent linked to payroll item from Setup > Payroll Items Text [PayrollItem.AgentID]
Agent Name The name of the agent linked to the payroll item from Setup > Payroll Items Text [PayrollItem.AgentName]
Description The name of the payroll item from Setup > Payroll Items Text [PayrollItem.Description]
Inactive Inactive checkbox from Setup > Payroll Items Yes/no [PayrollItem.Inactive]
Report Description The report description field from Setup > Payroll Items Text [PayrollItem.ReportDescription]
Type The payroll item type (Pay, Deduction, or Employer Contribution) from Setup > Payroll Items Text [PayrollItem.Type]

Auto-Pay

Variable name Data content/source Format Variable syntax
Amount Amount checkbox on Setup > Payroll Items Yes/no [PayrollItem.AutoPay.Amount]
Hours Standard hours checkbox on Setup > Payroll Items Yes/no [PayrollItem.AutoPay.StandardHours]

Calculation

Variable name Data content/source Format Variable syntax
Alternate Minimum Wage The alternate minimum wage entered on Setup > Payroll Items Amount [PayrollItem.Calculation.AlternateMinimumWage]
Calculation Type The calculation type of the payroll item from Setup > Payroll Items Text [PayrollItem.Calculation.CalculationType]
Calculation Deduction The deduction item used in the calculation of the payroll item when the calculation type is set to "Percent of deduction" on Setup > Payroll Items Text [PayrollItem.Calculation.Deduction]
Default Rate The default rate from Setup > Payroll Items Number [PayrollItem.Calculation.DefaultRate]
Default Basis The default rate basis (amount, percent, etc.) from Setup > Payroll Items Text [PayrollItem.Calculation.DefaultRateBasis]
Graduated Table Calculation Type The calculation type from the Graduated Table dialog from Setup > Payroll Items Text [PayrollItem.Calculation.GraduatedTable.CalculationType]
Graduated Table Deduction The deduction item used in the calculation of the payroll item (i.e. when the calculation type is percent of deduction) from the Graduated Table dialog from Setup > Payroll Items Text [PayrollItem.Calculation.GraduatedTable.Deduction]
Graduated Table Default Rate The first column in the graduated table dialog from Setup > Payroll Items Number [PayrollItem.Calculation.GraduatedTable.DefaultRate]
Graduated Table From The “From” column on the Graduated Table dialog on Setup > Payroll Items Amount/Number [PayrollItem.Calculation.GraduatedTable.From]
Graduated Table Limit Deduction The deduction selected from the limit section of the Graduated Table dialog when the limit calculation type is % of Deduction from Setup > Payroll Items Text [PayrollItem.Calculation.GraduatedTable.LimitDeduction]
Graduated Table Limit Method The limit method (MTD, per check, etc.) of the payroll item from the Graduated Table dialog from Setup > Payroll Items Text [PayrollItem.Calculation.GraduatedTable.LimitMethod]
Graduated Table Limit Type The limit type (Amount, % of gross pay, etc.) of the payroll item from the Graduated Table dialog from Setup > Payroll Items Text [PayrollItem.Calculation.GraduatedTable.LimitType]
Graduated Table To The “To” column on the Graduated Table dialog on Setup > Payroll Items Amount/Number [PayrollItem.Calculation.GraduatedTable.To]

Exclusions

Variable name Data content/source Format Variable syntax
Exclude Amount from Gross Pay Amount from gross pay presentation checkbox on Setup > Payroll Items Yes/no [PayrollItem.Exclusions.AmountfromGrossPayPresentation]
Exclude Hours from Gross Pay Hours from gross pay presentation checkbox on Setup > Payroll Items Yes/no [PayrollItem.Exclusions.HoursfromGrossPayPresentation]
Exclude from Net Pay Net pay checkbox on Setup > Payroll Items Yes/no [PayrollItem.Exclusions.NetPay]
Excluded Accruable Benefits Description The description of the selected excluded accruable benefits from the dialog on Setup > Payroll Items Text [PayrollItem.Exclusions.AccruableBenefits.Description]
Excluded Accruable Benefits List The list of selected excluded accruable benefits from Setup > Payroll Items (will output “All” or “None” if chosen) Text [PayrollItem.Exclusions.AccruableBenefits.ItemList]
Excluded Payroll Items Description The description of the selected excluded pay items from the dialog on Setup > Payroll Items Text [PayrollItem.Exclusions.PayrollItems.Description]
Excluded Payroll Items List The list of selected excluded pay items from Setup > Payroll Items (displays “All” or “None” if chosen) Text [PayrollItem.Exclusions.PayrollItems.ItemList]
Excluded Workers’ Compensation Description The description of the selected excluded states for Workers’ compensation from Setup > Payroll Items Text [PayrollItem.Exclusions.WorkersCompensation.Description]
Excluded Workers’ Compensation List The list of selected excluded states for Workers’ compensation from Setup > Payroll Items Text [PayrollItem.Exclusions.WorkersCompensation.ItemList]

General Ledger Accounts

Variable name Data content/source Format Variable syntax
GL Expense Account Number The GL expense account number from Setup > Payroll Items Text [PayrollItem.GeneralLedgerAccounts.GLExpenseAccount]
GL Expense Account Description The GL expense account description from Setup > Payroll Items Text [PayrollItem.GeneralLedgerAccounts.GLExpenseAccountDescription]
GL Liability Account Number The GL liability account number from Setup > Payroll Items Text [PayrollItem.GeneralLedgerAccounts.GLLiabilityAccount]
GL Liability Account Description The GL liability account description from Setup > Payroll Items Text [PayrollItem.GeneralLedgerAccounts.GLLiabilityAccountDescription]

Limit

Variable name Data content/source Format Variable syntax
Deduction Limit The deduction limit from the limit section on Setup > Payroll Items Text [PayrollItem.Limit.Deduction]
Limit Method The limit method (per check, MTD, etc.) from Setup > Payroll Items Text [PayrollItem.Limit.Method]
Limit Rate The limit rate from Setup > Payroll Items Number [PayrollItem.Limit.Rate]
Subject to HSA Limit Subject to Health Savings Account Limit checkbox from Setup > Payroll Items Yes/no [PayrollItem.Limit.SubjecttoHealthSavingsAccountLimit]
Limit Type The limit type (% of gross pay, amount, etc.) from Setup > Payroll Items Text [PayrollItem.Limit.Type]

Multipliers

Variable name Data content/source Format Variable syntax
Double Time The double time multiplier from Setup > Payroll Items Number [PayrollItem.Multipliers.DoubleTime]
Overtime The overtime multiplier from Setup > Payroll Items Number [PayrollItem.Multipliers.Overtime]

Special Type

Variable name Data content/source Format Variable syntax
Type The description of the special type of the payroll item from Setup > Payroll Items Text [PayrollItem.SpecialType.Type]
Garnishment Type The description of the garnishment special type from Setup > Payroll Items Text [PayrollItem.SpecialType.Garnishment.Type]
Retirement/Cafeteria Plan Description The description of the retirement/cafeteria plan special type from Setup > Payroll Items Text [PayrollItem.SpecialType.RetirementCafeteriaPlan.Description]
Retirement/Cafeteria Plan Type The type of the retirement/cafeteria plan (cafeteria, retirement, etc.) special type from Setup > Payroll Items Text [PayrollItem.SpecialType.RetirementCafeterialPlan.Type]

Tax Exemptions

Variable name Data content/source Format Variable syntax
Federal Tax Exemption List The list of federal tax exemptions from Setup > Payroll Items Text [PayrollItem.TaxExemptions.FederalTaxes.TaxList]
Local Tax Exemption List The list of local tax exemptions from Setup > Payroll Items Text [PayrollItem.TaxExemptions.LocalTaxes.TaxList]
State Tax Exemption List The list of state tax exemptions from Setup > Payroll Items Text [PayrollItem.TaxExemptions.StateTaxes.TaxList]

Taxability

Variable name Data content/source Format Variable syntax
FUTA Exempt The selection in the FUTA exempt payments field from Setup > Payroll Items Text [PayrollItem.Taxability.FUTAExemptPayments]

W-2 Additional Boxes

Variable name Data content/source Format Variable syntax
Box 10 Box 10 – Dependent Care Benefits checkbox on Setup > Payroll Items Yes/no [PayrollItem.W2AdditionalBoxes.Box10DependentCareBenefits]
Box 11 Box 11- Nonqualified plans checkbox on Setup > Payroll Items Yes/no [PayrollItem.W2AdditionalBoxes.Box11NonqualifiedPlans]
Box 11 Type The selection of the nonqualified plan type (Sec. 457 or Other) from Setup > Payroll Items Text [PayrollItem.W2AdditionalBoxes.Box11NonqualifiedPlansType]
Box 12 Code Box 12 – Code checkbox on Setup > Payroll Items Yes/no [PayrollItems.W2AdditionalBoxes.Box12Code]
Box 12 Code Description The selection in the Box 12 code field from Setup > Payroll Items Text [PayrollItems.W2AdditionalBoxes.Box12CodeDescription]
Box 13 Retirement Plan Box 13 – Retirement plan checkbox on Setup > Payroll Items Yes/no [PayrollItems.W2AdditionalBoxes.Box13RetirementPlan]
Box 13 Third Party Sick Pay Box 13 – Third-party sick pay checkbox on Setup > Payroll Items Yes/no [PayrollItems.W2AdditionalBoxes.Box13ThirdPartySickPay]
Box 14 Box 14 – Other checkbox on Setup > Payroll Items Yes/no [PayrollItems.W2AdditionalBoxes.Box14Other]
Box 14 Description The selection from the Box 14 – Other field on Setup > Payroll Items Text [PayrollItems.W2AdditionalBoxes.Box14OtherDescription]
KS KPERS or KPF KS KPERS or KPF checkbox on Setup > Payroll Items Yes/no [PayrollItems.W2AdditionalBoxes.KSKPERSorKPF]

Wage Type

Variable name Data content/source Format Variable syntax
California Bonus Bonus (CA) checkbox on Setup > Payroll Items Yes/no [PayrollItems.WageType.BonusCA]
Supplemental Overtime and Double time OT/DT are supplemental checkbox on Setup > Payroll Items Yes/no [PayrollItems.WageType.OTDTareSupplemental]
New York Other Wages Other wages (NY) checkbox on Setup > Payroll Items Yes/no [PayrolItems.WageType.OtherWagesNY]
Wage Type The wage type (Regular or Supplemental) from Setup > Payroll Items Text [PayrollItems.WageType.Type]

See also: Report Designer: Procedures

Was this article helpful?

Thank you for the feedback!