Setting up the Workday GPC integration
This article explains how to prepare Workday GPC and Deel so that they can exchange data and how to connect them using the integration.
The Workday GPC integration is organized in plug-ins, where each plug-in is responsible for the sync of a specific part of the data. To be able to sync data between Workday GPC and Deel, configurations must be done on both Workday GPC and Deel.
In this article
- Before you begin
- Integration overview
- Set up Data Changes On Demand (DCoD)
- Set up recurring payments
- Set up one-time payments
- Set up Additional Payroll Data (APD)
- Set up External Payroll Documents (ExPD)
- Set up External Payroll Results (ExPR)
- Set up Global Payroll Hub (GPH)
- User operations
- Workday GPC integration reference
Before you begin
To configure the Workday GPC integration, make sure to have:
- The user used to set the integration up must have the necessary security permissions to perform the tasks in this guide. Some examples are:
Integration Administrator
,Payroll Interface Administrator
, andPayroll Integration Administrator
. - Third-party pay groups set up in Workday.
- Pay groups must have the option Used in Payroll Interface enabled.
- GRID enabled for your Workday tenant. Contact your Workday representative to ask for GRID to be enabled on your tenant.
- Workday Payroll Interface set up in Workday.
- A Third-Party Payroll Organization set up in Workday.
-
Third-Party Payroll Earnings and Deductions defined in Workday.
- Entities and pay groups set up in Deel.
- Global Payroll enabled for the entities.
- A list of the fields to be mapped between Deel and Workday. This list depends on your needs, talk to your Deel integration specialist to receive guidance on the fields. For more info, see Data mapping.
- (Optional) If you want to set up ExPD and you're already using the External Payslips REST API technology, you must disable that first.
Integration overview
The Workday GPC integration is organized in plugins, where each plugin is in charge of the sync of specific parts of the data between Workday GPC and Deel. Each plugin is accessed from the main integration page and is set up independently.
For a full list of supported business processes, visit List of supported business processes.
This section provides basic information about each plugin to help you gain a better understanding of the integration.
The following diagram illustrates the plugin structure and how it maps to Workday features and data being synced.
People match plugin
The people match plugin is enabled by default and works behind the scenes to make sure that the right profile in Workday is matched to the right profile in Deel using emails and other personal information.
This guarantees that data like payroll documents can be synced between the 2 systems even if other worker information like DCoD isn't synced.
Additionally, this plugin allows to match accounts manually. This can be helpful in scenarios where, for example, a worker is added to Deel manually and only later synced to Workday.
People data sync (DCoD) plugin
The people data sync plugin is responsible for syncing the core HR information required for processing payroll with Deel. This plugin relies on Data Changes on Demand (DCoD) to work.
In order to sync the information between the 2 systems, data must be mapped so that each field in Workday corresponds to a field in Deel. The mapping interface is only accessible to Deel representatives–Work together with them to set up the mapping based on the data dictionary.
For setup information, visit Set up Data Changes On Demand (DCoD).
Additional payroll data plugin
The additional payroll data plugin where you can manage the sync of Additional Payroll Data (APD) between Workday and Deel.
For more information, visit Set up Additional Payroll Data (APD).
One time payment sync plugin
The one-time payment sync plugin is responsible for syncing information about bonuses, commissions, and other payments that are not regularly paid. This way, such information can be included in the payroll when it's processed. This plugin relies on Data Changes on Demand (DCoD) to work.
Recurring payment sync plugin
The recurring payment sync plugin is responsible for syncing information about regular payments that are not part of the core salary packages, such as allowances and deductions. This way, such information can be included in the payroll when it's processed. This plugin relies on Data Changes on Demand (DCoD) to work.
External Payroll Documents (ExPD) sync plugin
The external payroll documents (ExPD) plugin where you can manage the sync of ExPD between Workday and Deel. After enabling it, the plugin lets you configure what documents you want to sync.
For more information, visit Set up External Payroll Documents (ExPD).
External Payroll Results (ExPR) sync plugin
The external payroll results (ExPR) plugin where you can manage the sync of ExPR between Workday and Deel. When setting up the plugin, you will be asked to map the pay groups between the 2 systems.
For more information, visit Set up External Payroll Results (ExPR).
Global Payroll Hub
The Global Payroll Hub plugin is responsible for submitting to Workday payroll cycle information that can be leveraged in the Global Payroll Hub.
Set up Data Changes On Demand (DCoD)
This section covers the Data Changes On Demand (DCoD) setup for the Workday GPC integration. For more information on user operations enabled by DCoD, visit Integration-related user operations.
Data Changes On Demand Workday setup
This section covers how to set up Data Changes on Demand in Workday.
Activate the required DCoD domains
For the integration to properly work, you must activate 2 domains:
Manage: Data Changes on Demand
Reports: Data Changes on Demand Results
To activate the required domains:
1. Open the Manage: Data Changes on Demand
domain. You can find it by using the domain:
prefix. For example, Domain: Manage: Data Changes on Demand
.
2. In the Domain Security Policy
section, use the related actions to enable the policy by going to Domain Security Policy > Enable.
3. On the following screen, confirm the domain security policy enablement.
4. Repeat from step 1 for the remaining Reports: Data Changes on Demand Results
domain.
For more information, visit Steps: Set Up Data Changes on Demand in the Workday Community.
Create an integration system user (ISU)
To create an ISU:
1. Launch the task Create, Integration System User
.
2. Fill in the user info and complete the creation.
For more information, visit Create Integration System User for Data Changes on Demand in the Workday Community.
Create a security group and assign the security permissions to it
To create a security group:
1. Launch the task Create: Security Group
.
2. Select Integration System Security Group (Unconstrained)
as the type.
3. Assign a name to the group and save your changes.
4. Assign the integration system user created in the previous step to the group, then save your changes.
5. Use related actions to navigate to Security Group > Maintain Domain Permissions for Security Group and assign all the permissions listed for the DCoD feature in Security permissions reference.
For more information, visit Create Integration System User for Data Changes on Demand in the Workday Community.
Activate pending security policy changes for DCoD-related domains
To activate the pending security policy changes:
1. Launch the task Activate Pending Security Policy Changes
.
2. Enter a comment with the reason for the change and save your changes.
For more information, visit Activate Pending Security Policy Changes in the Workday Community.
Register API client for DCoD
To register the API client:
1. Launch the task Register API Client for Integrations
.
2. Enter a name and fill the API client info as follows:
Setting | Value |
---|---|
Non-Expiring Refresh Tokens | Selected |
Scope (Functional Areas) | All the scopes marked for the DCoD feature in Scopes reference |
Include Workday Owned Scope | Selected |
3. Copy the client ID and client secret and store them for future use.
For more information, visit Register API Clients for Integrations in the Workday Community.
Generate a refresh token
To generate a refresh token:
1. Launch the View API Clients
report and go to the API Clients for Integrations tab.
2. Copy the URL in Workday REST API Endpoint and store it for future use. Some parts of the URL will be needed to connect to Deel. For more information, see URL breakdown.
3. Locate the API client previously created and, using the related actions, go to API Client > Manage Refresh Tokens for Integrations.
4. Select the workday integration user account previously created.
5. Generate a refresh token and store it for future use.
For more information, visit the Next Steps section in Register API Clients for Integrations in the Workday Community.
Create an integration system
To create an integration system:
1. Launch the Create integration system
task.
2. Fill the system info and select the Data Changes on Demand
template.
3. Save your changes.
For more information, visit Create Integration System in the Workday Community.
Create an external payroll vendor with the DCoD feature
To create an external payroll vendor:
1. Launch the task Create External Payroll Vendor
.
2. Select the Data Changes on Demand
feature and save your changes.
When setting up additional features like additional payroll data or ExPR later, you will come back to this task to add the features to the external payroll vendor.
Create an external payroll vendor mapping with the DCoD feature
To create an external payroll vendor mapping:
1. Launch the task Create External Payroll Vendor Mapping
.
2. Select the external payroll vendor created previously, select an environment, then save your changes.
3. On the following page, create a new x509 private key pair, then set it as active. We recommend activating the Do Not Allow Regeneration option for security reasons.
4. In the Feature Configuration section, add the Data Changes On Demand
feature and give it the following attributes:
Attribute | Value |
---|---|
Acknowledgment Endpoint | Any URL you want. This URL won't be used but Workday requires it to complete this step of the setup. |
Integration System User | The user account created in one of the previous steps |
For more information, visit Create External Payroll Vendor Mapping in the Workday Community.
Retrieve x509 public key
To retrieve the x509 private key pair:
1. Launch the View External Payroll Vendor Mapping
report.
2. In the Public Private Key Pairs section, hover on the key pair created previously, then use the related actions to go to x509 Private Key Pair > View Key Pair.
3. Copy the content of the Public Key field and store it for future use.
Enable DCoD for the required pay groups
To enable DCoD for the required pay groups:
1. Launch the Maintain Pay Group Vendor Associations
task.
2. Add a new vendor with the following settings:
Setting | Value |
---|---|
External Payroll Vendor | The external payroll vendor created previously |
Feature | Data Changes On Demand |
Pay Group | All the pay groups that you need to sync with Deel |
Payroll Organization Type | The payroll organization that you have defined as the external payroll vendor. You can retrieve this using the Maintain Organization Types report and going to the Custom tab, where all your custom organization types are listed. |
For more information, visit Maintain Pay Group Vendor Associations in the Workday Community.
Configure earnings
For payroll codes to be correctly synced to Deel, you must configure the external payroll earnings and deductions in Workday.
For more information, visit Steps: Define Third-Party Payroll Earnings and Deductions in the Workday Community.
Much of the configuration for external payroll earnings depends on your organization's needs, so we can't provide specific instructions. However, here are some high-level instructions:
1. Launch the task Maintain External Payroll Earnings
.
2. Select the pay groups that you want to configure earnings for.
3. Configure the earnings following these guidelines, then save your changes:
- The Name field is what you will see in the Deel UI. Make sure you set it so that it's recognizable.
- The Code field is what workers will see in their payroll. Make sure you set it so that it's recognizable.
- Map each entry to the respective compensation element, so that it can be processed correctly in the payroll.
- Set the override frequency to
Monthly
.
For more information, visit Manage External Payroll Earnings in the Workday Community.
Create payment election rules
The payment election rules allow for payment information to be synced between Deel and Workday.
Much of the configuration for payment election rules depends on your organization's needs, so we can't provide specific instructions. However, here are some high-level instructions:
1. Launch the task Maintain Payment Election Rules
.
2. Add a new rule, configure it following these guidelines, then save your changes:
- Set the Election Rule Type to
Payroll Interface Rule
. - Set the pay groups that the rules must be applied to.
- Set the Default Payment Type for Add Initial Election to
Direct Deposit
. - Set the Max Number of Elections to
1
. We don't support split elections. - Set the Default Payment Type Election to
Manual
.
3. Go to the rule's related actions > Integration IDs > Edit Reference ID.
4. Set the Reference ID Value to Deel_Payroll
and save your changes.
5. (Optional) Repeat the steps for as many rules as needed.
Data Changes on Demand Deel setup
This section covers how to set up Data Changes on Demand in Deel.
Connect to Workday GPC
To connect to Workday:
1. Go to More > Apps and search for Workday GPC in the App Store.
2. On the integration page, click Connect Workday GPC.
3. Enter the information to connect to Workday GPC, then click Connect & go to settings. You will need:
- The base URL retrieved when generating the refresh token. Refer to URL breakdown to understand which part of the URL is needed.
- The client ID and client secret retrieved when registering the API client
- The refresh token generated earlier
- The public x509 key retrieved earlier
Set up people data sync
Once the integration is connected, it's time to enable the people data sync. People data sync works on a per-entity basis.
To enable the sync:
1. In the Plugins and settings tab, locate the People data sync plugin and click Enable to launch the wizard.
2. On the Configuration step, map the entities and groups to be synced, then click Continue.
3. On the Sync entities step, configure the sync schedule, then click Continue.
4. On the Data/item mapping step, confirm that the field mapping is correct or edit it as needed, then click Continue.
a. (Optional) If you have included country-specific fields, you can map them from the Country-specific items section.
5. On the Review & confirm step, review your settings, then click Continue.
People sync is now enabled and will sync people data at the time scheduled. If you want, you can set up the sync for additional entities.
Set up recurring payments
This section covers the recurring payments setup for the Workday GPC integration. Recurring payments are part of DCoD and of the data to be synced to properly process payroll. For more information on user operations enabled by DCoD, visit Integration-related user operations.
Recurring payments Workday setup
Recurring payments are synced from Workday using DCoD. If you already set up DCoD, you can skip to the next section.
Recurring payments Deel setup
To configure recurring payments on Deel:
1. In the Plugins and settings tab, locate the Global Payroll - Recurring Payment Sync plugin and click Enable.
2. Click Configure next to an entity.
3. Map the Deel and Workday recurring payment types, then click Confirm.
4. On the confirmation dialog, confirm the mapping by clicking Enable.
5. (Optional) Repeat the steps for all the remaining entities.
Set up one-time payments
This section covers the one-time payments setup for the Workday GPC integration. One-time payments are part of DCoD and of the data to be synced to properly process payroll. For more information on user operations enabled by DCoD, visit Integration-related user operations.
One-time payments Workday setup
One-time payments are synced from Workday using DCoD. If you already set up DCoD, you can skip to the next section.
One-time payments Deel setup
To configure one-time payments on Deel:
1. In the Plugins and settings tab, locate the Global Payroll - One Time Payment Sync plugin and click Enable.
2. Click Configure next to an entity.
3. Map the Deel and Workday one-time payment types, then click Confirm.
4. On the confirmation dialog, confirm the mapping by clicking Enable.
5. (Optional) Repeat the steps for all the remaining entities.
Set up additional payroll data (APD)
This section covers the Additional Payroll Data (APD) setup for the Workday GPC integration. For more information on user operations enabled by APD, visit APD user operations.
Managing Additional Payroll Data
When syncing additional payroll data, data flows in 2 directions:
1. Deel > Workday
Deel sends Workday a detailed data structure that outlines the expected fields, data formats, allowed values, and validation logic. This information enables Workday to present employees with a form where they can fill the information. For example, enforcing that a bank country code is 12 characters long and contains only digits.
2. Workday > Deel
Users fill additional payroll data in Workday and receive real-time validation errors. Once employees have filled this information, Deel pulls it from Workday. The information is then used to process payroll as needed.
APD Workday setup
Activate the required APD domains
For the APD feature to properly work, the following domains must be active:
Self-Service: Payroll Interface (Additional Payroll Data)
Worker Data: Payroll Interface (Additional Payroll Data)
To activate the required domain:
1. Open a domain. You can find it by using the domain:
prefix. For example, Domain: Worker Data: Payroll Interface (Additional Payroll Data)
.
2. In the Domain Security Policy
section, use the related actions to enable the policy by going to Domain Security Policy > Enable.
3. On the following screen, confirm the domain security policy enablement.
4. Repeat from step 1 for the remaining domain.
Assign users or groups to the APD domains
After activating the domains, you must make sure that the right user or user groups are added to it, so that whoever is meant to access the additional payroll data can access it. There's 2 types of users who usually need access to additional payroll data:
- The ISU security group
To add users or groups to domains:
1. Check whether the users or groups have permissions for the domain.
1a. Open the domain. You can find it by using the domain:
prefix. For example, Domain: Self-Service: Payroll Interface (Additional Payroll Data)
.
1b. In the Domain Security Policy
section, use the related actions to edit the permissions by going to Domain Security Policy > Edit Permissions.
1c. Based on the domain, check that the right users or user groups are added to the Report/Task Permissions section. Use the following table for a reference of what users must be added to each domain.

