Pay Run - Garnishment

Payroll Administrator Guide

Version
R2025.2.1
ft:lastEdition
2025-12-01
Pay Run - Garnishment

Check Detail

Check Detail fields
Fields Description
Check Number Returns the check number associated with the payment if it was an on site check.
Check Template Returns the name of the check template associated with the check to which the garnishment applies. Access to this information is controlled by the Check Templates sub-feature of the Payroll Setup role feature. See Check Templates and Check Types.
Check Type Returns the check type associated with the check to which the earning applies.
Net Pay Returns the employee’s net pay from which the deduction was made; net pay is calculated as total pay minus applicable taxes and deductions.

Client Information

Client Information fields
Fields Description
Business Number Returns the legal entity’s business number, which is configured in Org Setup > Org Payroll Setup > Legal Entity. Access to this information is controlled by the Legal Entity sub-feature of the Org Setup > Org Payroll Setup role feature. See Configure Legal Entities in the Dayforce Implementation Guide.
Client Name Returns the name of the employer organization, which is configured in Site Setup > Client. Access to this information is controlled by the Client sub-feature of the Site Setup role feature. See Site Setup > Client in the Dayforce Implementation Guide.
DTS Tax ID

(US only) Returns the US legal entity’s tax service ID, which is configured in Org Setup > Org Payroll Setup > Legal Entity. Access to this information is controlled by the Legal Entity sub-feature of the Org Setup > Org Payroll Setup role feature. See Configure Legal Entities in the Dayforce Implementation Guide.

Legal Entity Name Returns the name of the legal entity to which the employee’s pay is associated, which is configured in Org Setup > Org Payroll Setup > Legal Entity. Access to this information is controlled by the Legal Entity sub-feature of the Org Setup > Org Payroll Setup role feature. See Configure Legal Entities in the Dayforce Implementation Guide.
Payroll Service Identifier Returns the legal entity's payroll service identifier. For customers using HPL/ HPW or HPL Canada, this is recorded in the Payroll Properties tab of Pay Setup > Pay Group. See Pay Setup Configuration in the Dayforce Implementation Guide.

Deductions

Deductions fields
Fields Description
Total Deductions Returns the total employee deductions for the pay run, which are defined in Payroll Setup > Earnings and Deductions. Access to this information is controlled by the Deductions sub-feature of the Payroll Setup > Earnings and Deductions role feature. See Deductions and the Deductions Tab in the Dayforce Implementation Guide.

Earnings

Earnings fields
Fields Description
Total Earnings Returns the total employee earnings for the pay run, which are defined in Payroll Setup > Earnings and Deductions. Access to this information is controlled by the Earnings sub-feature of the Payroll Setup > Earnings and Deductions role feature. See Earnings and the Earnings Tab in the Dayforce Implementation Guide.

Employee

Employee fields
Fields Description
Display Name

Returns the employee's full name in the Personal > Contact Information screen of People.

Employee Culture

Returns the employee’s preferred language culture in User Properties section of the Security Settings screen in People.

First Name

Returns the employee's first name in the Personal > Contact Information screen of People.

Last Name

Returns the employee's last name in the Personal > Contact Information screen of People.

Number Returns the employee number in the Employment Status tab of the Employment > Employment Settings screen in People.
SIN Expiry Date

Returns the expiry date of the employee’s Social Insurance Number in the Personal > Confidential Information screen of People.

SIN / SSN

Returns the employee’s social security or Social Insurance Number in the Personal > Confidential Information screen of People.

See Employee Administration in the Dayforce Implementation Guide.

Employee Contact Information

Employee Contact Information fields
Fields Description
Country

Returns the country listed in the employee's address in the Personal > Contact Information screen of People.

Employee Address

Returns the employee's street address in the Personal > Contact Information screen of People.

Employee Address 2

Returns the second line of the employee's street address in the Personal > Contact Information screen of People.

Employee City

Returns the country listed in the employee's address in the Personal > Contact Information screen of People.

Employee Postal Code

Returns the postal or ZIP Code listed in the employee's address in the Personal > Contact Information screen of People.

Province / State

Returns the province or state listed in the employee's address in the Personal > Contact Information screen of People.

See Employee Administration in the Dayforce Implementation Guide.

Employee Employment Status

Employee Employment Status fields
Fields Description
Base Salary

Returns the employee’s base salary amount in the Employment Status tab of the Employment > Employment Settings screen in People.

Hire Date

