Service Directory > v32.1 > Payroll > Get_Single_Legal_Entities
 

Operation: Get_Single_Legal_Entities

This web service retrieves Single Legal Entity company relationships. If the domains for this task change, also change the domains of Secure Method Definition, Single Legal Entity@get Single Legal Entity References for Request Criteria(SS)*P*S[rsmb]+PA / Process: Tax Filing/W-2s (Run) - USA (Secure Results by Domain), 5236$3343.


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

Get Single Legal Entities Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Single_Legal_Entity_Request_References  [0..1]  Single Legal Entity Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Single_Legal_Entity_Response_Group  [0..1]  Single Legal Entity Response Group   
top
 

Response Element: Get_Single_Legal_Entities_Response

Get Single Legal Entities Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Single_Legal_Entity_Request_References  [0..1]  Single Legal Entity Request References   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Single_Legal_Entity_Response_Group  [0..1]  Single Legal Entity Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Single_Legal_Entity_Response_Data  [0..1]  Single Legal Entity Response Data   
top
 

Single_Legal_Entity_Request_References

part of: Get_Single_Legal_Entities_Request, Get_Single_Legal_Entities_Response
Single Legal Entity Request References
 
Parameter name Type/Value Cardinality Description Validations
Single_Legal_Entity_Reference  Single_Legal_EntityObject  [0..*]  Single Legal Entity Reference   
top
 

Single_Legal_EntityObject

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

Single_Legal_EntityObjectID

part of: Single_Legal_EntityObject
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_Single_Legal_Entities_Request, Get_Single_Legal_Entities_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
 

Single_Legal_Entity_Response_Group

part of: Get_Single_Legal_Entities_Request, Get_Single_Legal_Entities_Response
Single Legal Entity Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Single_Legal_Entity_Response_Data

part of: Get_Single_Legal_Entities_Response
Single Legal Entity Response Data
 
Parameter name Type/Value Cardinality Description Validations
Single_Legal_Entity  Single_Legal_Entity  [0..*]  Single Legal Entity   
top
 

Single_Legal_Entity

part of: Single_Legal_Entity_Response_Data
Single Legal Entity
 
Parameter name Type/Value Cardinality Description Validations
Single_Legal_Entity_Reference  Single_Legal_EntityObject  [0..1]  Single Legal Entity Reference   
Single_Legal_Entity_Data  Single_Legal_Entity_Data  [0..1]  Single Legal Entity Data 
Validation Description
The Inactive Tax Year must be after the Reporting Tax Year. ([Tax Year] / [Company]).   
All related companies must have a Tax ID in common with any of the Legal Entity's Tax IDs.   
Company Relationship Reporting Tax Year must be starting 2014 or later.   
Companies already in another Single Legal Entity relationship in the period.   
Managing Company cannot also be a Related Company.   
The Withholding Order Type selected is not applicable for the Company.   
 
top
 

Single_Legal_Entity_Data

part of: Single_Legal_Entity
Single Legal Entity Data
 
Parameter name Type/Value Cardinality Description Validations
@Federal_Tax_ID  string  [1..1]  Federal Tax ID   
@Single_Legal_Entity_Type  string  [1..1]  Single Legal Entity Type Reference   
@Financial_Tax_Reporting  string  [1..1]  Financial Tax Reporting   
@Combined_Financial_YE_for_all_companies  string  [1..1]  Combined Financial YE for all companies   
Reporting_Tax_Year_Reference  Calendar_YearObject  [1..1]  Reporting Tax Year Reference   
Inactive_as-of_Tax_Year_Reference  Calendar_YearObject  [0..1]  Inactive as-of Tax Year Reference   
Legal_Entity_Reference  CompanyObject  [1..1]  Legal Entity Reference   
Related_Companies_Reference  CompanyObject  [1..*]  Related Companies Reference   
Withholding_Order_Type_Reference  Withholding_Order_TypeObject  [0..*]  Withholding Order Type Reference   
Periodic_Combined_Tax_Filing  boolean  [0..1]  Periodic Combined Tax Filing   
Quarterly_Separate_Tax_Filing  boolean  [0..1]  Quarterly Separate Tax Filing   
Combined_ACA_Reporting  boolean  [0..1]  Combined ACA reporting for all companies   
Validation Description
The Inactive Tax Year must be after the Reporting Tax Year. ([Tax Year] / [Company]).   
All related companies must have a Tax ID in common with any of the Legal Entity's Tax IDs.   
Company Relationship Reporting Tax Year must be starting 2014 or later.   
Companies already in another Single Legal Entity relationship in the period.   
Managing Company cannot also be a Related Company.   
The Withholding Order Type selected is not applicable for the Company.   
top
 

Calendar_YearObject

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

Calendar_YearObjectID

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

Single_Legal_EntityReferenceEnumeration

part of: Single_Legal_EntityObjectID
Base Type
string
top
 

Calendar_YearReferenceEnumeration

part of: Calendar_YearObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Withholding_Order_TypeReferenceEnumeration

part of: Withholding_Order_TypeObjectID
Base Type
string
top