Service Directory > v31.2 > Payroll_Interface > Get_External_Pay_Groups
 

Operation: Get_External_Pay_Groups

This operation retrieves data related to an External Pay Group (e.g. Pay Group expected to have Payroll processed on an external non-Workday system).


@ - 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_External_Pay_Groups_Request

Request element used to find and get External Pay Groups and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  External_Pay_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of External Pay Group and its associated data.   
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. 
 
top
 

Response Element: Get_External_Pay_Groups_Response

Response element containing instances of External Pay Group and each of its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  External_Pay_Group_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of External Pay Group and its associated data.   
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_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  External_Pay_Group_Response_Data  [0..1]  Contains each External Pay Group based on the Request Criteria. The data returned is the current information as of the dates in the response filter.   
top
 

External_Pay_Group_Request_References

part of: Get_External_Pay_Groups_Request, Get_External_Pay_Groups_Response
Utilize the Request References element to retrieve a specific instance(s) of External Pay Group and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Group_Reference  Pay_GroupObject  [1..*]  Unique identifier used to reference an External Pay Group (e.g. a Pay Group marked as "Used in Payroll Interface")   
top
 

Pay_GroupObject

part of: External_Pay_Group_Request_References, External_Pay_Group, 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  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
 

Response_Filter

part of: Get_External_Pay_Groups_Request, Get_External_Pay_Groups_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_External_Pay_Groups_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
 

External_Pay_Group_Response_Data

part of: Get_External_Pay_Groups_Response
Contains each External Pay Group based on the Request Criteria. The data returned is the current information as of the dates in the response filter.
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Group  External_Pay_Group  [0..*]  Encapsulating element representing an External Pay Group and its associated data.   
top
 

External_Pay_Group

part of: External_Pay_Group_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
 

PeriodObject

part of: Period_Content_Data, External_Pay_Group, External_Pay_Group, External_Pay_Group, 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  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
 

FrequencyObject

part of: External_Pay_Group, 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  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: 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
 
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: External_Pay_Component
 
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
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

Run_CategoryReferenceEnumeration

part of: Run_CategoryObjectID
Base Type
string
top
 

Period_ScheduleReferenceEnumeration

part of: Period_ScheduleObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Pay_ComponentReferenceEnumeration

part of: Pay_ComponentObjectID
Base Type
string
top
 

Group_InterfaceReferenceEnumeration

part of: Group_InterfaceObjectID
Base Type
string
top
 

Benefit_Plan_Year_DefinitionReferenceEnumeration

part of: Benefit_Plan_Year_DefinitionObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top