Returns the date on which the employee was hired or onboarded. This is recorded in the Key Information tab of the Employment > Employment Settings screen in People.

Pay Group

Returns the name of the pay group to which the deduction applies, which is configured in the Pay Groups tab in Payroll Setup > Earnings and Deductions. Access to this information is controlled by the Deductions sub-feature of the Payroll Setup > Earnings and Deductions role feature. See Deductions and The Deductions Tab in the Dayforce Implementation Guide.

Pay Rate

Returns the employee’s pay rate in the Employment Status tab of the Employment > Employment Settings screen in People.

Status Group

Returns the status group of the employee's status in the Employment Status tab of the Employment > Employment Settings screen in People.

See Update Employment Status Records in the Dayforce Implementation Guide.

Employee Work Assignment

Employee Work Assignment fields
Fields Description
Employee Department Name

Returns the name of the department in which the employee works, which is recorded in the Work > Work Assignments screen of People.

Employee Job Name

Returns the employee’s job assignment title in the Work > Work Assignments screen of People.

Employee Work State Code

Returns the employee’s work state or province code. This information is found in Org Setup > Organization by selecting a work location in the Organization tab and then expanding the slide-out panel and viewing the Address tab. Access to this information is controlled by the Organization subfeature of the Org Setup role feature. See Org Setup Configuration in the Dayforce Implementation Guide.

Garnishment

Garnishment fields
Fields Description
Amount Returns the amount of the garnishment, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Audit Calculated Amount Returns the audit amount calculated for garnishment by the application. This is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Audit Input Amount Returns the audit amount scheduled for garnishment if the pay entry was recorded as a manual or onsite check, by quick entry, or as an adjustment. This is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Audit Scheduled Amount Returns the audit amount scheduled for garnishment if it was calculated automatically by the application. This is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Comments Returns the number of employees processed if the pay run has been calculated, which can also be seen when loading pay runs in Payroll.
EmployeeWage
AttachmentDesc
Returns the garnishment’s description, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Garnishment End Date Returns the end date of the garnishment, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Garnishment Name Returns the name of the garnishment, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Garnishment Type Returns the garnishment type, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.
Is Audit Only Returns a ‘True’ value if the deduction amount was not actually deducted and the data is for audit purposes only, or a ‘False’ value if the deduction was actually taken. This is determined by parameters in Payroll Setup > Earnings and Deduction. Access to this information is controlled by the Deductions sub-feature of the Payroll Setup > Earnings and Deductions role feature. See Deductions and the Deductions Tab in the Dayforce Implementation Guide.
Payee Name Returns the name of the payee to which the garnishment payment is made, which is configured in the Payroll > Garnishments screen of People. Access to this information is controlled by the People > Employee Profile > Payroll > Garnishments sub-feature of the Application Container role feature.

Pay Run Detail

Pay Run Detail fields
Fields Description
Commit Lock Phase Returns the pay run’s current commit lock phase in Payroll.
Disbursement Commit Phase Returns the state of the disbursements committal stage in Payroll.
Disbursement Commit State Returns the state of the pay run’s committal stage in Payroll.
Off Cycle Pay Run Name Returns the name of the off cycle pay run, which is configured in Payroll.
Pay Date Returns the date on which the pay run is paid, which is determined in the Pay Calendars tab in Pay Setup > Pay Group. Access to this information is controlled by Pay Group sub-feature of the Pay Setup role feature. See Pay Groups in the Dayforce Implementation Guide.
Pay Frequency Returns the frequency of the pay, which is configured in Pay Setup > Pay Group. Access to this information is controlled by the Pay Setup role feature. See Pay Setup Configuration in the Dayforce Implementation Guide.
Pay Period Returns the pay period number, which is configured in the Pay Calendars tab in Pay Setup > Pay Group. Access to this information is controlled by the Pay Setup role feature. See Pay Setup Configuration in the Dayforce Implementation Guide.
Pay Run Guid Returns the pay run's unique identifier code, which is configured by the application and used internally to identify various drafts of a pay run.
Payroll Committed Returns either a ‘True’ or ‘False’ value, depending on whether the pay run has been committed by a payroll administrator in Payroll.
Payroll Committed Date Returns the date on which the pay run was committed by a payroll administrator in Payroll.
Payroll Committed User Returns the name of the payroll administrator who committed the pay run in Payroll.
Payroll Lock Last Action Date Returns the date on which the last action was made on the pay run before being locked by a payroll administrator in Payroll.
Payroll Lock User Returns the name of the user who locked the pay run in Payroll.
Payroll Locked Returns either a ‘True’ or ‘False’ value, depending on whether the pay run has been locked by a payroll administrator in Payroll.
Period End Returns the pay period’s effective end date, which is found in the Pay Calendars tab in Pay Setup > Pay Group. Access to this information is controlled by the Pay Setup role feature. See Pay Setup Configuration in the Dayforce Implementation Guide.
Period Start Returns the pay period’s effective start date, which is found in the Pay Calendars tab in Pay Setup > Pay Group. Access to this information is controlled by the Pay Setup role feature. See Pay Setup Configuration in the Dayforce Implementation Guide.
Reports Commit State Returns the state of the pay run’s reports in Payroll.
Voucher Number Returns the voucher number.

