Service Directory > v32.1 > Payroll > Get_Payroll_USA_State_and_Local_Tax_Elections
 

Operation: Get_Payroll_USA_State_and_Local_Tax_Elections

Retrieve Worker Tax Elections for State and Local Tax Authorities NOTE: The As Of Entry Moment and As Of Effective date fields in the Response Filter are not supported by this method - any values you pass in via these fields will be ignored. Use the Effective Date field in the Request Criteria instead to retrieve elections effective as of a given date. The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.


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

Request for Get Payroll USA State and Local Tax Elections
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payroll_USA_State_and_Local_Tax_Election_Request_Criteria  [0..1]  Criteria for Get Payroll USA State and Local Tax Elections. Use the attributes of this component to filter the results returned by this web service.   
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_USA_State_and_Local_Tax_Election_Response_Group  [0..1]  Response Group for Payroll USA State and Local Tax Elections   
top
 

Response Element: Get_Payroll_USA_State_and_Local_Tax_Elections_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payroll_USA_State_and_Local_Tax_Election_Request_Criteria  [0..1]  Request Criteria used to filter State and Local Tax Elections.   
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_USA_State_and_Local_Tax_Election_Response_Group  [0..1]  Response Group for Payroll USA State and Local Tax Elections   
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_State_and_Local_Tax_Election_Response_Data  [0..1]  Response Data for Get Payroll USA State and Local Tax Elections   
top
 

Payroll_USA_State_and_Local_Tax_Election_Request_Criteria

part of: Get_Payroll_USA_State_and_Local_Tax_Elections_Request, Get_Payroll_USA_State_and_Local_Tax_Elections_Response
Request Criteria used to filter State and Local Tax Elections.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  You must provide a Company Reference. Tax Elections will be retrieved for the workers of this company.   
Worker_Reference  WorkerObject  [0..*]  Optional. Provide one or more Worker References. Tax Elections will be retrieved for these workers only.   
Effective_Date  date  [0..1]  Return Tax Elections effective on the date provided. Defaults to the current system date.   
top
 

CompanyObject

part of: Payroll_USA_State_and_Local_Tax_Election_Request_Criteria, Payroll_Payee_State_and_Local_Tax_Elections
 
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
 

WorkerObject

part of: Payroll_USA_State_and_Local_Tax_Election_Request_Criteria, Payroll_Payee_State_and_Local_Tax_Elections
 
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
 

Response_Filter

part of: Get_Payroll_USA_State_and_Local_Tax_Elections_Request, Get_Payroll_USA_State_and_Local_Tax_Elections_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_USA_State_and_Local_Tax_Election_Response_Group

part of: Get_Payroll_USA_State_and_Local_Tax_Elections_Request, Get_Payroll_USA_State_and_Local_Tax_Elections_Response
Response Group for Payroll USA State and Local Tax Elections
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payroll_USA_State_and_Local_Tax_Elections_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_State_and_Local_Tax_Election_Response_Data

part of: Get_Payroll_USA_State_and_Local_Tax_Elections_Response
Response for Get Payroll USA State and Local Tax Elections
 
Parameter name Type/Value Cardinality Description Validations
Payroll_State_and_Local_Tax_Election  Payroll_Payee_State_and_Local_Tax_Elections  [0..*]  Payroll State and Local Tax Election Response Data 
Validation Description
Worker must be in Company as of Effective Date specified.   
 
top
 

Payroll_Payee_State_and_Local_Tax_Elections

part of: Payroll_State_and_Local_Tax_Election_Response_Data
Payroll State and Local Tax Election Response Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker for Tax Election Data   
Company_Reference  CompanyObject  [0..1]  Company for Tax Election Data   
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Payroll_State_Authority_Data  State_Tax_Election_Data  [1..*]  State Tax Election Data 
Validation Description
[state_auth] does not support Earned Income Credit Tax Elections.   
 
Validation Description
Worker must be in Company as of Effective Date specified.   
top
 

State_Tax_Election_Data

part of: Payroll_Payee_State_and_Local_Tax_Elections
Payroll State and Local Tax Elections
 
