Service Directory > v32.1 > Payroll > Get_Payroll_Payee_FUTAs
 

Operation: Get_Payroll_Payee_FUTAs

This web service operation is designed to get worker FUTA tax election data from either the Reference ID or the Worker Reference/Company Reference/Effective Date.


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

The main FUTA Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_FUTA_Request_References  [0..1]  Element to hold all Payroll Payee Request References   
Request_Criteria [Choice]   Payroll_Payee_FUTA_Request_Criteria  [0..1]  Element to hold all criteria used to select which FUTAs to return   
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_Group  Payroll_Payee_FUTA_Response_Group  [0..1]  Element to hold all information about the Payroll Payee FUTA Response Group   
top
 

Response Element: Get_Payroll_Payee_FUTAs_Response

Get Payroll Payee FUTAs Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_FUTA_Request_References  [0..1]  All FUTAs to get from their References   
Request_Criteria  Payroll_Payee_FUTA_Request_Criteria  [0..1]  All criteria used to specify which FUTA(s) to get   
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_Group  Payroll_Payee_FUTA_Response_Group  [0..1]  Specifies how to group the FUTAs that are returned   
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  Payroll_Payee_FUTA_Response_Data  [0..1]  Information to show for each FUTA returned   
top
 

Payroll_Payee_FUTA_Request_References

part of: Get_Payroll_Payee_FUTAs_Request, Get_Payroll_Payee_FUTAs_Response
Element to hold all Payroll Payee Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_FUTA_Reference  Payroll_Payee_FUTAObject  [1..*]  All Payroll Payee FUTAs from the references given   
top
 

Payroll_Payee_FUTAObject

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

Payroll_Payee_FUTAObjectID

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

Payroll_Payee_FUTA_Request_Criteria

part of: Get_Payroll_Payee_FUTAs_Request, Get_Payroll_Payee_FUTAs_Response
Element to hold all criteria used to select which FUTAs to return
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  a) If no Worker, it would return data for ALL workers for the specified company. b) Or they could do a multi on worker and get data for multiple workers at once.   
Company_Reference  CompanyObject  [0..1]  If specified, only FUTA Tax Elections for this Company will be returned. If not specified, elections for each Company (that exists) will be returned.   
Effective_Date  date  [0..1]  Effective Date of theFUTA Tax Election. The Tax Election that is in Effect as of the Effective As Of (for specified Company if entered, else all Companies) will be returned. If no Effective As Of date specified, all tax elections will be returned.   
top
 

WorkerObject

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

WorkerObjectID

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

CompanyObject

part of: Payroll_Payee_FUTA_Data, Payroll_Payee_FUTA_Request_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  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
 

Response_Filter

part of: Get_Payroll_Payee_FUTAs_Request, Get_Payroll_Payee_FUTAs_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
 

Payroll_Payee_FUTA_Response_Group

part of: Get_Payroll_Payee_FUTAs_Request, Get_Payroll_Payee_FUTAs_Response
Element to hold all information about the Payroll Payee FUTA Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

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

Payroll_Payee_FUTA_Response_Data

part of: Get_Payroll_Payee_FUTAs_Response
Element to hold all data to Respond with about the Payroll Payee FUTAs
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_FUTA  Payroll_Payee_FUTA  [0..*]  Element to hold all information about a Payroll Payee FUTA   
top
 

Payroll_Payee_FUTA

part of: Payroll_Payee_FUTA_Response_Data
Element to hold all information about a Payroll Payee FUTA
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_FUTA_Reference  Payroll_Payee_FUTAObject  [0..1]  "This" instance of the FUTA record returned   
Payroll_Payee_FUTA_Data  Payroll_Payee_FUTA_Data  [0..1]  Payroll Payee FUTA Data 
Validation Description
The Company specified is not valid for the Worker.   
 
top
 

Payroll_Payee_FUTA_Data

part of: Payroll_Payee_FUTA
Payroll Payee FUTA Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker for this FUTA Record   
Company_Reference  CompanyObject  [1..1]  Company for this FUTA Record.   
Effective_As_Of  date  [1..1]  Effective Date for this FUTA Record   
Exempt_Indicator  boolean  [0..1]  Whether exempt or not.   
Validation Description
The Company specified is not valid for the Worker.   
top
 

Payroll_Payee_FUTAReferenceEnumeration

part of: Payroll_Payee_FUTAObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top