Pay Type

Pay Type fields
Fields Description
Pay Type Group

Returns the pay type group of the employee's pay type in the Employment Status tab of the Employment > Employment Settings screen in People.

Taxes

Taxes fields
Fields Description
Applied 2020 W4 Calc Indicates if the 2020 version of the W4 form was submitted in the pay run for the employee.
Federal Additional Amount

Returns any additional federal tax that the employee has opted to have deducted toward their year end taxes. This is configured in the Federal Tax Info section of the Payroll > Tax Definitions screen in People. See Employee Tax Information.

Federal Exemptions

Returns the number of employee dependents that count toward federal exemption. Dependent records are configured in the Benefits > Dependents and Beneficiaries screen of People. If your organization doesn't use the Benefits module, this can be done in the Personal > Dependents and Beneficiaries screen of People instead. Access to this information is controlled by the People > Employee Profile > Benefits > Dependents and Beneficiaries sub-feature of the Application Container role feature. This sub-feature can also be found under Application Container > People > Employee Profile > Personal. See Employee Tax Information.

Local Exemptions

Returns the number of employee dependents that count toward local exemption. Dependent records are configured in the Benefits > Dependents and Beneficiaries screen of People. If your organization doesn't use the Benefits module, this can be done in the Personal > Dependents and Beneficiaries screen of People instead. Access to this information is controlled by the People > Employee Profile > Benefits > Dependents and Beneficiaries sub-feature of the Application Container role feature. This sub-feature can also be found under Application Container > People > Employee Profile > Personal. See Employee Tax Information.

Marital Status (Federal)

Returns the employee’s marital status for federal tax filing. This is recorded in the Personal > Confidential Information screen of People. See Employee Tax Information.

Marital Status (State)

Returns the employee’s marital status for state tax filing. This is recorded the Personal > Confidential Information screen of People. See Employee Tax Information.

State Additional Amount

Returns any additional state or provincial tax that the employee has opted to have deducted toward their year end taxes, which is configured in the State Tax Info or Provincial Tax Info section of the Payroll > Tax Definitions screen in People. See Employee Tax Information.

State Exemptions

Returns the number of employee dependents that count toward state exemption. Dependent records are configured in the Benefits > Dependents and Beneficiaries screen of People. If your organization doesn't use the Benefits module, this can be done in the Personal > Dependents and Beneficiaries screen of People instead. Access to this information is controlled by the People > Employee Profile > Benefits > Dependents and Beneficiaries sub-feature of the Application Container role feature. This sub-feature can also be found under Application Container > People > Employee Profile > Personal. See Employee Tax Information.

Total Employee Taxes Returns the total employee taxes for the check from which the deduction was made, which are defined in Payroll Setup > Payroll Taxes. Access to this information is controlled by the Payroll Tax sub-feature of the Payroll Setup role feature. See Employee Tax Information.
Total Employer Taxes Returns the total employer taxes for the check from which the deduction was made, which are system-configured and can be viewed in Payroll Setup > Payroll Taxes. Access to this information is controlled by the Payroll Taxes sub-feature of the Payroll Setup role feature. See Payroll Setup > Payroll Taxes in the Dayforce Implementation Guide.
Total Insured Earnings Returns the employee’s total insured earnings for the check from which the deduction was made. Access to this information is controlled by the Payroll Policies sub-feature of the Payroll Setup role feature.
W4 Deductions Returns the amount in box 4(b) in the employee's W4 form.
W4 Dependent Tax Credit Returns the amount in box 3 in the employee's W4 form.
W4 Other Income Returns the amount in box 4(a) in the employee's W4 form.
W4 Two Jobs Returns the employee's response to Step 2 in the W4 form.