Service Directory > v31.2 > Payroll_Interface > Get_Payees
 

Operation: Get_Payees

This operation retrieves data related to Payees (e.g. Employees) that belong to an External Pay Group (e.g. Pay Group expected to have Payroll processed on an external non-Workday system). Data returned includes Employment, Personal, Earnings and Deductions.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Payees_Request

Request element used to find and get Payees and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payee_Request_Criteria  [0..1]  Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Payee (e.g. Employee). 
Validation Description
Pay Period, if defined, must be valid for Pay Group.  Pay Period, if defined, must be valid for Pay Group. 
Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference.  Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference. 
Include Terminated Payees is only applicable when specifying a Pay Group Reference.   
Include Transfers Out Of Pay Group is only applicable when specifying a Pay Group Reference.   
Exclude Payee Reference is only applicable when specifying a Pay Group Reference.   
Either Pay Group Reference, Payee Reference, or Universal ID Reference is required.   
 
Response_Filter  Payee_Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page Number cannot be zero. 
 
Response_Date_Range_Filter  Response_Date_Range_Filter  [0..1]  In conjunction with the "Response_Filter" element, the "Response_Date_Range_Filter" element contains common WWS information that allows you control the transactional and/or date range data that you will be provided.   
Response_Group  Payee_Response_Group  [0..1]  The response groups allows for the amount of data contained within the response to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then ONLY the payee references will be returned. If no response group is provided AND the Page and Count parameters within the Response Filter element are also omitted, then ALL of the payee references will be returned in your response (no paging is performed).   
Validation Description
Begin Effective Date (within the Response_Date_Range_Filter element) must be equal to or less than As Of Effective Date (within the Response_Filter element).  Begin Effective Date (within the Response_Date_Range_Filter element) must be equal to or less than As Of Effective Date (within the Response_Filter element). 
Begin Entry DateTime (within the Response_Date_Range_Filter element) must be equal to or less than As Of Entry DateTime (within the Response_Filter element).  Begin Entry DateTime (within the Response_Date_Range_Filter element) must be equal to or less than As Of Entry DateTime (within the Response_Filter element). 
top
 

Response Element: Get_Payees_Response

Response element containing instances of Payees and each of his/her associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payee_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned population to those Payees that meet ALL of the criteria. 
Validation Description
Pay Period, if defined, must be valid for Pay Group.  Pay Period, if defined, must be valid for Pay Group. 
Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference.  Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference. 
Include Terminated Payees is only applicable when specifying a Pay Group Reference.   
Include Transfers Out Of Pay Group is only applicable when specifying a Pay Group Reference.   
Exclude Payee Reference is only applicable when specifying a Pay Group Reference.   
Either Pay Group Reference, Payee Reference, or Universal ID Reference is required.   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Date_Range_Filter  Response_Date_Range_Filter  [0..1]  In conjunction with the "Response_Filter" element, the "Response_Date_Range_Filter" element contains common WWS information that allows you control the transactional and/or date range data that you will be provided.   
Response_Group  Payee_Response_Group  [0..1]  The response groups allows for the amount of data contained within the response to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then ONLY the payee references will be returned. If no response group is provided AND the Page and Count parameters within the Response Filter element are also omitted, then ALL of the payee references will be returned in your response (no paging is performed).   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Payees_Response_Data  [0..1]  Contains each Payee based on the Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the Payee.   
top
 

Payee_Request_Criteria

part of: Get_Payees_Request, Get_Payees_Response
Utilize the Request Criteria element to filter the returned population to those Payees that meet ALL of the criteria.
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference  Pay_GroupObject  [0..1]  Unique identifier used to reference an External Pay Group (e.g. a Pay Group marked as "Used in Payroll Interface")   
Pay_Period_Reference  PeriodObject  [0..1]  Unique identifier used to reference a Pay Period.   
Return_Benefits_as_of_Payment_Date  boolean  [0..1]  Boolean attribute to signify whether the response data for Benefit Plan Data (within Deduction Data) should include Benefit Elections as of the Period Payment Date instead of the Period End Date. 
Validation Description
Return Benefits Deductions as of Payment Date is only valid when a Period Reference is specified.  Return Benefits Deductions as of Payment Date is only valid when a Period Reference is specified. 
 
