Add Parameters to Payees

Payees can have one or more parameters that users fill out when they add the payee to an earning or deduction configuration or employee payroll election. For example, a payee might require a parameter where users enter an employee's member certificate number for a medical plan related to the payee when setting up a deduction or an employee election.

In the Payees tab of Payroll Setup > Third Party Payees, the details of a selected payee include the Parameters section, where you can add one or more parameters for the payee (or review the read-only parameters of system payees).

For example, for a custom 401(k) payee, you add parameters for an account number, contact phone number, and postal code.

When you set up an election to which this payee is associated in the Payroll > Payroll Elections screen of People for an employee, the application displays the parameters you added in the Payee section of the election record:

To define payee parameters for a payee:

1. Go to Payroll Setup > Third Party Payees.
2. In the Payees tab, select a payee in the sidebar.
3. In the Parameters section of the selected payee, click Add.
4. Enter a name and description. The name is what appears to users who are defining the parameter, while the description isn’t user-facing.
5. Select one of the following options in the Access drop-down list:
   • Pay Group: Enables users to define the parameter for pay groups in earning or deduction configurations.
   • Pay Group or Employee Override: Enables users to define the parameter for pay groups in earning or deduction configurations, or in payroll elections for individual employees.
   • Employee: Enables users to define the parameter in payroll elections for individual employees.
6. Select the Required checkbox to make this parameter mandatory, so that the application returns a validation error if users don’t fill it out.
7. Enter the format of the parameter in the Pattern field, if necessary. You can use the following delimiters:
   • B (blank space)
   • # (number)
   • * (letter)
8. For example, if the parameter is a 12-digit number, delimited by spaces, you can enter the following in the Value Pattern field: ####B####B####, and users need to enter this exact format.
9. In the parameter that users see, the application displays the pattern in the tooltip next to the parameter name:
10. 
11. Note: If you enter a format in the Pattern field, it overrides the selection (if any) that you make in the Data Type drop-down list.
8. Select one of the following options in the Data Type drop-down list, if needed:
   • Number: Users can only enter an all numeric value.
   • String: Users can enter a combination of letters, numbers, and characters.
9. In the Max Length field, enter the maximum number of characters that a user can enter in the parameter field, if necessary.
10. Note: If you define the Pattern field, the application auto-populates the Max Length field. However, if you edit the Max Length field after it is auto-populated, the Max Length field overrides the Pattern field. For example, if you enter a value that is 12 characters long in the Pattern field and you change the value in the Max Length field from 12 to 10, the application enforces a 10-character limit and won't allow users to save the value in this field.
11. If you don’t define the Pattern field, but you define the Data Type drop-down list and Max Length field, then the tooltip next to the parameter that users see displays the data type and max length:
12. 
10. Select an option in the Parameter Type drop-down list to define how the parameter will be used.
11. Enter a cross-reference code in the Reference Code field. Reference codes, also known as cross-reference codes, are used by Dayforce, usually in exports and imports, to integrate into other applications and systems used by your organization.
12. Click Save.