Parameter name Type/Value Cardinality Description Validations
Payroll_State_Authority_Reference  Payroll_State_AuthorityObject  [0..1]  Payroll State Tax Authority Reference - the Payroll State Authority to which these elections apply   
State_Income_Tax_Data  Payroll_Payee_State_Election_for_State_and_Local  [0..*]  State Income Tax Elections 
Validation Description
State does not support tax withholding or does not allow for state specific tax election to be entered   
Rate Table Specification for New Jersey is not Valid.   
Attribute not supported by [state] Tax Authority. Valid Attributes are: [attributes]   
Only one exemption option may be selected, either MSRR Exempt or Exempt Indicator.   
The domicile state cannot be the same as the resident state.   
Active Duty (Oklahoma) election must be effective on or after 2018-01-01.   
Fort Campbell Exempt (Kentucky) election must be effective on or after 2018-01-01.   
Only one exemption option may be selected, either MSRR Exempt, Exempt Indicator, or Fort Campbell Exempt (Kentucky).   
 
State_Unemployment_Data  Payroll_Payee_SUTA_Electon_for_State_and_Local  [0..1]  State Unemployment Elections   
Earned_Income_Credit_Data  Payroll_Payee_EIC_Election_for_State_and_Local  [0..1]  State Earned Income Credit Elections - applies to the state of Wisconsin only.   
Payroll_State_County_Tax_Data  Payroll_Payee_County_Election_for_State_and_Local  [0..*]  State County Tax Election Data 
Validation Description
Local County Tax Authority Reference does not share the same County Region as the State Tax Authority.   
 
Payroll_State_City_Tax_Data  Payroll_Payee_City_Election_for_State_and_Local  [0..*]  Local City Tax Election 
Validation Description
Payroll Constant Percent Reference is not Valid for Payroll Tax Authority.   
Local City Tax Authority Reference does not share the same County Region as the State Tax Authority.   
Payroll Constant Text Reference used for Exemption Reason is not valid   
Previous Employer Deducted Amount field is only valid for Pennsylvania cities.   
Low Income Threshold attribute is only valid for Pennsylvania cities.   
Exemptions are only valid for cities in New York and Michigan   
Additional Amount only valid for Michigan, NYC and Yonkers   
Nonresident Alien is only valid for Pittsburgh City/Baldwin-Whitehall SD (Pennsylvania:Allegheny), 1719$3370 and Pittsburgh City/Pittsburgh SD (Pennsylvania:Allegheny), 1719$2474.   
Not Subject to EIT field is only valid for Pennsylvania cities.   
Primary EIT field is only valid for Pennsylvania cities.   
Not Subject to EIT field is only valid for work city elections.   
Primary EIT field is only valid for work city elections.   
 
Payroll_State_School_District_Tax_Data  Payroll_Payee_School_District_Election_for_State_and_Local  [0..*]  Local School District Tax Election Data 
Validation Description
Payroll Constant Text Reference used for Exemption Reason is not valid   
School District Tax Authority Reference does not share the same County Region as the State Tax Authority.   
 
Payroll_State_Other_Tax_Data  Payroll_Payee_Other_Election_for_State_and_Local  [0..*]  Tax Election for Other State Taxes 
Validation Description
Other Tax Authority Reference does not share the same County Region as the State Tax Authority.   
 
Validation Description
[state_auth] does not support Earned Income Credit Tax Elections.   
top
 

Payroll_State_AuthorityObject

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

Payroll_State_AuthorityObjectID

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

Payroll_Payee_State_Election_for_State_and_Local

part of: State_Tax_Election_Data
State Income Tax Election Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Married_Filing_Jointly_Optional_Calculation  boolean  [0..1]  Married Filing Jointly Optional Calculation - Puerto Rico Only   
Payroll_Withholding_Status_Reference  Payroll_Withholding_StatusObject  [0..1]  Payroll Withholding Status - usage varies by Payroll Tax Authority. 
Validation Description
Payroll Marital Status Reference is not Valid for Payroll Tax Authority.   
Marital Status is Required for this Payroll State Authority.   
 
Veteran_Exemption  boolean  [0..1]  Veteran Exemption - Puerto Rico Only   
Exemption_for_Dependents_Complete  decimal (5, 0) >0   [0..1]  Exemption for Dependents Complete - Puerto Rico Only   
Exemption_for_Dependents_Joint_Custody  decimal (5, 0) >0   [0..1]  Exemption for Dependents Joint Custody - Puerto Rico Only   
Allowance_on_Special_Deduction  boolean  [0..1]  Allowance on Special Deduction - Puerto Rico Only 
Validation Description
Allowance based on Special Deduction is not a valid selection.   
 
New_Jersey_Rate_Table_Reference  Payroll_Withholding_StatusObject  [0..1]  New Jersey Rate Table Specification 
Validation Description
Rate Table Specification Reference is only valid for [new_jersey]   
 