Include_Terminated_Payees  boolean  [0..1]  Boolean attribute to signify whether to include Employees who are currently Terminated, but were members of the Pay Group as of the Termination Date.   
Include_Transfers_Out_Of_Pay_Group  Include_Transfers_Out_Of_Pay_Group  [0..1]  Element to signify whether to include Employees who have transfered out of the Pay Group since the last time the web service operation was submitted.   
Payee_Reference  EmployeeObject  [0..*]  Unique identifier used to reference an Payee (e.g. Employee).   
Exclude_Payee_Reference  EmployeeObject  [0..*]  Unique identifier used to exclude Payee(s) from the extract (e.g. Employee).   
Transaction_Log_Criteria_Data  Transaction_Log_Criteria  [0..*]  Searches the transaction log for business processes and event lites to find specific events that occurred during a period of time. 
Validation Description
Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration. 
 
Field_And_Parameter_Criteria_Data  Field_And_Parameter_Criteria_Data  [0..1]  Field Result Request Criteria   
Include_Costing_Allocation_Data  boolean  [0..1]  Boolean attribute to signify whether to include Costing Allocation data for the employee.   
Use_Pay_Period_for_Time_Off_Period_Start_Date_and_End_Date  boolean  [0..1]  Used to indicate that the Pay Period Start and End dates should be used for Time Off entry selection.   
As_of_Effective_Date_for_Management_Chain  date  [0..1]  The "as of the effective date" for the management chain, if different than the response filter "as of effective date." This can be useful when a manager change is not due a staffing change in the managed worker's history.   
Use_Pay_Period_for_Payroll_Input_Start_and_End_Date  boolean  [0..1]  When enabled, this option will use the respective Pay Period for Payroll Input Start and End Dates. This replaces the current behavior of using the Begin Entry Moment specified in the Response Date Range Filter to derive the period.   
Include_Purged_Payees  boolean  [0..1]  Boolean attribute to signify whether to include Employees who are Purged   
Universal_ID_Reference  Universal_IdentifierObject  [0..*]  The universal identifier of the payees. All payee roles will be returned for a given universal identifier.   
Validation Description
Pay Period, if defined, must be valid for Pay Group.  Pay Period, if defined, must be valid for Pay Group. 
Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference.  Return Benefits Deductions as of Payment Date is only applicable when specifying a Pay Period Reference. 
Include Terminated Payees is only applicable when specifying a Pay Group Reference.   
Include Transfers Out Of Pay Group is only applicable when specifying a Pay Group Reference.   
Exclude Payee Reference is only applicable when specifying a Pay Group Reference.   
Either Pay Group Reference, Payee Reference, or Universal ID Reference is required.   
top
 

Pay_GroupObject

part of: Payee_Request_Criteria, External_Pay_Group, External_Pay_Component_Data, Payee_Pay_Group_Earnings_and_Deductions_Data, Payee_Earnings_and_Deductions_Summary_Data, Pay_Group_Assignment_Correct_or_Rescinded_Organization_Data, Pay_Group_Assignment_Correct_or_Rescinded_Organization_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Pay_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_GroupObjectID

part of: Pay_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

PeriodObject

part of: Payee_Request_Criteria, Period_Content_Data, External_Pay_Group, External_Pay_Group, External_Pay_Group, External_Pay_Group_Data, Include_Transfers_Out_Of_Pay_Group
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  PeriodObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

PeriodObjectID

part of: PeriodObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Period_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Include_Transfers_Out_Of_Pay_Group

part of: Payee_Request_Criteria
Element to signify whether to include Employees who have transfered out of the Pay Group since the last time the web service operation was submitted.
 
Parameter name Type/Value Cardinality Description Validations
Prior_Pay_Period_Reference  PeriodObject  [1..1]  Pay Period Reference representing the last time the web service operation was requested. This period will be used to determine the members of the Pay Group as of the period. For those that are no longer members, they will be included within the response. 
Validation Description
Period End Date for Prior Period Reference must be less than or equal to Period End Date for above Period Reference (or current moment if omitted).  Period End Date for Prior Period Reference must be less than or equal to Period End Date for above Period Reference (or current moment if omitted). 
 
