Service Directory > v31.2 > Payroll > Get_Tax_Document_Deliveries
 

Operation: Get_Tax_Document_Deliveries

This web service is designed to get the payroll year end form printing elections for Company, Delivery Group and optionally Worker(s). These elections determine whether the worker will receive a paper copy of their payroll year end form(s).


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

This web service is designed to get the payroll year end form printing elections for Worker(s). These elections determine whether the worker will receive a paper copy of their payroll year end form(s).
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Tax_Document_Delivery_Request_References  [0..1]  Reference(s) to the tax document delivery election you would like to view   
Request_Criteria [Choice]   Tax_Document_Delivery_Request_Criteria  [0..1]  Request criteria to determine the tax document delivery elections you would like to view 
Validation Description
The only supported Form Groups are ‘Canada’ and 'Canada_Electronic_Only_Default' . Please update the Form Group Reference.   
 
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  Tax_Document_Delivery_Response_Group  [0..1]  Boolean to indicate if you want to Include the tax document delivery election references in the response   
top
 

Response Element: Get_Tax_Document_Deliveries_Response

Get Tax Document Deliveries Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Tax_Document_Delivery_Request_References  [0..1]  Reference(s) to the tax document delivery election you would like to view   
Request_Criteria  Tax_Document_Delivery_Request_Criteria  [0..1]  Request criteria to determine the tax document delivery elections you would like to view 
Validation Description
The only supported Form Groups are ‘Canada’ and 'Canada_Electronic_Only_Default' . Please update the Form Group Reference.   
 
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  Tax_Document_Delivery_Response_Group  [0..1]  Indicate if you want to Include the tax document delivery election references in the response   
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  Tax_Document_Delivery_Response_Data  [0..1]  Tax document deliveries response   
top
 

Tax_Document_Delivery_Request_References

part of: Get_Tax_Document_Deliveries_Request, Get_Tax_Document_Deliveries_Response
Reference(s) to the tax document delivery election you would like to view
 
Parameter name Type/Value Cardinality Description Validations
Tax_Document_Delivery_Reference  Unique_IdentifierObject  [1..*]  Reference to the tax document delivery election you are viewing   
top
 

Unique_IdentifierObject

part of: Tax_Document_Delivery_Request_References, Tax_Document_Delivery
 
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
 

Tax_Document_Delivery_Request_Criteria

part of: Get_Tax_Document_Deliveries_Request, Get_Tax_Document_Deliveries_Response
Request criteria to determine the tax document delivery elections you would like to view
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company for the tax document deliveries you would like to view   
Form_Group_Reference  Payroll_Payee_Tax_Report_Type_Delivery_GroupObject  [1..1]  Delivery group for the tax document deliveries you would like to view   
Worker_Reference  WorkerObject  [0..*]  Worker(s) for the tax document deliveries you would like to view   
Validation Description
The only supported Form Groups are ‘Canada’ and 'Canada_Electronic_Only_Default' . Please update the Form Group Reference.   
top
 

CompanyObject

part of: Tax_Document_Delivery_Data, Tax_Document_Delivery_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
 

Payroll_Payee_Tax_Report_Type_Delivery_GroupObject

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

Payroll_Payee_Tax_Report_Type_Delivery_GroupObjectID

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

Response_Filter

part of: Get_Tax_Document_Deliveries_Request, Get_Tax_Document_Deliveries_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
 

Tax_Document_Delivery_Response_Group

part of: Get_Tax_Document_Deliveries_Request, Get_Tax_Document_Deliveries_Response
Indicate if you want to Include the tax document delivery election references in the response
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include the tax document delivery election references in the response   
top
 

Response_Results

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

Tax_Document_Delivery_Response_Data

part of: Get_Tax_Document_Deliveries_Response
Tax document deliveries response
 
Parameter name Type/Value Cardinality Description Validations
Tax_Document_Delivery  Tax_Document_Delivery  [0..*]  Tax document delivery response   
top
 

Tax_Document_Delivery

part of: Tax_Document_Delivery_Response_Data
Tax document delivery data
 
Parameter name Type/Value Cardinality Description Validations
Tax_Document_Delivery_Reference  Unique_IdentifierObject  [0..1]  Tax Document Delivery Reference   
Tax_Document_Delivery_Data  Tax_Document_Delivery_Data  [0..*]  Tax document delivery data 
Validation Description
The only supported Form Groups are ‘Canada’ and 'Canada_Electronic_Only_Default' . Please update the Form Group Reference.   
Invalid Worker selected.   
Company is not enabled for ESS Printing Election   
Invalid combination of Company and Delivery Group   
 
top
 

Tax_Document_Delivery_Data

part of: Tax_Document_Delivery
Tax document delivery data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker reference for the tax document delivery   
Company_Reference  CompanyObject  [1..1]  Company for the tax document delivery   
Form_Group_Reference  Payroll_Payee_Tax_Report_Type_Delivery_GroupObject  [1..1]  Delivery group for the tax document delivery   
Override_Default_Delivery  boolean  [0..1]  Override default delivery that is defined for the delivery group   
Validation Description
The only supported Form Groups are ‘Canada’ and 'Canada_Electronic_Only_Default' . Please update the Form Group Reference.   
Invalid Worker selected.   
Company is not enabled for ESS Printing Election   
Invalid combination of Company and Delivery Group   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Payee_Tax_Report_Type_Delivery_GroupReferenceEnumeration

part of: Payroll_Payee_Tax_Report_Type_Delivery_GroupObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top