Dependent_Allowance  decimal (5, 0) >0   [0..1]  Dependent Allowance   
Number_of_Allowances  decimal (5, 0) >0   [0..1]  Number of Allowances 
Validation Description
Number of Allowances is not allowed for this State Tax Authority. Use a Number of Allowances Reference instead.   
 
Number_of_Allowances_Reference  Payroll_Constant_NumberObject  [0..1]  Number of Allowances for Georgia and Louisiana State Tax Authorities. The value for this attribute is expressed as an instance of Payroll Constant Number. 
Validation Description
Number of Allowances Reference is only valid for these State Tax Authorities: [const_states]   
 
Estimated_Deductions  decimal (5, 0) >0   [0..1]  Estimated Deductions   
Exemptions  decimal (6, 0) >0   [0..1]  Personal Exemptions   
Withholding_Exemption  decimal (5, 0) >0   [0..1]  Withholding Exemptions   
Employee_Blind  boolean  [0..1]  Employee Blind   
Additional_Amount  decimal (8, 2) >0   [0..1]  Additional Amount   
Additional_Percent  decimal (12, 6) >0   [0..1]  Additional Percent - Puerto Rico Only. Both Additional Percent and Additional Amount cannot be specified together. 
Validation Description
You cannot enter both Additional Amount and Percent. Please enter either Additional Amount or Additional Percent or neither.   
 
Services_Localized_in_Illinois  boolean  [0..1]  The web service is updated to support the new field "Services Localized in Illinois" for the Illinois state. When this flag is checked, the worker will resolve State Withholding (Resident) for Illinois.   
Reciprocity_Tax_Credit_Amount  decimal (18, 6) >0   [0..1]  Reciprocity Tax Credit Amount   
XMLNAME_6A  boolean  [0..1]  6A Exemption   
XMLNAME_6B  boolean  [0..1]  6B Exemption   
XMLNAME_6C  boolean  [0..1]  6C Exemption   
XMLNAME_6D  boolean  [0..1]  6D Exemption   
Certificate_of_Non-Residence  boolean  [0..1]  Certificate of Non-Residence   
Certificate_of_Residence  boolean  [0..1]  Certificate of Residence   
Certificate_of_Withholding_Exemption_and_County_Status  boolean  [0..1]  Display true when WH4 is set for a worker.   
Lock_In_Letter  boolean  [0..1]  Lock In Letter   
Allocation_Percent  decimal (26, 6) >0   [0..1]  Allocation Percentage   
Withholding_Percent_Reference  Payroll_Constant_PercentObject  [0..1]  Withholding Allocation Percent Reference (Arizona) 
Validation Description
Payroll Constant Percent Reference is not Valid for Payroll Tax Authority.  Payroll Constant Percent Reference is not Valid for Payroll Tax Authority. 
For Arizona State, Withholding Percent is required if worker is not exempt. If worker is exempt, withholding percent should not be entered.  For Arizona State, Withholding Percent is required if worker is not exempt. If worker is exempt, withholding percent should not be entered. 
 
Pay_Period_Amount  decimal (18, 6) >0   [0..1]  Annual Withholding Amount   
Spouse_Indicator  boolean  [0..1]  Spouse Blind   
Full-time_Student_Indicator  boolean  [0..1]  Full Time Student Indicator   
Head_of_Household  boolean  [0..1]  Head of Household   
Annual_Tax_Credits  decimal (14, 2) >0   [0..1]  Annual Tax Credits   
Additional_Allowance  decimal (5, 0) >0   [0..1]  Additional Allowance   
Reduced_Withholding_Amount  decimal (18, 6) >0   [0..1]  Reduced Withholding Amount   
No_Wage_No_Tax  boolean  [0..1]  No Wage/No Tax Indicator   
Exempt  boolean  [0..1]  Exempt Indicator. If TRUE The Employee is exempt from Tax Authority.   
Exempt_Reason_Reference  Unique_IdentifierObject  [0..1]  Exempt Reason for Exempt Indicator 
Validation Description
Exempt Reason must be cleared if Exempt is not selected   
Exempt Reason entered is not valid for given Payroll State Authority   
 
Withholding_Substantiated  boolean  [0..1]  Nebraska Withholding Substantiated   
Inactivate_State_Tax  boolean  [0..1]  Inactive   
MSRR_Exempt  boolean  [0..1]  Military Spouse Residency Relief Exemption   
Entrepreneur_Exemption  boolean  [0..1]  Entrepreneur Exemption - Puerto Rico Only 
Validation Description
You cannot select Exempt or No Wage/No Tax elections when you select the Entrepreneur Exemption.   
Additional amount or percent is not allowed with the Entrepreneur Exemption.   
Entrepreneur Exemption record must have an effective date greater than or equal to 01/01/2017.   
 