4. From the domain, use the related actions to go to Domain Security Policy > Edit Permissions.
5. In the Report/Task Permissions section, add the required security groups as per the following table, then save your changes.
Domain | Security Group | View permission | Modify permission |
---|---|---|---|
Self-Service: Payroll Interface (Additional Payroll Data) | Employee As Self | Yes | Yes |
Worker Data: Payroll Interface (Additional Payroll Data) | Any security group who should view the employee data. For example, admins or payroll specialists. | Yes | Yes |
Register API client for APD
To register the API client:
1. Launch the task Register API Client for Integrations
.
2. Enter a name and fill the API client info as follows:
Setting | Value |
---|---|
Non-Expiring Refresh Tokens | Selected |
Scope (Functional Areas) | All the scopes marked for the APD feature in Scopes reference |
Include Workday Owned Scope | Selected |
Activate pending security policy changes for APD-related domains
To activate the pending security policy changes:
1. Launch the task Activate Pending Security Policy Changes
.
2. Enter a comment with the reason for the change and save your changes.
For more information, visit Activate Pending Security Policy Changes in the Workday Community.
Add the APD feature to the external payroll vendor
To edit the external payroll vendor and add the APD feature:
1. Launch the Edit External Payroll Vendor
task and select the external payroll vendor created previously for DCoD.
2. Add Additional Payroll Data
to the list of features for the vendor, then save your changes.
Edit the external payroll vendor mapping for the APD feature
1. Launch the Edit External Payroll Vendor Mapping
task and select the external payroll vendor created previously for DCoD.
2. In the Feature Configuration section, add the Additional Payroll Data
feature and give it the following attributes:
Attribute | Value |
---|---|
Data Submission Endpoint | You can retrieve this URL by going to the integration page on Deel, then clicking Enable next to the Global Payroll - Additional Payroll Data plugin. |
Landing Page Endpoint | Same URL used for the Data Submission Endpoint. |
Enable APD for the required pay groups
To 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:
Setting | Value |
---|---|
External Payroll Vendor | The external payroll vendor you added the APD feature to |
Feature | Additional Payroll Data |
Pay Group | All the pay groups that you want to sync with Deel. It's likely that they're the same you added when you enabled DCoD for the required pay groups. |
Payroll Organization Type | The payroll organization that you have defined as the external payroll vendor. You can retrieve this using the Maintain Organization Types report and going to the Custom tab, where all your custom organization types are listed. |
(Optional) Add APD to the worker profile
This task will make additional payroll data show up in a worker's profile so that they can fill it on their own. If APD isn't added to the worker profile, employees can fill their APD using the report My Additional Payroll Data
.
For more information, visit Fill APD from the worker's profile.
Having APD showing in the worker profile or using the My Additional Payroll Data
report are just 2 ways to let workers edit their APD, but there are others.
For example, APD can be made available in the Benefits and Pay Hub, or integrating the task in the hiring process so that users can be asked to fill the info as they're onboarded. We recommend speaking to your Workday representative for additional guidance.
To add APD to the worker profile:
1. Launch the task Configure Profile Group
.
2. Select the Pay for Worker Profile
profile group.
3. Add the Additional Payroll Data
section to the profile group, then save your changes.
Activate pending security changes again
At this point, you can activate the pending security policy changes again. Refer to Activate pending security policy changes for APD-related domains for more information.
APD Deel setup
Once the Workday setup for APD is complete, you must activate the APD plugin in Deel for APD data to start syncing correctly.
To activate the APD plugin in Deel:
1. From the integration's main page, locate the Global Payroll - Additional Payroll Data and click Enable.
2. In the upcoming screen, click Enable again.
After enabling the plugin you can sync data and workers will start seeing the additional payroll data to fill in Workday. For more information, see Fill APD from the Worker's profile.
Set up External Payroll Documents (ExPD)
This section covers the External Payroll Documents (ExPD) setup for the Workday GPC integration. For more information on user operations enabled by ExPD, visit ExPD user operations.
ExPD Workday setup
Activate the required ExPD domains
For the ExPD feature to properly work, check whether the following domains are active and, if not, activate them:
- Worker Data: Payroll Interface (External Payroll Documents)
- View: Maintain Payroll Interface
- Reports: Pay Calculation Results for Worker (External Payroll Documents)
- Reports: Pay Calculation Results for Worker (Payslips) |
- Self-Service: Payroll Interface (External Payroll Documents)
- Self-Service: Payroll Interface
- Self-Service: Payroll (My Payslips)
To activate the required domains:
1. Open a domain. You can find it by using the domain:
prefix. For example, Domain: Worker Data: Payroll Interface (External Payroll Documents)
.
2. In the Domain Security Policy
section, use the related actions to enable the policy by going to Domain Security Policy > Enable.
3. On the following screen, confirm the domain security policy enablement.
4. Repeat from step 1 for the remaining domains.
For more information, visit Steps: Set Up Data Changes on Demand in the Workday Community.
Assign users or groups to the ExPD domains
After activating the domains, you must make sure that the right user or user groups are added to it, so that whoever is meant to access the external payroll documents can access them. There's 2 types of users who usually need access to additional payroll documents:
- The payroll admins
- The employee
To add users or groups to domains:
1. Check whether the users or groups have permissions for the domain.
1a. Open the domain. You can find it by using the domain:
prefix. For example, Domain: Worker Data: Payroll Interface (External Payroll Documents)
.
1b. In the Domain Security Policy
section, use the related actions to edit the permissions by going to Domain Security Policy > Edit Permissions.
1c. Based on the domain, check that the right users or user groups are added to the Report/Task Permissions section. Use the following table for a reference of what users must be added to each domain.
User/Group | Domains |
---|---|
Admin or partner | - Worker Data: Payroll Interface (External Payroll Documents) - View: Maintain Payroll Interface - Reports: Pay Calculation Results for Worker (External Payroll Documents) - Reports: Pay Calculation Results for Worker (Payslips) |
Employee as Self (ESS) | - Self-Service: Payroll Interface (External Payroll Documents) - Self-Service: Payroll Interface - Self-Service: Payroll (My Payslips) |
(Optional) Activate pending security policy changes for ExPD-related domains
If you had to enable any of the domains listed in the previous section, you must activate the pending security policy changes with the task Activate Pending Security Policy Changes
.
For more information, refer to the section Activate pending security policy changes for DCoD-related domains.
Register API client for ExPD
To register the API client:
1. Launch the task Register API Client for Integrations
.
2. Enter a name and fill the API client info as follows:
Setting | Value |
---|---|
Non-Expiring Refresh Tokens | Selected |
Scope (Functional Areas) | All the scopes marked for the ExPD feature in Scopes reference |
Include Workday Owned Scope | Selected |
Configure profile group for ExPD
To configure the profile group for ExPD:
1. Launch the task Configure Profile Group
.
2. Select the Pay for Worker Profile
profile group.
3. Add the following sections to the profile group, then save your changes:
Payslips
Tax Documents
ExPD Deel setup
Once you set up ExPD on Workday, you can now set up the Deel part.
Activate document sync
To activate the document sync:
1. From the integration's main page, locate the Documents sync plugin and click Enable.
2. Turn on the sync for the document types you want to sync.
The documents will start syncing at the next sync and workers will see them by going to their Workday profile > Pay and selecting the relevant tab.
Set up External Payroll Results (ExPR)
External Payroll Results (ExPR) allows payroll results to be sent from Deel to Workday as result lines, so that the relevant users can get visibility of the breakdown of their salary packages or create detailed reports of their earnings and deductions in the context of G2N calculations.
When setting up the integration, Deel automatically attempts to map payroll components between Deel and Workday. When a component cannot be mapped automatically, the integration will automatically create a new component in Workday.
For more information on user operations enabled by ExPR, visit ExPR user operations.
ExPR Workday setup
This section covers the setup of ExPR in Workday. For more information, visit Steps: Set Up External Payroll Results Inbound Integration in the Workday Community.
Activate the required ExPR domains
For the ExPD feature to properly work, check whether the following domains are active and, if not, activate them. Check Security permissions reference for a list of the required domains.
To activate the required domains:
1. Open a domain. You can find it by using the domain:
prefix. For example, Domain: Set Up: Payroll Interface
.
2. In the Domain Security Policy
section, use the related actions to enable the policy by going to Domain Security Policy > Enable.
3. On the following screen, confirm the domain security policy enablement.
4. (Optional) Repeat from step 1 for the remaining domains.
Assign users or groups to the ExPR domains
After activating the domains, you must make sure that the right user or user groups are added to it, so that whoever is meant to access the external payroll results can access them. There's 2 types of users who usually need access to external payroll results:
- The payroll admins
- The employee
To add users or groups to domains:
1. Check whether the users or groups have permissions for the domain.
1a. Open the domain. You can find it by using the domain:
prefix. For example, Domain: Set Up: Payroll Interface
.
1b. In the Domain Security Policy
section, use the related actions to edit the permissions by going to Domain Security Policy > Edit Permissions.
1c. Based on the domain, check that the right users or user groups are added to the Report/Task Permissions section.
(Optional) Activate pending security policy changes for ExPR-related domains
If you had to enable any of the domains listed in the previous section, you must activate the pending security policy changes with the task Activate Pending Security Policy Changes
.
For more information, refer to the section Activate pending security policy changes for DCoD-related domains.
Register API client for ExPR
To register the API client:
1. Launch the task Register API Client for Integrations
.
2. Enter a name and fill the API client info as follows:
Setting | Value |
---|---|
Non-Expiring Refresh Tokens | Selected |
Scope (Functional Areas) | All the scopes marked for the ExPR feature in Scopes reference |
Include Workday Owned Scope | Selected |
Configure profile group for ExPR
To configure the profile group for ExPR:
1. Launch the task Configure Profile Group
.
2. Select the Pay for Worker Profile
profile group.
3. Add the following sections to the profile group, then save your changes:
External Payroll Results for Worker
ExPR Deel setup
To set up ExPR on Deel:
1. From the Integration's main page, locate the External Payroll Results (ExPR) sync plugin and click Enable.
2. If it's the first time you're setting up ExPR, verify that your ISU has all the required permissions, then click Continue.
3. Map the Deel pay groups to the Workday pay groups, then click Continue.
4. Review the sync process details, then click Continue.
ExPR will automatically map the Deel payroll components to the Workday ones and sync result lines at the next sync. For information on how to leverage the result lines in Workday, visit Use ExPR for reporting.
Set up Global Payroll Hub (GPH)
GPH is a feature that leverages payroll data being synced, you must set up DCoD first for GPH to work successfully. This section covers the setup of the GPH feature for the Workday GPC integration.
For more information on user operations enabled by GPH, visit GPH user operations.
GPH Workday setup
Activate the required GPH domains
For the GPH feature to properly work, check whether the following domains are active and, if not, activate them:
- Manage: Global Payroll Processing
- View: Global Payroll Hub
To activate the required domains:
1. Open a domain. You can find it by using the domain:
prefix. For example, Domain: Manage: Global Payroll Processing
.
2. In the Domain Security Policy
section, use the related actions to enable the policy by going to Domain Security Policy > Enable.
3. On the following screen, confirm the domain security policy enablement.
4. Repeat from step 1 for the remaining domains.
For more information, visit Steps: Set Up Data Changes on Demand in the Workday Community.
Assign users or groups to the GPH domains
After activating the domains, you must make sure that the right user or user groups are added to it, so that whoever is meant to access the global payroll hub data can access it. Usually, this kind of data is accessed by payroll admins.
To add users or groups to domains:
1. Check whether the users or groups have permissions for the domain.
1a. Open the domain. You can find it by using the domain:
prefix. For example, Domain: Manage: Global Payroll Processing
.
1b. In the Domain Security Policy
section, use the related actions to edit the permissions by going to Domain Security Policy > Edit Permissions.
1c. Based on the domain, check that the right users or user groups are added to the Report/Task Permissions section.
(Optional) Activate pending security policy changes for GPH-related domains
If you had to enable any of the domains listed in the previous section, you must activate the pending security policy changes with the task Activate Pending Security Policy Changes
.
For more information, refer to the section Activate pending security policy changes for DCoD-related domains.
Add the GPH feature to the external payroll vendor
To edit the external payroll vendor and add the GPH feature:
1. Launch the Edit External Payroll Vendor
task and select the external payroll vendor created previously for DCoD.
2. Add Global Payroll Hub
to the list of features for the vendor, then save your changes.
Edit the external payroll vendor mapping for the GPH feature
Assuming that you've already created an external payroll vendor mapping when setting up DCoD, you must now edit the mapping to add support for GPH.
1. Launch the Edit External Payroll Vendor Mapping
task and select the external payroll vendor created previously for DCoD.
2. In the Feature Configuration section, add the Global Payroll Hub
feature and give it the following attributes:
Attribute | Value |
---|---|
Payroll Processing Endpoint | You can retrieve this URL by going to the integration page on Deel, then clicking Enable next to the Global Payroll - Additional Payroll Data plugin, and replacing the final apd slug with gph . For example, https://api.demo.deel.com/apps/webhooks/workday/{INTEGRATION_ID}/gph
|
Enable GPH for the required pay groups
To enable GPH for the required pay groups:
1. Launch the Maintain Pay Group Vendor Associations
task.
2. Add a new vendor with the following settings:
Setting | Value |
---|---|
External Payroll Vendor | The external payroll vendor you added the GPH feature to |
Feature | Global Payroll Hub |
Pay Group | All the pay groups that you want to sync with Deel. It's likely that they're the same you added when you enabled DCoD for the required pay groups. |
Payroll Organization Type | The payroll organization that you have defined as the external payroll vendor. You can retrieve this using the Maintain Organization Types report and going to the Custom tab, where all your custom organization types are listed. |
Pay groups can only be assigned to a single vendor
GPH Deel setup
Once the Workday setup for GPH is complete, you must activate the GPH plugin in Deel for GPH data to start syncing correctly.
To activate the GPH plugin in Deel:
1. From the integration's main page, locate the Global Payroll Hub and click Enable.
2. In the upcoming screen, click Enable again.
After enabling the plugin you can sync data and users with access to the Global Payroll Hub will start seeing the payroll cycle information. For more information, see View payroll cycle information in Workday.
User operations
This section covers the operations and tasks that can be performed by users with access to the Workday GPC integration after it is set up by an integration admin.
Integration-related user operations
This section covers the user operations that can be performed in the Workday GPC integration in Deel.
Sync data
Data is synced automatically at the time you indicate when setting up the people data sync. However, you can always run manual syncs by clicking the Sync Workday GPC button in the integration page.
Process payroll
When data is synced and payroll is processed, you must review the payroll report and approve the payment so that we can charge you and pay your workers. For more information on how to pay workers, visit:
Once your workers are paid and the payslip is issued, if ExPD is set up, it will be synced at the next sync and workers will view it in Workday.
View payroll logs
The Payroll Logs section provides information about the status of the sync for each worker, allowing you to identify issues and troubleshoot them from a single place.
Using the actions and shortcuts provided from the payroll section, you can view the exact values that cause the issue and fix them from the mapping, or pause the sync temporarily so that the remaining data can be synced successfully.
To view the payroll logs:
1. From the integration's main page, go to the Payroll Logs tab.
2. Check the list of synced employees and attempt any fixes where necessary.
View event logs
The Event Logs section provides a record of the sync events between Workday and Deel, allowing you to keep track of the syncs and troubleshoot possible issues. For example, you can use the event logs to understand whether a new payslip is being correctly synced from Deel to Workday.
To view the event logs:
1. From the integration's main page, go to the Event Logs tab.
2. Check the list of events and, if necessary, provide this information to your Deel representative for additional troubleshooting.
APD user operations
This section covers the user operations related to the Additional Payroll Data (APD) feature for the Workday GPC integration.
Fill APD from the worker's profile
Workers can fill APD data in many ways, depending on how the APD data is set to show for workers. This section explains how employees can fill APD in Workday if the APD section has been added to the worker's profile.
My additional payroll data
report to fill APD data if no additional ways to set it up have been configured.To fill APD from the worker's profile:
1. Launch the task My additional payroll data
.
2. Select the available position, then click OK.
3. Click Edit
on the form that contains the information you want to update.
4. Fill the required information, then click Submit.
The information is saved and submitted to Deel at the data sync.
ExPD user operations
This section covers the user operations related to the External Payroll Documents (ExPD) feature for the Workday GPC integration.
View ExPD in Workday as a worker
To see your external payroll documents as a worker:
1. Go to your profile.
2. Go to one of the following locations to find the synced payroll documents:
- Pay > Payslips
- Pay > Tax Documents
View ExPD in Workday as an admin
If Workday has been configured for admins to see an employee's payroll documents, here's how admins can view them:
1. Search for and open the worker's profile.
2. Go to one of the following locations to find the synced payroll documents:
- Pay > Payslips
- Pay > Tax Documents
ExPR user operations
This section covers the user operations related to the External Payroll Results (ExPR) feature for the Workday GPC integration.
Use ExPR for reporting as an admin
After you set up ExPR, you can use the newly synced data sources to generate reports that are specific to your business. How you use the ExPR data depends on your business needs and is out of the scope of this documentation.
We recommend reaching out to your Workday representative or starting from the following Workday Community documentation:
See ExPR in Workday as a worker
After ExPR is set up, workers can view the ExPR data in Workday.
To view ExPR as a worker:
1. Go to your profile > Pay, then go to the External Payroll Results for Worker.
The external payroll results synced from Deel are displayed in the list.
GPH user operations
This section covers the user operations related to the Global Payroll Hub (GPH) feature for the Workday GPC integration.
View payroll cycle information in Workday
After setting up the sync of GPH data and syncing data, payroll cycle information will become available in the Global Payroll Hub. Here's one way to see that information, but others may be available. For more information, visit Setup Considerations: Global Payroll Hub in the Workday Community.
To view payroll cycle information in Workday:
1. Launch the report Global Payroll Processing
.
2. Explore the payroll cycle information in the summary.
Workday GPC integration reference
List of supported business processes
Refer to the following table for information on the supported business processes for the Workday GPC integration.
Actions | Process | Supported | Notes |
---|---|---|---|
Syncing and updating Re-triggers downstream updates or recalculations between dependent processes. |
Yes | Supported for global fields, country specific fields, bank details | |
Corrections and scheduling Schedule changes to worker data with precise effective dates past or future |
Hire / rehire | Yes | |
Termination | Yes | ||
Pay company transfer | No | ||
Leave of absence (LOA) | Yes | ||
Organization transfer | Yes | ||
Cost allocations | No | ||
Profit allocation | No | ||
Rescinds Completely removes a completed business process as if it never happened. |
Hire / rehire | No | |
Termination | No | ||
Pay company transfer | No | ||
Leave of absence (LOA) | Yes | ||
Organization transfer | No | ||
Cost allocations | No | ||
Profit allocation | No | ||
Retrodating Makes adjustments to records with a backdated effective date. |
OTPs | No | |
Recurring payments | No | ||
Salary | No | ||
Correct action Edits a completed process directly without needing to rescind, if supported. |
Hire / rehire | Yes | |
Termination | Yes | ||
Pay company transfer | Yes | ||
Leave of absence (LOA) | Yes | ||
Organization transfer | Yes | ||
Cost allocations | Yes | ||
Profit allocation | Yes | ||
Cancel action Stops a pending or in-progress business process that hasn’t been completed yet. |
Hire / rehire | No | |
Termination | No | ||
Pay company transfer | No | ||
Leave of absence (LOA) | No | ||
Organization transfer | No | ||
Cost allocations | N/A | ||
Profit allocation | N/A | ||
Move workers Transfers employees between organizations. |
Yes | Initiates a termination event in Deel | |
Mass actions Updates multiple worker records at once |
Yes | ||
Put worker on leave/return from leave Updates employee status and records for leave of absence and reintegration. |
Yes | ||
Change job details Adjusts job-related info like title, manager, or location; can be scheduled. |
Yes | ||
Edit position restrictions Updates attributes of a position such as job profile, work shift, or location. |
Yes | ||
Change organization assignments Updates cost center, company, region, or supervisory org without triggering job changes. |
Yes |
Data mapping
Mapping data requires a detailed understanding of the Workday GPC data. Following is a breakdown of the data synced by the Workday GPC integration.
Plugin | Types of syncable data | Sync direction |
---|---|---|
Additional Payroll Data | - Country specific fields - Bank Details |
Inbound (into Deel) |
DCoD | - Personal information - Compensation information - Employment information - Job information - Work information |
Inbound (into Deel) |
Global Payroll Timeoff | - Approved number of timeoff days and their types (e.g. sick leave, bereavement leave, child care, etc) Note: this plugin does not sync the leave balance maintained in Workday |
Inbound (into Deel) |
Global Payroll One Time Payments | - Approved one time payments (e.g. bonuses, commissions, etc) | Inbound (into Deel) |
Global Payroll Recurring Payments | - Approved recurring pay items | Inbound (into Deel) |
External Payroll Documents | - Payslips - Tax documents |
Outbound (out of Deel) |
External Payroll Results | - Earnings and deductions | Outbound (out of Deel) |
Global Payroll Processing Hub | - Payroll cycle information |
For a complete list of fields, see the following document:
We recommend working together with your Deel integration specialist to ensure that the mapping is correct.
URL breakdown
After you register a new API client for integrations, you're presented with the Workday REST API Endpoint URL.
You can use that URL to retrieve information you will need to connect the Workday integration later on.
URL: https://server.myworkday.com/ccx/api/v1/deeltechdocs
└────────────┬────────────┘ └─────┬─────┘
Base URL Tenant
In this example, the following is correct:
- Base URL:
https://server.myworkday.com
- Tenant:
deeltechdocs
(what comes afterv1/
in the path)
Permission reference by feature
Following is a list of permissions and scopes organized by feature. This will help you determine which permissions are required for each feature.
Security permissions reference
Security permissions are defined when creating security groups. As you set up additional features, you'll need to add the required security permissions to the existing security group.
Section | Permission | DCoD | APD | ExPD | ExPR | GPH |
---|---|---|---|---|---|---|
Domain Security Policies permitting Modify access | Integration Build | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Integration Debug | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Integration Event | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Modify access | Manage: Data Changes On Demand | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Reports: Data Changes On Demand Results | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Set Up: Payroll - Pay Group Specific | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Modify access | View: Global Payroll Authorizations | ✅ | ✅ | ❌ | ❌ | ✅ |
Domain Security Policies permitting Modify access | Worker Data: Payroll Interface | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Modify access | View: Maintain Payroll Interface | ❌ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Modify access | Set Up: Payroll | ❌ | ❌ | ✅ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Worker Data: Payroll Interface (External Payroll Documents) | ❌ | ❌ | ✅ | ❌ | ❌ |
Domain Security Policies permitting Modify access | Manage: Global Payroll Processing | ❌ | ❌ | ❌ | ❌ | ✅ |
Domain Security Policies permitting View access | View: Global Payroll Hub | ❌ | ❌ | ❌ | ❌ | ✅ |
Domain Security Policies permitting View access | Set Up: Payroll Interface (Update Pay Period Status) | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting View access | Worker Data: Current Staffing Information | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting View access | Worker Data: Public Worker Reports | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting View access | Worker Data: Staffing | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Integration Build | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Integration Debug | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Integration Event | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Put access | Manage: Data Changes On Demand | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Payroll Interface | ❌ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Put access | Reports: Data Changes On Demand Results | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Reports: Public Profile | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Put access | Worker Data: Payroll Interface | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Put access | Set Up: Payroll Interface | ✅ | ❌ | ✅ | ✅ | ❌ |
Domain Security Policies permitting Put access | Set Up: Payroll | ❌ | ❌ | ✅ | ❌ | ❌ |
Domain Security Policies permitting Put access | Worker Data: Payroll Interface (External Payroll Documents) | ❌ | ❌ | ✅ | ❌ | ❌ |
Domain Security Policies permitting Get access | Set Up: Payroll Interface (Update Pay Period Status) | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Get access | Worker Data: Current Staffing Information | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Get access | Worker Data: Public Worker Reports | ✅ | ❌ | ❌ | ❌ | ❌ |
Domain Security Policies permitting Get access | Worker Data: Staffing | ✅ | ❌ | ❌ | ❌ | ❌ |
Scopes reference
Scopes are defined when registering API clients. As you set up additional features, you'll need to add the required scopes to the existing API client.
Scope | DCoD | APD | ExPD | ExPR | GPH |
---|---|---|---|---|---|
Contact Information |
✅ | ❌ | ✅ | ✅ | ❌ |
Global Payroll Connect |
✅ | ✅ | ✅ | ✅ | ✅ |
Integration |
✅ | ❌ | ❌ | ❌ | ❌ |
Payroll Interface |
✅ | ❌ | ✅ | ✅ | ❌ |
Staffing |
✅ | ✅ | ✅ | ✅ | ✅ |
System |
✅ | ❌ | ✅ | ✅ | ❌ |
Tenant Non-Config |
✅ | ❌ | ✅ | ✅ | ❌ |
Support
If you're having issues with the integration, you can contact our support team using one of the available channels.