Set up Additional Payroll Data (APD) for Global Payroll

The Additional Payroll Data (APD) plugin manages the sync of additional payroll data fields between Workday and Deel, such as bank details and country-specific fields, that are needed to process payroll but are not part of the core employee record.

Data synced: Additional payroll data fields (bank details, country-specific fields) 

Sync direction: Bidirectional (Workday to Deel and Deel to Workday) 

Available for: Global Payroll (GP) 

In this article

• Before you begin
  • Required permissions
• How APD works
• Activating domains for optional plugins
  • Step 1: Activate the required domains
  • Step 2: Assign users or groups to domains
  • Step 3: Activate pending security policy changes
• Workday setup
  • Step 1: Add APD scopes to the API client
  • Step 2: Add the APD feature to the external payroll vendor
  • Step 3: Edit the external payroll vendor mapping for APD
  • Step 4: Enable APD for the required pay groups
  • Step 5: (Optional) Add APD to the worker profile
  • Step 6: Activate pending security policy changes
• Deel setup
  • Step 7: Enable the APD plugin
• Using APD
  • Fill APD from the worker profile

Before you begin

Before starting the APD setup, make sure you have completed the required parts of the common connection setup. If you haven't done this yet, go to How to connect Workday GPC to Deel first.

Parts 1, 2, and 3 of the common setup must be complete before continuing:

• Part 1: Connecting Workday to Deel - creating an ISU, setting up security groups, an API client, tokens, and connecting to Deel
• Part 2: Setting up DCoD - integration system, external payroll vendor, and vendor mapping

You will also need:

• Fields to map agreed with your Deel integration specialist before starting. The mapping interface is only accessible to Deel representatives

Required permissions

Before you enable the APD plugin, add the following permissions to your security group in Workday. Use the Maintain Permission for Security Group task to add these.

Access type definitions:

• Get = Read-only access via the integration layer
• Get/Put = Read and write access via the integration layer
• View = Read access via the UI
• View/Mod = Read and modify access via the UI

How APD works

Data flows in two directions:

• Deel to Workday - Deel sends Workday a data schema that defines the expected fields, formats, allowed values, and validation rules. Workday uses this schema to present employees with a form they can fill in directly from their worker profile. Validation happens in real time. For example, enforcing that a bank country code is exactly 12 characters and contains only digits.
• Workday to Deel - Once employees fill in the form in Workday, Deel retrieves the data at the next sync and uses it to process payroll.

Activating domains for optional plugins

Some plugins require additional domain security policies to be active in Workday before they can be enabled in Deel. Each time you enable a new plugin, complete the steps below for that plugin before proceeding to its setup guide.

To find out which domains are required for the plugin you are setting up, refer to the Security permissions reference and locate the column for your plugin.

Step 1: Activate the required domains

1. Search for the domain using the domain: prefix. For example, domain: Set Up: Payroll Interface.
2. In the Domain Security Policy section, use the related actions to go to Domain Security Policy > Enable.

3. On the following screen, confirm the enablement.
4. Repeat for any remaining domains required for your plugin.

Already active?

If a domain is already active, skip it and move to the next one.

Step 2: Assign users or groups to domains

1. Open the domain.
2. In the Domain Security Policy section, use the related actions to go to Domain Security Policy > Edit Permissions.

3. In the Report/Task Permissions section, check that the required security groups are present. If any are missing, add them.

4. Save your changes.

To add users to the relevant security group, use the Assign Users to User-Based Security Group task.

Step 3: Activate pending security policy changes

1. Launch the Activate Pending Security Policy Changes task.
2. Enter a comment describing the reason for the change and save.

For more information, visit Activate Pending Security Policy Changes in the Workday Community.

Workday setup

Step 1: Add APD scopes to the API client

1. Launch the View API Clients report and go to the API Clients for Integrations tab.
2. Select the API client created during the common setup.
3. Use the related actions to go to API Client > Edit API Client for Integrations.
4. Add the required scopes for ExPD as listed in the Scopes reference.
5. Click OK to save your changes.

Step 2: Add the APD feature to the external payroll vendor

1. Launch the Edit External Payroll Vendor task and select the external payroll vendor created during the common setup.
2. Add Additional Payroll Data to the list of features for the vendor.
3. Save your changes.

Step 3: Edit the external payroll vendor mapping for APD

1. Launch the Edit External Payroll Vendor Mapping task and select the external payroll vendor created during the common setup.
2. In the Feature Configuration section, add the Additional Payroll Data feature with the following attributes:

3. Save your changes.

Step 4: Enable APD for the required pay groups

1. Launch the Maintain Pay Group Vendor Associations task.
2. Add a new vendor with the following settings:

Pay groups can only be assigned to one vendor 

If a pay group you want to assign is already assigned to another vendor, remove it from that vendor first.

Step 5: (Optional) Add APD to the worker profile

This makes the additional payroll data form appear directly in the worker's profile, so employees can fill it out without using the My Additional Payroll Data report.

1. Launch the Configure Profile Group task.
2. Select the Pay for Worker Profile profile group.
3. Add the Additional Payroll Data section to the profile group.
4. Save your changes.

Other ways to collect APD

APD can also be made available in the Benefits and Pay Hub, or integrated into the hiring process so employees are prompted to fill it during onboarding. Contact your Workday representative for guidance on these options.

Step 6: Activate pending security policy changes

1. Launch the Activate Pending Security Policy Changes task.
2. Enter a comment describing the reason for the change and save.

Deel setup

Step 7: Enable the APD plugin

1. From the integration's main page, locate the Global Payroll - Additional Payroll Data plugin and click Enable.
2. On the following screen, click Enable again.

After enabling the plugin, workers will start seeing the additional payroll data form in Workday at the next sync.

Using APD

Fill APD from the worker profile

Workers can fill APD directly from their Workday profile if the APD section has been added by the admin.

1. Launch the My Additional Payroll Data task.
2. Select the available position and click OK.
3. Click Edit on the form containing the information you want to update.
4. Fill in the required information and click Submit.

The information is saved and submitted to Deel at the next data sync.

Workers who do not have APD in their profile can still use the My Additional Payroll Data report to fill in their data.