Service Directory > v31.2 > Payroll > Get_Paycheck_Deliveries
 

Operation: Get_Paycheck_Deliveries

The Paycheck Deliveries operation returns all the Paycheck delivery information for Workers. Includes the Delivery Method, and also how to receive copies of their payslips (Electronic/Paper etc).


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

The information required to obtain a full or subset of records containing workers Paycheck Delivery and Payslip Printing options.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Paycheck_Delivery_Request_References  [0..1]  Set of referenceis to workers paycheck delivery methods.   
Request_Criteria [Choice]   Paycheck_Delivery_Request_Criteria  [0..1]  Used to return a selected set of Workers Pay Check Delivery records   
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  Paycheck_Delivery_Response_Group  [0..1]  Response Group Data   
top
 

Response Element: Get_Paycheck_Deliveries_Response

Paycheck Deliveries Response Element contains the request and response information for the request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Paycheck_Delivery_Request_References  [0..1]  Set of referenceis to workers paycheck delivery methods.   
Request_Criteria  Paycheck_Delivery_Request_Criteria  [0..1]  Used to return a selected set of Workers Pay Check Delivery records   
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  Paycheck_Delivery_Response_Group  [0..1]  Response Group Data   
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  Paycheck_Delivery_Response_Data  [0..1]  Complete set of all Response Data returned.   
top
 

Paycheck_Delivery_Request_References

part of: Get_Paycheck_Deliveries_Request, Get_Paycheck_Deliveries_Response
Set of referenceis to workers paycheck delivery methods.
 
Parameter name Type/Value Cardinality Description Validations
Paycheck_Delivery_Reference  Paycheck_DeliveryObject  [1..*]  To identify individual records, use the Workday ID.   
top
 

Paycheck_DeliveryObject

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

Paycheck_DeliveryObjectID

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

Paycheck_Delivery_Request_Criteria

part of: Get_Paycheck_Deliveries_Request, Get_Paycheck_Deliveries_Response
Used to return a selected set of Workers Pay Check Delivery records
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Paycheck_Deliveries_Request, Get_Paycheck_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
 

Paycheck_Delivery_Response_Group

part of: Get_Paycheck_Deliveries_Request, Get_Paycheck_Deliveries_Response
Response Group Data
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Flag   
top
 

Response_Results

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

Paycheck_Delivery_Response_Data

part of: Get_Paycheck_Deliveries_Response
Complete set of all Response Data returned.
 
Parameter name Type/Value Cardinality Description Validations
Paycheck_Delivery  Paycheck_Delivery  [0..*]  Delivery Response Data   
top
 

Paycheck_Delivery

part of: Paycheck_Delivery_Response_Data
Delivery Response Data
 
Parameter name Type/Value Cardinality Description Validations
Paycheck_Delivery_Reference  Paycheck_DeliveryObject  [0..1]  The paycheck delivery record reference.   
Paycheck_Delivery_Data  Paycheck_Delivery_Data  [0..*]  An individual workers Paycheck Delivery Method   
top
 

Paycheck_Delivery_Data

part of: Paycheck_Delivery
An individual workers Paycheck Delivery Method
 
Parameter name Type/Value Cardinality Description Validations
Paycheck_Delivery_ID  string  [0..1]  This is a unique identifier for the Paycheck Delivery record.   
Worker_Reference  WorkerObject  [1..1]  The Worker for this record.   
Date_Last_Updated  date  [0..1]  When this record was last updated.   
Paycheck_Delivery_Method_Reference  Paycheck_Delivery_MethodObject  [0..1]  The Paycheck Delivery Method   
Payslip_Printing_Override_Reference  Payslip_Printing_OverrideObject  [0..1]  The Payslip Printing Override option for this record.   
Company_Reference  CompanyObject  [0..1]  The Company for this record.   
top
 

WorkerObject

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

Paycheck_Delivery_MethodObject

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

Paycheck_Delivery_MethodObjectID

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

Payslip_Printing_OverrideObject

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

Payslip_Printing_OverrideObjectID

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

Paycheck_DeliveryReferenceEnumeration

part of: Paycheck_DeliveryObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Paycheck_Delivery_MethodReferenceEnumeration

part of: Paycheck_Delivery_MethodObjectID
Base Type
string
top
 

Payslip_Printing_OverrideReferenceEnumeration

part of: Payslip_Printing_OverrideObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top