Service Directory > v32.1 > Payroll > Get_Payroll_Payee_FICAs
 

Operation: Get_Payroll_Payee_FICAs

This operation returns FICA data for a Worker and Position.


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

Get Payroll Payee FICAs Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_Tax_Data_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Payroll_Payee_Tax_Data_Request_Criteria  [0..1]  Request Criteria 
Validation Description
Position is not valid for the Worker.   
Please provide a Worker Reference along with the Position Reference.   
 
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payroll_Payee_Tax_Data_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Payroll_Payee_FICAs_Response

Get Payroll Payee FICAs Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_Tax_Data_Request_References  [0..1]  Payroll Payee Tax Data Request References   
Request_Criteria  Payroll_Payee_Tax_Data_Request_Criteria  [0..1]  Payroll Payee Tax Data Request Criteria 
Validation Description
Position is not valid for the Worker.   
Please provide a Worker Reference along with the Position Reference.   
 
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payroll_Payee_Tax_Data_Response_Group  [0..1]  Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Payroll_Payee_Tax_Data_Response_Data  [0..1]  Response Data   
top
 

Payroll_Payee_Tax_Data_Request_References

part of: Get_Payroll_Payee_FICAs_Request, Get_Payroll_Payee_FICAs_Response
Payroll Payee Tax Data Request References element
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Data_Reference  Payroll_Payee_Tax_DataObject  [1..*]  Payroll Payee Tax Data Reference.   
top
 

Payroll_Payee_Tax_DataObject

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

Payroll_Payee_Tax_DataObjectID

part of: Payroll_Payee_Tax_DataObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payee_ARRCO-AGIRC_ID, Payee_International_Assignment_ID, Payee_Part_Time_Pension_Option_ID, Payee_URSSAF_ID, Payee_Withholding_Tax_ID, Payroll_Payee_FICA_Medicare_Reference_ID, Payroll_Payee_FICA_OASDI_Reference_ID, Payroll_Payee_FUTA_Reference_ID, Payroll_Payee_PT1_Reference_ID, Payroll_Payee_RPP_or_DPSP_Registration_Number_Reference_ID, Payroll_Payee_T1_Reference_ID, Payroll_Payee_Tax_Data_ID, Payroll_Payee_Tax_Location_Mapping_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_Tax_Data_Request_Criteria

part of: Get_Payroll_Payee_FICAs_Request, Get_Payroll_Payee_FICAs_Response
Payroll Payee Tax Data Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  Worker Reference   
Position_Reference  Position_ElementObject  [0..*]  Position Reference   
Effective_As_Of  date  [0..1]  Effective Date of the Payroll Payee Tax Data. Payroll Payee Tax Data instances with Payroll As of Date =< Effective As Of will be returned.   
Validation Description
Position is not valid for the Worker.   
Please provide a Worker Reference along with the Position Reference.   
top
 

WorkerObject

part of: Payroll_Payee_FICA_Data, Payroll_Payee_Tax_Data_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
 

Position_ElementObject

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

Position_ElementObjectID

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

part of: Get_Payroll_Payee_FICAs_Request, Get_Payroll_Payee_FICAs_Response
Payroll Payee Tax Data Response Group element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payroll_Payee_FICAs_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_Tax_Data_Response_Data

part of: Get_Payroll_Payee_FICAs_Response
Payroll Payee Tax Data Response Data element.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Data  Payroll_Payee_Tax_Data  [0..*]  Payroll Payee Tax Data.   
top
 

Payroll_Payee_Tax_Data

part of: Payroll_Payee_Tax_Data_Response_Data
Payroll Payee Tax Data element.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Data_Reference  Payroll_Payee_Tax_DataObject  [0..1]  Payroll Payee Tax Data Reference.   
Payroll_Payee_FICA_Data  Payroll_Payee_FICA_Data  [0..*]  Payroll Payee FICA Medicare and OASDI Data 
Validation Description
Please provide a Worker or Position. Both cannot be empty.  Please provide a Worker or Position. Both cannot be empty. 
The Position [position] doesn't have a Worker through employment as of this date: [date]  The Position doesn't have a Worker through employment Effective as of date. 
Only one can be selected: Position, All Positions or Apply to Worker.  Either Position or All Position Or ATW can be selected. Not all three can be selected and also the following combinations are Not allowed: (Position or ATW) or Not (All position Or ATW). 
OASDI Exempt is required when Apply to Worker is set to true.  Validating the condition when the Apply to worker is provided and OASDI Exempt is not provided. 
OASDI Exempt Reason is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and OASDI Exempt reason is not provided. 
Medicare Exempt is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and Medicare Exempt is not provided. 
Medicare Exempt Reason is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and Medicare Exempt reason is not provided. 
The position specified is not a valid US position based on the effective date.   
OASDI exempt is required when the OASDI exempt reason is provided.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
The Medicare exempt reason is required.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
Medicare exempt is required when the Medicare exempt reason is provided.  Validating the condition when the exempt reason is provided and the exempt is set to false. 
The OASDI exempt reason is required.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
OASDI data or Medicare data is required.   
 
