Service Directory > v31.2 > Payroll > Get_Payroll_Payee_Tax_Location_Mappings
 

Operation: Get_Payroll_Payee_Tax_Location_Mappings

This web service operation is designed to get worker tax location mapping 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_Tax_Location_Mappings_Request

Element to hold all Payroll Payee Tax Location Mappings Request Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_Tax_Location_Mapping_Request_References  [0..1]  Element to hold Payroll Payee Tax Location Mapping Request References content   
Request_Criteria [Choice]   Payroll_Payee_Tax_Location_Mapping_Request_Criteria  [0..1]  Element to hold Payroll Payee Tax Location Mapping Request Criteria content   
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. 
 
top
 

Response Element: Get_Payroll_Payee_Tax_Location_Mappings_Response

Element to hold Get Payroll Payee Tax Location Mapping Response Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_Tax_Location_Mapping_Request_References  [0..1]  Element to hold Payroll Payee Tax Location Mapping Request References content   
Request_Criteria  Payroll_Payee_Tax_Location_Mapping_Request_Criteria  [0..1]  Element to hold Payroll Payee Tax Location Mapping Request Criteria content   
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_Results  Response_Results  [0..1]  Element content containing Payroll Payee Tax Location Mapping Response Results   
Response_Data  Payroll_Payee_Tax_Location_Mapping_Response_Data  [0..1]  Element to hold Payroll Payee Tax Location Mapping Response Data content   
top
 

Payroll_Payee_Tax_Location_Mapping_Request_References

part of: Get_Payroll_Payee_Tax_Location_Mappings_Request, Get_Payroll_Payee_Tax_Location_Mappings_Response
Element to hold Payroll Payee Tax Location Mapping Request References information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Location_Mapping_Reference  Payroll_Payee_Tax_Location_MappingObject  [1..*]  Reference to existing Payroll Payee Tax Location Mapping(s)   
top
 

Payroll_Payee_Tax_Location_MappingObject

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

Payroll_Payee_Tax_Location_MappingObjectID

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

part of: Get_Payroll_Payee_Tax_Location_Mappings_Request, Get_Payroll_Payee_Tax_Location_Mappings_Response
Element to hold Payroll Payee Tax Location Mapping Request Criteria Information. Utilize this element to find existing Tax Location Mappings in the System.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker for the specified company for this tax location mapping. (No worker means all workers)   
Company_Reference  CompanyObject  [0..1]  Company for the specified or all workers for this tax location mapping   
Effective_as_Of  date  [0..1]  Effective Date for this tax location mapping   
top
 

WorkerObject

part of: Payroll_Payee_Tax_Location_Mapping_Request_Criteria, Payroll_Payee_Tax_Location_Mapping_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  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_Tax_Location_Mapping_Request_Criteria, Payroll_Payee_Tax_Location_Mapping_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
 

Response_Filter

part of: Get_Payroll_Payee_Tax_Location_Mappings_Request, Get_Payroll_Payee_Tax_Location_Mappings_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
 

Response_Results

part of: Get_Payroll_Payee_Tax_Location_Mappings_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_Location_Mapping_Response_Data

part of: Get_Payroll_Payee_Tax_Location_Mappings_Response
Element to hold Payroll Payee Tax Location Mapping Response Data Information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Location_Mapping  Payroll_Payee_Tax_Location_Mapping_Get_Data  [0..*]  Element to hold Payroll Payee Tax Location Mapping Response Data content   
top
 

Payroll_Payee_Tax_Location_Mapping_Get_Data

part of: Payroll_Payee_Tax_Location_Mapping_Response_Data
Element to hold Payroll Payee Tax Location Mapping Response Data Information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Location_Mapping_Reference  Payroll_Payee_Tax_Location_MappingObject  [0..1]  "This" instance of Payroll Payee Tax Location Mapping returned   
Payroll_Payee_Tax_Location_Mapping_Data  Payroll_Payee_Tax_Location_Mapping_Data  [0..1]  Element to hold Payroll Payee Tax Location Mapping Data content 
Validation Description
Cannot inactivate tax location mapping and individual states on the same entry.   
Tax location mapping was not enabled for worker's company on effective date.   
 
top
 

Payroll_Payee_Tax_Location_Mapping_Data

part of: Payroll_Payee_Tax_Location_Mapping_Get_Data
Element to hold Payroll Payee Tax Location Mapping Data Information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_Tax_Location_Mapping_ID  string  [0..1]  Unique Identifier for a Payroll Payee Tax Location Mapping. Also known as Payroll Payee Tax Location Mapping ID.   
Worker_Reference  WorkerObject  [1..1]  Worker this Payroll Payee Tax Location Mapping is for   
Effective_Date  date  [1..1]  Effective Date of this Payroll Payee Tax Location Mapping   
Company_Reference  CompanyObject  [1..1]  Company this Payroll Payee Tax Location Mapping is for   
Inactive_Tax_Location_Mapping  boolean  [0..1]  Indicator (active/inactive) for this Payroll Payee Tax Location Mapping   
Inactivate_State_Reference  Payroll_State_AuthorityObject  [0..*]  Payroll State Tax Authority this Payroll Payee Tax Location Mapping is for   
Validation Description
Cannot inactivate tax location mapping and individual states on the same entry.   
Tax location mapping was not enabled for worker's company on effective date.   
top
 

Payroll_State_AuthorityObject

part of: Payroll_Payee_Tax_Location_Mapping_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_Tax_Location_MappingReferenceEnumeration

part of: Payroll_Payee_Tax_Location_MappingObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
Base Type
string
top