Service Directory > v32.1 > Payroll > Put_Successor_Employer
 

Operation: Put_Successor_Employer

This public web service operation is designed to add/update Successor Employer relationships.


@ - 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: Put_Successor_Employer_Request

Put Successor Employer Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
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
 

Response Element: Put_Successor_Employer_Response

Put Successor Employer Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Successor_Employer_Reference  Successor_EmployerObject  [0..1]  Successor Employer Reference   
top
 

Successor_EmployerObject

part of: Put_Successor_Employer_Request, Put_Successor_Employer_Response
 
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
 

Successor_Employer_Data

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