Domicile_State_Reference  Payroll_State_AuthorityObject  [0..1]  Domicile State for MSRR Exemption 
Validation Description
Domicile State must be cleared if MSRR Exempt is not selected   
Domicile State must be populated if MSRR Exempt is selected and state requires it   
 
Increase_or_Decrease_Withholding_Amount  decimal (8, 2)   [0..1]  Increase (positive) or Decrease (negative) amount to apply to State Withholding   
Lower_Tax_Rate_or_Low_Income  boolean  [0..1]  Lower Tax Rate/Low Income   
Active_Duty__Oklahoma_  boolean  [0..1]  Specifies if Active Duty is selected for Oklahoma.   
Fort_Campbell_Exempt__Kentucky_  boolean  [0..1]  Specifies if Fort Campbell Exemption is selected for Kentucky.   
Validation Description
State does not support tax withholding or does not allow for state specific tax election to be entered   
Rate Table Specification for New Jersey is not Valid.   
Attribute not supported by [state] Tax Authority. Valid Attributes are: [attributes]   
Only one exemption option may be selected, either MSRR Exempt or Exempt Indicator.   
The domicile state cannot be the same as the resident state.   
Active Duty (Oklahoma) election must be effective on or after 2018-01-01.   
Fort Campbell Exempt (Kentucky) election must be effective on or after 2018-01-01.   
Only one exemption option may be selected, either MSRR Exempt, Exempt Indicator, or Fort Campbell Exempt (Kentucky).   
top
 

Payroll_Withholding_StatusObject

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

Payroll_Withholding_StatusObjectID

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

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

Payroll_Constant_NumberObjectID

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

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

Payroll_Constant_PercentObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: State_Tax_Election_Data
State Unemployment Exemption Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Exempt  boolean  [0..1]  Indicates if the worker is exempt from Unemployment Insurance for this State Tax Authority   
top
 

Payroll_Payee_EIC_Election_for_State_and_Local

part of: State_Tax_Election_Data
Earned Income Credit Election
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Exempt  boolean  [0..1]  Worker is Exempt   
Number_of_Allowances  decimal (5, 0) >0   [0..1]  Number of Allowances   
top
 

Payroll_Payee_County_Election_for_State_and_Local

part of: State_Tax_Election_Data
State County Tax Election Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Tax_Address_Type_Reference  Tax_Address_TypeObject  [1..1]  Tax Address Type of Home, Work or Both that denotes whether this Local Tax Election applies to the Workers Home or Work Tax Authority or both.   
Payroll_Local_County_Authority_Reference  Payroll_Local_AuthorityObject  [1..1]  Reference to a Local County Tax Authority. The County Authority must be valid for the State Tax Authority specified in the Request.   
County_Additional_Amount  decimal (18, 6) >0   [0..1]  Additional Amount   
Inactivate_State_Tax  boolean  [0..1]  Inactive   
Validation Description
Local County Tax Authority Reference does not share the same County Region as the State Tax Authority.   
top
 

Tax_Address_TypeObject

part of: Payroll_Payee_County_Election_for_State_and_Local, Payroll_Payee_City_Election_for_State_and_Local, Payroll_Payee_Other_Election_for_State_and_Local
 
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  Tax_Address_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Tax_Address_TypeObjectID

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

Payroll_Local_AuthorityObject

part of: Payroll_Payee_County_Election_for_State_and_Local, Payroll_Payee_City_Election_for_State_and_Local, Payroll_Payee_School_District_Election_for_State_and_Local, Payroll_Payee_Other_Election_for_State_and_Local
 
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_Local_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Local_AuthorityObjectID

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

