Service Directory > v32.1 > Payroll > Get_Payroll_Tax_Mappings_on_Location
 

Operation: Get_Payroll_Tax_Mappings_on_Location

This web service operation is designed to get the Payroll Tax Mappings for a Location, given it has Payroll Tax usage enabled


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

Element to hold all Payroll Tax Mapping on Location Request information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Tax_Mappings_on_Location_Request_References  [0..1]  Element to hold Payroll Tax Mappings on Location Request References content   
Request_Criteria [Choice]   Payroll_Tax_Mappings_on_Location_Request_Criteria  [0..1]  Element to hold Payroll Tax Mappings on Location 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_Tax_Mappings_on_Location_Response

Documentation Element to hold Get Payroll Tax Mappings on Location Response information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Payroll_Tax_Mappings_on_Location_Request_References  [0..*]  Element to hold Payroll Tax Mappings on Location Request References content   
Request_Criteria  Payroll_Tax_Mappings_on_Location_Request_Criteria  [0..*]  Documentation Element to hold Payroll Tax Mapping on Location Request Criteria Information   
Response_Filter  Response_Filter  [0..*]  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..*]  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 [Choice]   Payroll_Tax_Mappings_on_Location_Response_Data  [0..*]  Element to hold Payroll Tax Mappings on Location Response Data content   
top
 

Payroll_Tax_Mappings_on_Location_Request_References

part of: Get_Payroll_Tax_Mappings_on_Location_Request, Get_Payroll_Tax_Mappings_on_Location_Response
Documentation Element to hold Payroll Tax Mappings on Location Request References information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Tax_Location_Mapping_Reference  Payroll_Tax_Location_MappingObject  [0..*]  Specific Payroll Tax Location Mappings to return   
top
 

Payroll_Tax_Location_MappingObject

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

Payroll_Tax_Location_MappingObjectID

part of: Payroll_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_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_Tax_Mappings_on_Location_Request_Criteria

part of: Get_Payroll_Tax_Mappings_on_Location_Request, Get_Payroll_Tax_Mappings_on_Location_Response
Documentation Element to hold Payroll Tax Mapping on Location Request Criteria Information
 
Parameter name Type/Value Cardinality Description Validations
Location_Reference  LocationObject  [0..*]  Location(s) of the returned Payroll Tax Location Mapping(s). If left blank, will return all Locations with Payroll Tax usage enabled.   
Effective_Date_Reference  date  [0..1]  Effective as of Date for the returned Tax Location Mapping(s). If left blank, will default to current date.   
top
 

LocationObject

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

LocationObjectID

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

part of: Get_Payroll_Tax_Mappings_on_Location_Response
Element to hold Payroll Tax Mappings on Location Response Data information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Tax_Location_Mapping  Payroll_Tax_Location_Mapping  [0..*]  Element to hold Payroll Tax Mappings on Location Response Data content   
top
 

Payroll_Tax_Location_Mapping

part of: Payroll_Tax_Mappings_on_Location_Response_Data
Element to hold Payroll Tax Mappings on Location Response Data Information
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Tax_Location_Mapping_Reference  Payroll_Tax_Location_MappingObject  [0..1]  "This" instance of Payroll Tax Location Mapping returned   
Payroll_Tax_Location_Mapping_Data  Payroll_Tax_Location_Mapping_Data  [0..1]  Element to hold Payroll Tax Location Mapping Data content 
Validation Description
Active Payroll Tax Mapping must contain at least a Payroll State Authority.   
Payroll Tax Mapping may only have a [County][and1][City][and2][Other] that is valid for the given Payroll State Authority   
Payroll Tax Mapping cannot be added for a Location that does not have Payroll Tax usage.   
Inactive Payroll Tax Mappings cannot have any Payroll State, County, City, or Other Tax Authorities.   
Inactive Location entered   
Payroll State Authority must be for a US State.   
 
top
 

Payroll_Tax_Location_Mapping_Data

part of: Payroll_Tax_Location_Mapping
Element to hold Payroll Tax Location Mapping Data information
 
Parameter name Type/Value Cardinality Description Validations
Location_Reference  LocationObject  [1..1]  "This" instance of Payroll Tax Location Mapping returned   
Effective_Date  date  [1..1]  The Effective Date of this Payroll Tax Location Mapping   
Inactive  boolean  [0..1]  Flag for if this Payroll Tax Location Mapping is inactive   
Payroll_State_Authority_Reference  Payroll_State_AuthorityObject  [0..1]  The State Tax Authority for this Payroll Tax Location Mapping (singular)   
Payroll_Local_County_Authority_Reference  Payroll_Local_County_AuthorityObject  [0..1]  The County Tax Authority for this Payroll Tax Location Mapping (singular)   
Payroll_Local_City_Authority_Reference  Payroll_Local_City_AuthorityObject  [0..1]  The City Tax Authority for this Payroll Tax Location Mapping (singular)   
Payroll_Other_Authority_Reference  Payroll_Other_AuthorityObject  [0..1]  The Other Tax Authority for this Payroll Tax Location Mapping (singular)   
Validation Description
Active Payroll Tax Mapping must contain at least a Payroll State Authority.   
Payroll Tax Mapping may only have a [County][and1][City][and2][Other] that is valid for the given Payroll State Authority   
Payroll Tax Mapping cannot be added for a Location that does not have Payroll Tax usage.   
Inactive Payroll Tax Mappings cannot have any Payroll State, County, City, or Other Tax Authorities.   
Inactive Location entered   
Payroll State Authority must be for a US State.   
top
 

Payroll_State_AuthorityObject

part of: Payroll_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_Local_County_AuthorityObject

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

Payroll_Local_County_AuthorityObjectID

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

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

Payroll_Local_City_AuthorityObjectID

part of: Payroll_Local_City_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  [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_Other_AuthorityObject

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

Payroll_Other_AuthorityObjectID

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

part of: Payroll_Tax_Location_MappingObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
Base Type
string
top
 

Payroll_Local_County_AuthorityReferenceEnumeration

part of: Payroll_Local_County_AuthorityObjectID
Base Type
string
top
 

Payroll_Local_City_AuthorityReferenceEnumeration

part of: Payroll_Local_City_AuthorityObjectID
Base Type
string
top
 

Payroll_Other_AuthorityReferenceEnumeration

part of: Payroll_Other_AuthorityObjectID
Base Type
string
top