Prior_As_Of_Entry_DateTime  dateTime  [0..1]  As Of Entry DateTime used within the request for the last time this operation was submitted. Used to determine the population of the Pay Group as of above Period for all data entered into the system prior to this Entry DateTime. 
Validation Description
Prior As Of Entry DateTime (within the Include_Transfers_Out_Of_Pay_Group element) must be equal to or less than As Of Entry DateTime (within the Response_Filter element).  Prior As Of Entry DateTime (within the Include_Transfers_Out_Of_Pay_Group element) must be equal to or less than As Of Entry DateTime (within the Response_Filter element). 
 
top
 

EmployeeObject

part of: Payee_Request_Criteria, Payee_Request_Criteria, Payee
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  EmployeeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

EmployeeObjectID

part of: EmployeeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Transaction_Log_Criteria

part of: Payee_Request_Criteria
Searches the transaction log for business processes and event lites to find specific events that occurred during a period of time.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Date_Range_Data  Effective_And_Updated_DateTime_Data  [0..1]  Encapsulating element containing Effective and Updated DateTime data. 
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
 
Transaction_Type_References [Choice]   Transaction_Type_References  [0..1]  If specified, this search criteria will return those Transaction Log Entries which match the Transaction Types specified here.   
Subscriber_Reference [Choice]   SubscriberObject  [0..1]  If specified, this search criterium will return those Transaction Log Entries that match the Transaction Types defined in the subscription of the subscriber.   
Validation Description
Subscriber Reference must have an enabled Transaction Log Service configuration.  Subscriber Reference must have an enabled Transaction Log Service configuration. 
top
 

Effective_And_Updated_DateTime_Data

part of: Transaction_Log_Criteria
Element contains effective and updated date/time data.
 