part of: State_Tax_Election_Data
Local City Tax Election
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Tax_Address_Type_Reference  Tax_Address_TypeObject  [1..1]  Tax Address Type of Home, Work or Both that denotes whether this Local Tax Election applies to the Workers Home or Work Tax Authority or both.   
Payroll_Local_City_Authority_Reference  Payroll_Local_AuthorityObject  [0..1]  Local City Tax Authority Reference   
Exemptions  decimal (5, 0) >0   [0..1]  Number of Allowances   
Withholding_Percent_Reference  Payroll_Constant_PercentObject  [0..1]  Withholding Percent Reference   
Previous_Employer_Deducted_Amount  decimal (14, 2) >0   [0..1]  Previous Employer Deducted Amount field is only valid for Pennsylvania cities.   
Additional_Amount  decimal (8, 2) >0   [0..1]  Additional Amount   
Nonresident_Alien  boolean  [0..1]  Nonresident Alien   
Certificate_of_Non-Residence  boolean  [0..1]  Certificate of Non-Residence   
Allocation_Percent  decimal (26, 6) >0   [0..1]  Allocation Percent   
Low_Income_Threshold  decimal (26, 6) >0   [0..1]  Low Income Threshold   
Exempt  boolean  [0..1]  Exempt Indicator. If TRUE The Employee is exempt from Tax Authority.   
Exempt_Reason_Reference  Payroll_Constant_TextObject  [0..1]  Exempt Reason Reference   
Inactivate_State_Tax  boolean  [0..1]  Indicates if this City Tax Election is inactive   
Primary_EIT__Pennsylvania_  boolean  [0..1]  Specifies if Pennsylvania local city work election is Primary EIT.   
Not_Subject_to_EIT__Pennsylvania_  boolean  [0..1]  Specifies that Pennsylvania local city work election is not set as Primary EIT.   
Validation Description
Payroll Constant Percent Reference is not Valid for Payroll Tax Authority.   
Local City Tax Authority Reference does not share the same County Region as the State Tax Authority.   
Payroll Constant Text Reference used for Exemption Reason is not valid   
Previous Employer Deducted Amount field is only valid for Pennsylvania cities.   
Low Income Threshold attribute is only valid for Pennsylvania cities.   
Exemptions are only valid for cities in New York and Michigan   
Additional Amount only valid for Michigan, NYC and Yonkers   
Nonresident Alien is only valid for Pittsburgh City/Baldwin-Whitehall SD (Pennsylvania:Allegheny), 1719$3370 and Pittsburgh City/Pittsburgh SD (Pennsylvania:Allegheny), 1719$2474.   
Not Subject to EIT field is only valid for Pennsylvania cities.   
Primary EIT field is only valid for Pennsylvania cities.   
Not Subject to EIT field is only valid for work city elections.   
Primary EIT field is only valid for work city elections.   
top
 

Payroll_Constant_TextObject

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

Payroll_Constant_TextObjectID

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

part of: State_Tax_Election_Data
Local School District Tax Election Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Payroll_Local_School_District_Authority_Reference  Payroll_Local_AuthorityObject  [0..1]  Local School District Tax Authority   
Exempt  boolean  [0..1]  Exempt Indicator. If TRUE The Employee is exempt from Tax Authority.   
Exempt_Reason_Reference  Payroll_Constant_TextObject  [0..1]  Exempt Reason Reference   
Previous_Employer_Deducted_Amount  decimal (8, 2) >0   [0..1]  Additional Amount   
Inactivate_State_Tax  boolean  [0..1]  Inactive   
Validation Description
Payroll Constant Text Reference used for Exemption Reason is not valid   
School District Tax Authority Reference does not share the same County Region as the State Tax Authority.   
top
 

Payroll_Payee_Other_Election_for_State_and_Local

part of: State_Tax_Election_Data
Tax Election for Other State Taxes
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Effective Date of Tax Elections   
Tax_Address_Type_Reference  Tax_Address_TypeObject  [1..1]  Tax Address Type of Home, Work or Both that denotes whether this Local Tax Election applies to the Workers Home or Work Tax Authority or both.   
Payroll_Other_Authority_Reference  Payroll_Local_AuthorityObject  [0..1]  Payroll State Other Tax Authority   
Exempt  boolean  [0..1]  Exempt Indicator. If TRUE The Employee is exempt from Tax Authority.   
Inactive  boolean  [0..1]  Inactive 
Validation Description
Payroll Other Tax Authority does not support Inactive Elections   
 
Validation Description
Other Tax Authority Reference does not share the same County Region as the State Tax Authority.   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
Base Type
string
top
 

Payroll_Withholding_StatusReferenceEnumeration

part of: Payroll_Withholding_StatusObjectID
Base Type
string
top
 

Payroll_Constant_NumberReferenceEnumeration

part of: Payroll_Constant_NumberObjectID
Base Type
string
top
 

Payroll_Constant_PercentReferenceEnumeration

part of: Payroll_Constant_PercentObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Tax_Address_TypeReferenceEnumeration

part of: Tax_Address_TypeObjectID
Base Type
string
top
 

Payroll_Local_AuthorityReferenceEnumeration

part of: Payroll_Local_AuthorityObjectID
Base Type
string
top
 

Payroll_Constant_TextReferenceEnumeration

part of: Payroll_Constant_TextObjectID
Base Type
string
top