top
 

Payroll_Payee_FICA_Data

part of: Payroll_Payee_Tax_Data
Payroll Payee FICA Medicare and OASDI Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Position_Reference  Position_ElementObject  [0..1]  Position Reference   
All_Positions  boolean  [0..1]  Set to True when FICA changes are for all positions - no position should be provided.   
Effective_As_Of  date  [1..1]  Date this update is effective.   
Apply_To_Worker  boolean  [0..1]  We include a new Apply to Worker attribute for Exempt status from FICA OASDI and FICA Medicare. When the Apply to Worker check box is not selected, Position is required.' Web services will fail if Position is not included.   
Medicare_Exempt_Data  Medicare_Exempt_Data  [0..*]  New Medicare Exempt Data element added in W15 
Validation Description
A future dated FICA tax data row exists.   
 
OASDI_Exempt_Data  OASDI_Exempt_Data  [0..*]  New OASDI Exempt Data element added in W15. 
Validation Description
A future dated FICA tax data row exists.   
 
Validation Description
Please provide a Worker or Position. Both cannot be empty.  Please provide a Worker or Position. Both cannot be empty. 
The Position [position] doesn't have a Worker through employment as of this date: [date]  The Position doesn't have a Worker through employment Effective as of date. 
Only one can be selected: Position, All Positions or Apply to Worker.  Either Position or All Position Or ATW can be selected. Not all three can be selected and also the following combinations are Not allowed: (Position or ATW) or Not (All position Or ATW). 
OASDI Exempt is required when Apply to Worker is set to true.  Validating the condition when the Apply to worker is provided and OASDI Exempt is not provided. 
OASDI Exempt Reason is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and OASDI Exempt reason is not provided. 
Medicare Exempt is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and Medicare Exempt is not provided. 
Medicare Exempt Reason is required when Apply To Worker is set to true.  Validating the condition when the Apply to worker is provided and Medicare Exempt reason is not provided. 
The position specified is not a valid US position based on the effective date.   
OASDI exempt is required when the OASDI exempt reason is provided.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
The Medicare exempt reason is required.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
Medicare exempt is required when the Medicare exempt reason is provided.  Validating the condition when the exempt reason is provided and the exempt is set to false. 
The OASDI exempt reason is required.  Validating the error condition when the Exempt is provided and the reason for that is empty. 
OASDI data or Medicare data is required.   
top
 

Medicare_Exempt_Data

part of: Payroll_Payee_FICA_Data
Medicare Exempt Data
 
Parameter name Type/Value Cardinality Description Validations
Exempt_from_Medicare  boolean  [0..1]  True if worker is exempt from FICA Medicare   
Medicare_Reason_for_Exemption_Reference  Payroll_Payee_FICA_Exempt_ReasonObject  [0..*]  Reason for Exemption from Medicare   
Validation Description
A future dated FICA tax data row exists.   
top
 

Payroll_Payee_FICA_Exempt_ReasonObject

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

Payroll_Payee_FICA_Exempt_ReasonObjectID

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

OASDI_Exempt_Data

part of: Payroll_Payee_FICA_Data
OASDI Exempt Data
 
Parameter name Type/Value Cardinality Description Validations
Exempt_from_OASDI  boolean  [0..1]  True if worker exempt from FICA OASDI   
OASDI_Reason_for_Exemption_Reference  Payroll_Payee_FICA_Exempt_ReasonObject  [0..*]  Reason for Exemption from OASDI   
Validation Description
A future dated FICA tax data row exists.   
top
 

Payroll_Payee_Tax_DataReferenceEnumeration

part of: Payroll_Payee_Tax_DataObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Payroll_Payee_FICA_Exempt_ReasonReferenceEnumeration

part of: Payroll_Payee_FICA_Exempt_ReasonObjectID
Base Type
string
top