Parameter name Type/Value Cardinality Description Validations
Updated_From  dateTime  [0..1]  Defines the earliest moment (e.g. datetime) data was entered into the Workday system.   
Updated_Through  dateTime  [0..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system.   
Effective_From  dateTime  [0..1]  Defines the earliest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Effective_Through  dateTime  [0..1]  Defines the latest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
top
 

Transaction_Type_References

part of: Transaction_Log_Criteria
Wrapper element containing Transaction Types.
 
Parameter name Type/Value Cardinality Description Validations
Transaction_Type_Reference  Transaction_Log_TypeObject  [0..*]  If specified, this search criterium will return those Transaction Log Entries with Transaction Types that match the search criterium.   
top
 

Transaction_Log_TypeObject

part of: Transaction_Log_Data, Transaction_Type_References
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Transaction_Log_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Transaction_Log_TypeObjectID

part of: Transaction_Log_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Process_Type, Event_Lite_Type_ID, Reorganization_Activity_Type  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

SubscriberObject

part of: Transaction_Log_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  SubscriberObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SubscriberObjectID

part of: SubscriberObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_Service_Name, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Field_And_Parameter_Criteria_Data

part of: Payee_Request_Criteria
Field Result Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Provider_Reference  External_Field_and_Parameter_Initialization_ProviderObject  [1..*]  Field And Parameter Initialization Provider Reference   
top
 

External_Field_and_Parameter_Initialization_ProviderObject

part of: Field_And_Parameter_Criteria_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  External_Field_and_Parameter_Initialization_ProviderObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

External_Field_and_Parameter_Initialization_ProviderObjectID

part of: External_Field_and_Parameter_Initialization_ProviderObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Universal_IdentifierObject

part of: Payee_Request_Criteria, Payee
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Universal_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Universal_IdentifierObjectID

part of: Universal_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Universal_Identifier_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payee_Response_Filter

part of: Get_Payees_Request
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page Number cannot be zero. 
top
 

Response_Date_Range_Filter

part of: Get_Payees_Request, Get_Payees_Response
In conjunction with the "Response_Filter" element, the "Response_Date_Range_Filter" element contains common WWS information that allows you control the transactional and/or date range data that you will be provided.
 
Parameter name Type/Value Cardinality Description Validations
Begin_Effective_Date  date  [0..1]  For Date Range type of data (e.g. historical entries between two dates), Begin Effective Date defines the farthest "From" date. Note: most response data is considered snapshot data (e.g. as of a point in time); therefore, only certain types of response data will be affected by this date.   
Begin_Entry_DateTime  dateTime  [0..1]  For Transactional type of data (e.g. entries as of a date but entered into Workday after a specific moment), Begin Entry Date Time defines the moment in time in which to look for transactions following. Note: most response data is considered snapshot data (e.g. as of a point in time); therefore, only certain types of response data will be affected by this date.   
top
 

Payee_Response_Group

part of: Get_Payees_Request, Get_Payees_Response
The response groups allows for the amount of data contained within the response to be tailored to only included elements that the user is looking for. If no response group is provided in the request, then ONLY the payee references will be returned. If no response group is provided AND the Page and Count parameters within the Response Filter element are also omitted, then ALL of the payee references will be returned in your response (no paging is performed).
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates if the Reference element for the Payee (e.g. Employee) is included in the response.   
Include_Contracts_for_Terminated_Workers  boolean  [0..1]  Include Contracts for Terminated Workers   
Include_External_Pay_Group_Data  boolean  [0..1]  Indicates if the External Pay Group Data element is included in the response.   
Include_Period_Content_Data  boolean  [0..1]  Indicates if the Period Content Data element is included in the response.   
Include_Payee_Personal_Information  boolean  [0..1]  Indicates if the Personal Data element is included in the response.   
Exclude_Payee_Detailed_Identification_Information  boolean  [0..1]  Excludes the government id, visa id, passport id, license id and custom id from the Personal Data element response. This can only be selected when the Include Personal Data boolean is also selected.   
Include_Payee_Additional_Job_Data  boolean  [0..1]  Indicates if additional job information is included in the response.   
Include_Payee_Employment_Information  boolean  [0..1]  Indicates if the Employment Data element is included in the response.   
Include_Payee_Compensation_Information  boolean  [0..1]  Indicates if the Compensation Data element is included in the response.   
Exclude_Payee_Detailed_Compensation_Information  boolean  [0..1]  Excludes all information from the Compensation data other than the salary and hourly data , effective date and reason. This can only be selected when the Include Compensation Data boolean is also selected.   
Include_Payee_Compensation_Prorated_Amount  boolean  [0..1]  Includes a prorated amount the earnings summary section. Proration includes Full Time Equivalent, scheduled weekly hours, and any possible yearly modifiers.   
Include_Payee_Compensation_One_Time_Payment_Rescind_and_Corrects  boolean  [0..1]  Includes One Time Payment information by Earning for payments which have been Rescinded or Corrected   
Include_Payee_Organizations_Information  boolean  [0..1]  Indicates if the Organization Data element is included in the response.   
Include_Pay_Group_Assignment_Correct_and_Rescind_Information  boolean  [0..1]  Show or Hide extra information for corrections or rescinds for Pay Group Assignment   
Exclude_Payee_Organization_Support_Role_Data  boolean  [0..1]  Excludes the supporting role information from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Location_Hierarchies  boolean  [0..1]  Excludes the location hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Cost_Centers  boolean  [0..1]  Excludes the cost centers from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Cost_Center_Hierarchies  boolean  [0..1]  Excludes the cost center hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Companies  boolean  [0..1]  Excludes the company organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Company_Hierarchies  boolean  [0..1]  Excludes the company hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Matrix_Organizations  boolean  [0..1]  Excludes the matrix organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Pay_Groups  boolean  [0..1]  Excludes the pay groups from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Regions  boolean  [0..1]  Excludes the regions from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Region_Hierarchies  boolean  [0..1]  Excludes the region hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Supervisory_Organizations  boolean  [0..1]  Excludes the supervisory organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Teams  boolean  [0..1]  Excludes the teams from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Custom_Organizations  boolean  [0..1]  Excludes the custom organizations from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Include_Management_Chain_Data  boolean  [0..1]  Indicates if the Management Chain Data element is included in the response.   
Include_Multiple_Managers_in_Management_Chain_Data  boolean  [0..1]  Set to true to return multiple managers in the management chain data section. Default selection is to return a single manager.   
Include_Payment_Election_Data  boolean  [0..1]  Indicates if the Payment Election Data (e.g. Direct Deposit) element is included in the response.   
Include_Payee_Tax_Withholding_Data  boolean  [0..1]  Indicates if the Payee Tax Withholding Data element is included in the response.   
Include_Pay_Component_Compensation_Data  boolean  [0..1]  Within the Earnings/Deductions data, indicates if the Compensation Data is included in the response.   
Include_Pay_Component_Benefit_Plan_Data  boolean  [0..1]  Within the Earnings/Deductions data, indicates if the Benefit Plan Data is included in the response.   
Include_Pay_Component_Benefit_Group_Coverage_Data  boolean  [0..1]  Within the Earnings/Deductions data, indicates if the Benefit Group Coverage Data is included in the response.   
Include_Pay_Component_Time_Off_Data  boolean  [0..1]  Within the Earnings/Deductions data, indicates if the Time Off Data is included in the response.   
Include_Pay_Component_Time_Off_Adjustment_Data  boolean  [0..1]  Indicates if Time Off Adjustments are included in the response.   
Include_Pay_Component_Payroll_Input_Data  boolean  [0..1]  Within the Earnings/Deductions data, indicates if the External Payroll Input Data is included in the response.   
Include_Payee_Earnings_and_Deductions_Summary_Data  boolean  [0..1]  Indicates if the earnings and deductions summary data is included in the response.   
Include_Pay_Component_Daily_Time_Tracking_Summary_Data  boolean  [0..1]  Indicates if the Daily Calculated Time Block Data is included in the response.   
Include_Pay_Component_Period_Time_Tracking_Summary_Data  boolean  [0..1]  Indicates if the Period Calculated Time Block Data is included in the response.   
Include_Pay_Component_Time_Tracking_Correction_Data  boolean  [0..1]  Indicates if the Daily Calculated Time Correction Summary is included in the response.   
Unrounded_Time_Tracking_Calculated_Quantities  boolean  [0..1]  Set to True to leave calculated quantities unrounded at 6 decimals. Set to False to round the calculated quantities to 2 decimals.   
Include_Transaction_Log_Data  boolean  [0..1]  Indicates if the Transaction Log Data element is included in the response.   
Include_Payee_Status_Data  boolean  [0..1]  Indicates if the Worker Status Data element is included in the response.   
Include_Payee_Contract_Data  boolean  [0..1]  Indicates if the Employee Contract element is included in the response.   
Include_Payee_Collective_Agreement_Data  boolean  [0..1]  Include Collective Agreement data. This also requires Include Payee Employment Information to be true.   
Include_Payee_Probation_Period_Data  boolean  [0..1]  Include Probation Period data. This also requires Include Payee Employment Information to be true.   
Include_Extended_Employee_Contract_Details  boolean  [0..1]  Indicates if the Extended Employee Contracts Data element is included in the response.   
Include_Payee_Related_Persons  boolean  [0..1]  Include Related Person Info for the Payee.   
Include_Payee_Qualfication_Information  boolean  [0..1]  Include Payee Qualification Information. Only External Job History, Work Experience and Education information will be returned.   
Include_Costing_Allocation_Data  boolean  [0..1]  Boolean attribute to signify whether to include Costing Allocation data for the employee.   
Include_User_Account  boolean  [0..1]  Indicates that User Account Data will be included in the web service response.   
Exclude_Payee_Funds  boolean  [0..1]  Excludes the Funds from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Fund_Hierarchies  boolean  [0..1]  Excludes the Grants from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Grants  boolean  [0..1]  Excludes the Grants from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Grant_Hierarchies  boolean  [0..1]  Excludes the grant hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Business_Units  boolean  [0..1]  Excludes the Business Units from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Business_Unit_Hierarchies  boolean  [0..1]  Excludes the business unit hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Programs  boolean  [0..1]  Excludes the Programs from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Program_Hierarchies  boolean  [0..1]  Excludes the program hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Payee_Gifts  boolean  [0..1]  Excludes the Gifts from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected   
Exclude_Payee_Gift_Hierarchies  boolean  [0..1]  Excludes the gift hierarchies from the Organization Data element response. This can only be selected when the Include Organization Data boolean is also selected.   
Exclude_Pay_Component_Time_Off_Detail_Data  boolean  [0..1]  Indicates if the Time Off Detail data that includes Paid and Unpaid calculated units is included in the response.   
Include_Pay_Component_Time_Off_Entries_Detail_Data  boolean  [0..1]  Indicates if the daily Time Entries Detail data is included in the response.   
Include_Pay_Component_Time_Off_Corrected_Data  boolean  [0..1]  Indicates if the daily Time Entries retro actively added or corrected for previous pay periods are included in Time Off Corrected data response.   
Include_Payee_Compensation_FTE_Change_Date  boolean  [0..1]  Indicates that the FTE Date Change code should be applied.   
top
 

Response_Filter

part of: Get_Payees_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Payees_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Payees_Response_Data

part of: Get_Payees_Response
Contains each Payee based on the Request Criteria. The data returned is the current information as of the dates in the response filter, and does not include all historical information about the Payee.
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Group  External_Pay_Group  [0..*]  For each External Pay Group referenced in the Request Criteria, returns associated Pay Component data.   
Period_Content_Data  Period_Content_Data  [0..1]  For Pay Period referenced in the Request Criteria, returns associated data.   
Payee  Payee  [0..*]  Encapsulating element containing all Payee data.   
top
 

External_Pay_Group

part of: Payees_Response_Data
Encapsulating element representing an External Pay Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Group_Reference  Pay_GroupObject  [0..1]  External Pay Group Reference   
External_Pay_Group_Data  External_Pay_Group_Data  [0..*]  External Pay Group Data   
Frequency_Reference  FrequencyObject  [0..1]  Frequency Reference for associated Period Schedule   
Frequency_Factor  decimal (18, 6) >0   [0..1]  Frequency Factor (e.g. Annualized count) of Frequency for associated Period Schedule   
Last_Completed_Period_Reference  PeriodObject  [0..1]  A unique reference identifying the most recent Period with a status of "Complete".   
Current_Period_Reference  PeriodObject  [0..1]  A unique reference identifying the earliest Period with a status of "In Progress".   
Next_Period_Reference  PeriodObject  [0..1]  A unique reference identifying the earliest Period without a status of "In Progress" or "Complete".   
Period_Content_Data  Period_Content_Data  [0..*]  Period Content Data   
External_Pay_Component  External_Pay_Component  [0..*]  External Pay Component   
Benefits_Data  External_Pay_Group_Benefit_Plan_Year_Data  [0..1]  Encapsulating element representing data associated with benefit plan year ends.   
Last_Extract_Created_Data  Last_PI_Extract_Created_Data  [0..*]  Last Payroll Interface Extract Created   
top
 

External_Pay_Group_Data

part of: External_Pay_Group
Encapsulating element representing an basic attributes of an External Pay Group.
 
Parameter name Type/Value Cardinality Description Validations
Run_Category_Reference  Run_CategoryObject  [1..1]  A unique reference identifying a Run Category. Note: only Run Categories with the "Used in Payroll Interface" boolean checked are valid here.   
Period_Schedule_Reference  Period_ScheduleObject  [0..1]  A unique reference identifying a Period Schedule.   
Override_First_Processing_Period_Reference  PeriodObject  [0..1]  A unique reference identifying a Period to be used as beginning Period for External Pay Group. This instance overrides the earliest Period as defined within the Period Schedule.   
top
 

Run_CategoryObject

part of: External_Pay_Group_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Run_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Run_CategoryObjectID

part of: Run_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Run_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Period_ScheduleObject

part of: External_Pay_Group_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Period_ScheduleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Period_ScheduleObjectID

part of: Period_ScheduleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Period_Schedule_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

FrequencyObject

part of: Benefit_Plan_Earning_Deduction_Currency_Conversion_Details_Data, Flex_Credit_Currency_Conversion_Details_Data, External_Pay_Group, External_Pay_Component_Data, Position_Detail_Data, Position_Payroll_Interface_Detail_Data, Employee_Base_Pay_Plan_Assignment_Data, Employee_Salary_Unit_Plan_Assignment_Data, Employee_Bonus_Plan_Assignment_Data, Employee_Allowance_Plan_Assignment_Data, Employee_Allowance_Unit_Plan_Assignment_Data, Employee_Commission_Plan_Assignment_Data, Employee_Commission_Plan_Assignment_Data, Compensatable_Summary_Amount_Data, Compensatable_Summary_Amount_Annualized_In_Reporting_Currency_Data, Compensatable_Summary_Amount_Annualized_Data, Payee_Earning_Deduction_Code_Summary_Data, Compensatable_Summary_Amount_In_Target_Frequency_Data, Compensatable_Summary_Amount_Hourly_Data, Employee_Period_Salary_Plan_Assignment_Data, Employee_Calculated_Plan_Assignment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  FrequencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

FrequencyObjectID

part of: FrequencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Frequency_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Period_Content_Data

part of: Payees_Response_Data, External_Pay_Group
Summary of details for a Pay Period.
 
Parameter name Type/Value Cardinality Description Validations
Period_Reference  PeriodObject  [0..1]  Period reference   
Start_Date  date  [0..1]  Start Date   
End_Date  date  [0..1]  End Date   
Payment_Date  date  [0..1]  Payment Date   
Period_Status_Reference  Unique_IdentifierObject  [0..1]  Period Status Reference   
top
 

Unique_IdentifierObject

part of: Period_Content_Data, National_ID, Government_ID, Visa_ID, Passport_ID, Custom_ID, Leave_Status_Detail_Data, Related_Person, Payee_One_Time_Payment_Data, Leave_Requests_Corrected_Detail_Data, Collective_Agreement_Detail_Data, Employee_Probation_Period_Detail_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

External_Pay_Component

part of: External_Pay_Group
Encapsulating element representing an External Pay Component and its associated details.
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Component_Reference  Pay_ComponentObject  [0..1]  External Pay Component reference.   
External_Pay_Component_Data  External_Pay_Component_Data  [1..*]  Information on an External Pay Component.   
top
 

Pay_ComponentObject

part of: Payee_Earning_Data, Payee_Deduction_Data, External_Pay_Component, Earning_Deduction_Code_Time_Off_Data, Payee_Earning_Deduction_Code_Summary_Data, Payee_Earning_Deduction_Code_One_Time_Payment_Summary_Data, Payee_Time_Tracking_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Pay_ComponentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_ComponentObjectID

part of: Pay_ComponentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Earning_Code, Workday_Deduction_Code, Workday_Earning_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

External_Pay_Component_Data

part of: External_Pay_Component
Information on an External Pay Component.
 
Parameter name Type/Value Cardinality Description Validations
Code  string (20)   [1..1]  Identifying code for Pay Component   
Name  string  [1..1]  Pay Component Name   
Position_Based  boolean  [0..1]  Identifies if the external earning or external deduction is position based. Available beginning W15.   
Override_Frequency_Reference  FrequencyObject  [0..1]  Override Frequency Reference   
Frequency_Factor  decimal (18, 6) >0   [0..1]  Override Frequency Factor   
Tag_Reference  Group_InterfaceObject  [0..*]  Tag (e.g. Grouping) reference   
Pay_Group_Reference  Pay_GroupObject  [1..*]  External Pay Group reference   
Inbound_Reporting_Tag_Reference  Group_InterfaceObject  [0..*]  Inbound Reporting Tag (e.g. Grouping relevant for the inbound purpose) reference   
Inbound_Only  boolean  [0..1]  Indicator for outbound payroll interface process to not include codes marked as inbound only.   
External_Payroll_Code  string  [0..1]  Identifying external code for Pay Component   
top
 

Group_InterfaceObject

part of: External_Pay_Component_Data, External_Pay_Component_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Group_InterfaceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Group_InterfaceObjectID

part of: Group_InterfaceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Pay_Component_Group_Code, Workday_Pay_Component_Group_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

External_Pay_Group_Benefit_Plan_Year_Data

part of: External_Pay_Group
Encapsulating element representing data associated with benefit plan year ends.
 
Parameter name Type/Value Cardinality Description Validations
Benefit_Plan_Data  Benefit_Plan_Year_Definition_Year_End_Data  [0..*]  Encapsulating element representing a benefit plan year and its associated data.   
top
 

Benefit_Plan_Year_Definition_Year_End_Data

part of: External_Pay_Group_Benefit_Plan_Year_Data
Encapsulating element representing a benefit plan year and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Year_Definition_Reference  Benefit_Plan_Year_DefinitionObject  [0..1]  Benefit Plan Year Definition reference   
Program_End_Date  date  [0..1]  The date on which this benefit plan year ends. Benefit plan years do not necessarily align with calendar years.   
top
 

Benefit_Plan_Year_DefinitionObject

part of: Benefit_Plan_Year_Definition_Year_End_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Benefit_Plan_Year_DefinitionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Benefit_Plan_Year_DefinitionObjectID

part of: Benefit_Plan_Year_DefinitionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefit_Plan_Year_Definition_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Last_PI_Extract_Created_Data

part of: External_Pay_Group
Last Payroll Interface Extract Created
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System__Audited_Object  [1..1]  Integration System Reference.   
Date_Time  dateTime  [1..1]  Date Time stamp when Payroll Interface Extract was last created.   
top
 

Integration_System__Audited_Object

part of: Last_PI_Extract_Created_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Integration_System__Audited_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Integration_System__Audited_ObjectID

part of: Integration_System__Audited_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Integration_System_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payee

part of: Payees_Response_Data
Encapsulating element containing all Payee data.
 
Parameter name Type/Value Cardinality Description Validations
Payee_Reference  EmployeeObject  [0..1]  A unique identifier used to reference a Payee.   
Universal_Identifier_Reference  Universal_IdentifierObject  [0..1]  Universal identifier for the employee.   
Payee_Personal_Data  Personal_Information_Data  [0..1]  Wrapper element for Personal Data. 
Validation Description
The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position  The ethnicity does not exist in the specified Location Context. The Location Context is derived from the Country of the Location of the Position 
The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The religion is not valid for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The marital status does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable. 
The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  The country region of birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Native Region is only tracked in China.  Native Region is only tracked in China. 
Hukou Type is only tracked in China.  Hukou Type is only tracked in China. 
Hukou Locality is only tracked for China.  Hukou Locality is only tracked for China. 
Hukou Region is only tracked for China.  Hukou Region is only tracked for China. 
Hukou Subregion is only tracked in China.  Hukou Subregion is only tracked in China. 
The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Citizenship Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The Nationality type is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
You may only specify one ethnicity for this worker or pre-hire. This is defined by your system administrator and based on the country of the worker or pre-hire.   
Hukou Postal Code is only tracked for China.  Hukou Postal Code is only tracked for China. 
Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position  Medical exam history is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position 
Last Medical Exam Valid To Date must be after Last Medical Exam Date  Last Medical Exam Valid To Date must be after Last Medical Exam Date 
Last Medical Exam Date cannot be in the future  Last Medical Exam Date cannot be in the future 
The field Marital Status is required and must have a value if a Marital Status Date is entered.  The field Marital Status is required and must have a value if a Marital Status Date is entered. 
The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position.  The Political Affiliation does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. 
The social benefits locality data has not been activated for this location via the Maintain Localization Settings task.  The social benefits locality data has not been activated for this location via the Maintain Localization Settings task. 
The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants.  The social benefits locality does not exist in the specified Location Context. The Location Context is derived from the Country of the Location specified for the Position. Currently, the Social Benefits Locality values are ignored for Puts involving applicants since a Social Benefits Locality value is associated with workers and not applicants. 
The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Additional Nationalities is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Date of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  Gender is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Religion is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Marital Status is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  The Political Affiliation is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location.  HispaniclLatino is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location. 
The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  The field Race/Ethnicity is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position.  City of Birth is not tracked for the specified Location Context. The Location Context is derived from the Country of the Location for the Position. 
 
Payee_Job_Data  Payee_Job_Data  [0..*]  Wrapper element for the job specific Payee data   
Payee_Status_Data  Worker_Status_Detail_Data