Service Directory > v32.1 > Payroll > Put_Tax_Document_Delivery
 

Operation: Put_Tax_Document_Delivery

This web service is designed to add or update 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).


@ - 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: Put_Tax_Document_Delivery_Request

Request structure for adding or updating a payroll tax document printing election for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Tax_Document_Delivery_Reference  Unique_IdentifierObject  [0..1]  Reference to the tax document delivery election you are editing.   
Tax_Document_Delivery_Data  Tax_Document_Delivery_Data  [0..1]  The data for the tax document delivery election. 
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   
 
Validation Description
If you provide a Tax Document Delivery Reference you cannot edit the Company Reference, Worker Reference, or Form Group Reference. If you would like to add a new Tax Document Delivery for that combination of Company Reference, Worker Reference, and Form Group Reference remove the reference ID and a new one will be created.   
top
 

Response Element: Put_Tax_Document_Delivery_Response

Tax document delivery response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Tax_Document_Delivery_Reference  Unique_IdentifierObject  [0..1]  Tax document delivery reference   
top
 

Unique_IdentifierObject

part of: Put_Tax_Document_Delivery_Request, Put_Tax_Document_Delivery_Response
 
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_Data

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

WorkerObject

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

Payroll_Payee_Tax_Report_Type_Delivery_GroupObject

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

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