Service Directory > v31.2 > Payroll > Get_Successor_Employers
 

Operation: Get_Successor_Employers

This public web service operation is designed to retrieve Successor Employer relationships. If an effective date is provided, it will retrieve Successor Employer relationships that are active as of the effective date. Otherwise, all Successor Employer relationships will be retrieved.


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

Get Successor Employers Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Successor_Employer_Request_References  [0..1]  Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Successor_Employer_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Successor_Employers_Response

Get Successor Employers Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Successor_Employer_Request_References  [0..1]  Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Successor_Employer_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Successor_Employer_Response_Data  [0..1]  Response Data   
top
 

Successor_Employer_Request_References

part of: Get_Successor_Employers_Request, Get_Successor_Employers_Response
Successor Employer Request References
 
Parameter name Type/Value Cardinality Description Validations
Successor_Employer_Reference  Successor_EmployerObject  [1..*]  Successor Employer Reference   
top
 

Successor_EmployerObject

part of: Successor_Employer_Request_References, Successor_Employer
 
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  Successor_EmployerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Successor_EmployerObjectID

part of: Successor_EmployerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Intercompany_Relationship_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_Successor_Employers_Request, Get_Successor_Employers_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
 

Successor_Employer_Response_Group

part of: Get_Successor_Employers_Request, Get_Successor_Employers_Response
Successor Employer Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Successor_Employer_Response_Data

part of: Get_Successor_Employers_Response
Successor Employer Response Data
 
Parameter name Type/Value Cardinality Description Validations
Successor_Employer  Successor_Employer  [0..*]  Successor Employer   
top
 

Successor_Employer

part of: Successor_Employer_Response_Data
Successor Employer
 
Parameter name Type/Value Cardinality Description Validations
Successor_Employer_Reference  Successor_EmployerObject  [0..1]  Successor Employer Reference   
Successor_Employer_Data  Successor_Employer_Data  [0..1]  Successor Employer Data 
Validation Description
The Payroll Processing Begin Date must be on or after the Acquisition or Merger Date.   
The Predecessor Company is already defined as a Predecessor Company in another Payroll Intercompany Relationship.   
A company defined as a Successor Company cannot be a Predecessor Company in the same relationship.   
The Withholding Order Type selected is not applicable for the Company.   
All predecessor companies must have a Tax ID in common with any of the successor employer's Tax IDs.   
A payroll has already been run after the Payroll Processing Begin Date for this Successor Company, this relationship cannot be created or modified after this date.   
Company Relationship Type must be one of the Successor Employer Types   
Tax Authorities not Recognizing Predecessor Payments Reference is not valid for entered Successor Employer Type   
 
top
 

Successor_Employer_Data

part of: Successor_Employer
Successor Employer Data
 
Parameter name Type/Value Cardinality Description Validations
@ID  string  [1..1]  ID   
@Federal_Tax_ID  string  [1..1]  Federal Tax ID   
Successor_Employer_Type_Reference  Company_Relationship_TypeObject  [1..1]  Successor Employer Type Reference   
Acquisition_or_Merger_Date  date  [1..1]  Acquisition or Merger Date   
Payroll_Processing_Begin_Date  date  [1..1]  Payroll Processing Begin Date   
Successor_Company_Reference  CompanyObject  [1..1]  Successor Company Reference   
Predecessor_Company_Reference  CompanyObject  [1..*]  Predecessor Company Reference   
Withholding_Order_Type_Reference  Withholding_Order_TypeObject  [0..*]  Withholding Order Type Reference   
Tax_Authorities_not_Recognizing_Predecessor_Payments_Reference  Payroll_Tax_AuthorityObject  [0..*]  Tax Authorities not Recognizing Predecessor Payments Reference   
Validation Description
The Payroll Processing Begin Date must be on or after the Acquisition or Merger Date.   
The Predecessor Company is already defined as a Predecessor Company in another Payroll Intercompany Relationship.   
A company defined as a Successor Company cannot be a Predecessor Company in the same relationship.   
The Withholding Order Type selected is not applicable for the Company.   
All predecessor companies must have a Tax ID in common with any of the successor employer's Tax IDs.   
A payroll has already been run after the Payroll Processing Begin Date for this Successor Company, this relationship cannot be created or modified after this date.   
Company Relationship Type must be one of the Successor Employer Types   
Tax Authorities not Recognizing Predecessor Payments Reference is not valid for entered Successor Employer Type   
top
 

Company_Relationship_TypeObject

part of: Successor_Employer_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  Company_Relationship_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Company_Relationship_TypeObjectID

part of: Company_Relationship_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Relationship_Type_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
 

CompanyObject

part of: Successor_Employer_Data, Successor_Employer_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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, 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
 

Withholding_Order_TypeObject

part of: Successor_Employer_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  Withholding_Order_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Withholding_Order_TypeObjectID

part of: Withholding_Order_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Withholding_Order_Type_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
 

Payroll_Tax_AuthorityObject

part of: Successor_Employer_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  Payroll_Tax_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Tax_AuthorityObjectID

part of: Payroll_Tax_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Federal_Authority_Tax_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_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
 

Successor_EmployerReferenceEnumeration

part of: Successor_EmployerObjectID
Base Type
string
top
 

Company_Relationship_TypeReferenceEnumeration

part of: Company_Relationship_TypeObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Withholding_Order_TypeReferenceEnumeration

part of: Withholding_Order_TypeObjectID
Base Type
string
top
 

Payroll_Tax_AuthorityReferenceEnumeration

part of: Payroll_Tax_AuthorityObjectID
Base Type
string
top