Pay Run - Earnings

Check Detail

Check Detail fields
Fields	Description
Branch Address Name	Returns the name of the bank branch from which the check was issued, which is configured in the Branches tab of Payroll Setup > Bank Accounts. Access to this information is controlled by the Bank Accounts sub-feature of the Payroll Setup role feature.
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 from which the deduction was made. 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 from which the deduction was made. Access to this information is controlled by the Checks sub-feature of the Payroll role feature.
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
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.
FEIN/BN	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.
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 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.

Deductions

Deductions fields
Fields	Description
Total Deductions	Returns the total employee deductions for the check from which the deduction was made, 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
Amount	Returns the amount of the earning, which is configured 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.
Audit Calculated Amount	Returns the audit amount calculated for the earning by the application. This is determined by parameters 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.
Audit Input Amount	Returns the audit amount scheduled for the earning if it was recorded as a manual or onsite check, by quick entry, or as an adjustment. This is determined by parameters in Payroll Setup > Earnings and Deduction. Access to this information is controlled by the Earnings sub-feature of the Payroll Setup role feature.
Audit Only	Returns a ‘True’ value if the earning amount was not actually paid 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 Earnings sub-feature of the Payroll Setup role feature.
Audit Scheduled Amount	Returns the audit amount scheduled for the earning if it was calculated automatically by the application. This is determined by parameters 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.
Contribute to Net Pay	Returns either a 'True' or 'False' value, depending on whether the earning contributes to the employee's net pay. This information is determined by the earning type configured in the Details tab in Payroll Setup > Earnings and Deductions, and the parameter is controlled by the Earnings sub-feature of the Payroll Setup > Earnings and Deductions role feature.
Earning Date	Returns the date on which the earning was generated.
Earning Name	Returns the name of the earning, which is configured 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.
Earning Type	Returns the type of the earning, which is configured 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.
Expected Amount	Returns the expected or scheduled earning amount.
Hours	Returns the number of hours that are calculated toward the earning, which is configured 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.
Total Earnings	Returns the total employee earnings for the check to which the earning applies, 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.

Employee Contact Information

Employee Contact Information fields
Fields	Description
Address	Returns the employee's street address in the Personal > Contact Information screen of People.
Address 2	Returns the second line of the employee's street address in the Personal > Contact Information screen of People.
Country	Returns the country listed in the employee's address in the Personal > Contact Information screen of People.
Employee City	Returns the city listed in the employee's address in the Personal > Contact Information screen of People.
Postal / Zip 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
Department	Returns the name of the department in which the employee works, which is recorded 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.
Job	Returns the employee’s job assignment title in the Work > Work Assignments screen of People.
Job Assignment	Returns the employee’s job assignment title in the Work > Work Assignments screen of People.
Org Unit Name	Returns the name of the organizational unit associated with the employee’s earnings, which is configured in the Organization tab in Org Setup > Organization. Access to this information is controlled by the Organization sub-feature of the Org Setup role feature. See Org Setup Configuration in the Dayforce Implementation Guide.
Project	Returns the name of the project associated with the earning, which is configured in Projects. Access to this information is controlled by the Projects role feature. See Project Management Configuration in the Dayforce Implementation Guide.

Limits

Limits fields
Fields	Description
Limit Amount	Returns the earning limit amount, which is configured in the Earning Limit tab 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.
Limit Type	Returns the earning limit type, which is configured in the Earning Limit tab 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.
Over Limit Amount	Returns the amount by which the earning limit was exceeded, which is calculated for audit purposes only.

Location

Location fields
Fields	Description
Docket	Returns the name of the docket associated with the applicable earning, which is configured in Org Setup > Docket. Access to this information is controlled by the Dockets sub-feature of the Org Setup role feature. See Create Dockets in the Dayforce Implementation Guide.

Pay Run Detail

Pay Run Detail Fields
Fields	Description
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.
Commit Lock Phase	Returns the pay run’s current commit lock phase in Payroll.
Disbursement Commit Stage	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. Access to this information is controlled by the Off Cycle Pay Runs sub-feature of the Payroll role feature.
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	Returns the Pay Period Number for the pay run.
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.

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.
Insured	Returns either a 'True' or 'False' value, depending on whether the earning is insured. This information is configured in the Earning Code tab in Payroll Setup > Earnings and Deductions, and the parameter 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.
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.
Tax Exempt	Returns either a ‘True’ or ‘False’ value, depending on whether the earning is tax exempt, which is configured in the parameters panel in the Tax Authorities tab in Org Setup > Org Payroll Setup > Legal Entity. See The Tax Authorities Tab in the Dayforce Implementation Guide.
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 Tax 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.