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.
In this article
- Before you begin
- How APD works
-
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
- Using APD
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
- Part 3: Activating domains for optional plugins - activate the required ExPR domains and assign user groups. See the ExPR column in the Security permissions reference.
You will also need:
- Fields to map agreed with your Deel integration specialist before starting. The mapping interface is only accessible to Deel representatives
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.
Workday setup
Step 1: Add APD scopes to the API client
- Launch the View API Clients report and go to the API Clients for Integrations tab.
- Select the API client created during the common setup.
- Use the related actions to go to API Client > Edit API Client for Integrations.
- Add the required scopes for ExPD as listed in the Scopes reference.
- Click OK to save your changes.
Step 2: Add the APD feature to the external payroll vendor
- Launch the Edit External Payroll Vendor task and select the external payroll vendor created during the common setup.
- Add Additional Payroll Data to the list of features for the vendor.
- Save your changes.
Step 3: Edit the external payroll vendor mapping for APD
- Launch the Edit External Payroll Vendor Mapping task and select the external payroll vendor created during the common setup.
- In the Feature Configuration section, add the Additional Payroll Data feature with the following attributes:
| Attribute | Value |
| Data Submission Endpoint | Retrieve this URL from the integration page in Deel by clicking Enable next to the Global Payroll - Additional Payroll Data plugin |
| Landing Page Endpoint | Same URL as the Data Submission Endpoint |
| Force Recalculate Endpoint | Same URL as the Data Submission Endpoint, with /recalculate appended. For example: https://api.demo.deel.com/apps/webhooks/workday/{INTEGRATION_ID}/apd/recalculate |
- Save your changes.
Step 4: Enable APD for the required pay groups
- Launch the Maintain Pay Group Vendor Associations task.
- Add a new vendor with the following settings:
| Setting | Value |
| External Payroll Vendor | The vendor you added the APD feature to |
| Feature | Additional Payroll Data |
| Pay Group | All pay groups you want to sync APD for |
| Payroll Organization Type | Retrieve using the Maintain Organization Types report > Custom tab |
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.
- Launch the Configure Profile Group task.
- Select the Pay for Worker Profile profile group.
- Add the Additional Payroll Data section to the profile group.
- Save your changes.
Step 6: Activate pending security policy changes
- Launch the Activate Pending Security Policy Changes task.
- Enter a comment describing the reason for the change and save.
Deel setup
Step 7: Enable the APD plugin
- From the integration's main page, locate the Global Payroll - Additional Payroll Data plugin and click Enable.
- 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.
- Launch the My Additional Payroll Data task.
- Select the available position and click OK.
- Click Edit on the form containing the information you want to update.
- 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.