Service Directory > v32.1 > Resource_Management > Get_Payroll_Timesheets_Time_In_Time_Out
 

Operation: Get_Payroll_Timesheets_Time_In_Time_Out

This service operation will get Payroll Timesheet Time In Time Out instances for the specified criteria. These types of timesheets are used to track time on an interval basis. For instance, work can be recorded against a specified time code from the hours of 8:00 am to 11:00 am, a different time code from 11:00 am to 12:00 pm, and so on. Payroll Timesheet Time In Time Out data includes Time Zone, the Worker the timesheet is for, the Period the timesheet covers, and data for each day on the timesheet. Data for each day includes the Date, and 0 or more work intervals specifying the Time In, Time Out, the Time Code, and a Memo.


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

This element is the top-level wrapper element for Payroll Timesheet Time In Time Out "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Timesheet_Time_In_Time_Out_Request_References  [0..1]  Encapsulates references to Payroll Timesheet Time In Time Out.   
Request_Criteria [Choice]   Payroll_Timesheet_Time_In_Time_Out_Request_Criteria  [0..1]  This element contains request criteria that can be specified to find particular instances of Payroll Timesheet Time In Time Out.   
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  Payroll_Timesheet_Time_In_Time_Out_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Get Payroll Timesheets Time In Time Out response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Payroll_Timesheets_Time_In_Time_Out_Response

Element containing Payroll Timesheet Time In Time Out response elements including echoed request data and request result.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Timesheet_Time_In_Time_Out_Request_References  [0..1]  This element contains the echoed Payroll Timesheet Time In Time Out Request References element.   
Request_Criteria  Payroll_Timesheet_Time_In_Time_Out_Request_Criteria  [0..1]  This element contains the echoed Payroll Timesheet Time In Time Out Request Criteria element.   
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  Payroll_Timesheet_Time_In_Time_Out_Response_Group  [0..1]  This element contains the echoed Payroll Timesheet Time In Time Out Response Group element.   
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  Payroll_Timesheet_Time_In_Time_Out_Response_Data  [0..1]  A wrapper element that contains all the Payroll Timesheet Time In Time Out objects returned by the web service for the criteria and/or references provided.   
top
 

Payroll_Timesheet_Time_In_Time_Out_Request_References

part of: Get_Payroll_Timesheets_Time_In_Time_Out_Request, Get_Payroll_Timesheets_Time_In_Time_Out_Response
Encapsulates references to Payroll Timesheet Time In Time Out.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Time_In_Time_Out_Reference  Payroll_Timesheet_Time_In_Time_OutObject  [1..*]  References specified to instances of Payroll Timesheet Time In Time Out.   
top
 

Payroll_Timesheet_Time_In_Time_OutObject

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

Payroll_Timesheet_Time_In_Time_OutObjectID

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

part of: Get_Payroll_Timesheets_Time_In_Time_Out_Request, Get_Payroll_Timesheets_Time_In_Time_Out_Response
This element contains request criteria that can be specified to find particular instances of Payroll Timesheet Time In Time Out.
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  OrganizationObject  [1..1]  Reference to the Supervisory Organization to search for Payroll Timesheets Total Hours in.   
Worker_Reference  WorkerObject  [0..*]  References to Workers to find timesheets for.   
Start_Date_On_or_After  date  [0..1]  Date which specifies to find timesheets that start on or after this date.   
Start_Date_On_or_Before  date  [0..1]  Date which specifies to find timesheets that start on or before this date.   
Timesheet_Status_Reference  Document_StatusObject  [0..*]  References to status to find timesheets for.   
Period_Reference  PeriodObject  [0..1]  References to Periods to find timesheets for.   
top
 

OrganizationObject

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

OrganizationObjectID

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

WorkerObject

part of: Payroll_Timesheet_Time_In_Time_Out_Request_Criteria, Payroll_Timesheet_Time_In_Time_Out_Data_WWS
 
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
 

Document_StatusObject

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

Document_StatusObjectID

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

PeriodObject

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

PeriodObjectID

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

Payroll_Timesheet_Time_In_Time_Out_Response_Group

part of: Get_Payroll_Timesheets_Time_In_Time_Out_Request, Get_Payroll_Timesheets_Time_In_Time_Out_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Get Payroll Timesheets Time In Time Out response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Payroll Timesheet Time In Time Out Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Payroll_Timesheets_Time_In_Time_Out_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_Timesheet_Time_In_Time_Out_Response_Data

part of: Get_Payroll_Timesheets_Time_In_Time_Out_Response
A wrapper element that contains all the Payroll Timesheet Time In Time Out objects returned by the web service for the criteria and/or references provided.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Time_In_Time_Out  Payroll_Timesheet_Time_In_Time_Out  [0..*]  Wrapper element that includes a reference to the timesheet and all the data for the timesheet.   
top
 

Payroll_Timesheet_Time_In_Time_Out

part of: Payroll_Timesheet_Time_In_Time_Out_Response_Data
Wrapper element that includes a reference to the timesheet and all the data for the timesheet.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Time_In_Time_Out_Reference  Payroll_Timesheet_Time_In_Time_OutObject  [0..1]  A reference to this timesheet object.   
Payroll_Timesheet_Time_In_Time_Out_Data  Payroll_Timesheet_Time_In_Time_Out_Data_WWS  [0..1]  Encapsulates all the data for a Payroll Timesheet Time In Time Out. Contains the ID, Time Zone, Worker, Period, and all the time tracking information for each day on the timesheet.   
top
 

Payroll_Timesheet_Time_In_Time_Out_Data_WWS

part of: Payroll_Timesheet_Time_In_Time_Out
Encapsulates all the data for a Payroll Timesheet Time In Time Out. Contains the ID, Time Zone, Worker, Period, and all the time tracking information for each day on the timesheet.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Time_In_Time_Out_ID  string  [0..1]  ID for the Payroll Timesheet Time In Time Out. This is a unique identifier for this timesheet.   
Locked_in_Workday  boolean  [0..1]  Set to True to disable editing and canceling the timesheet inside the Workday application. Timesheet can only be updated from the web service.   
Time_Zone_Reference  Time_ZoneObject  [0..1]  A reference to the time zone specified on the timesheet.   
Worker_Reference  WorkerObject  [0..1]  A reference for the Worker this timesheet is for.   
Period_Reference  PeriodObject  [0..1]  A reference to the Period this timesheet is for.   
Payroll_Timesheet_Day_Time_In_Time_Out_Replacement_Data  Payroll_Timesheet_Day_Time_In_Time_Out_WWS  [0..*]  This element encapsulates a day tracked on a timesheet. It contains 0 or more "Payroll Timesheet Day Time In Time Out Hours" representing intervals of time worked and tracked against specific time codes.   
top
 

Time_ZoneObject

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

Time_ZoneObjectID

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

part of: Payroll_Timesheet_Time_In_Time_Out_Data_WWS
This element encapsulates a day tracked on a timesheet. It contains 0 or more "Payroll Timesheet Day Time In Time Out Hours" representing intervals of time worked and tracked against specific time codes.
 
Parameter name Type/Value Cardinality Description Validations
Date  date  [0..1]  The date for this day being tracked on the timesheet. 
Validation Description
The date for the day on the timesheet ([timesheet day date]) must be within the date range of the Period selected: [period start] to [period end]  The date for the day on the timesheet must be within the date range of the Period selected. 
 
Payroll_Timesheet_Day_Time_In_Time_Out_Hours  Payroll_Timesheet_Day_Time_In_Time_Out_Hours_WWS  [0..*]  Element that encapsulates one interval of time worked within a day on a Time In Time Out timesheet, including the Time In, Time Out, Time Code, and Memo. 
Validation Description
The time sequence entered for [time in] and [time out] overlaps with a time sequence on the current Timesheet.  The time interval specified by Time In and Time Out cannot overlap with a time sequence on a current or previously entered Timesheet. 
Time In cannot be later than Time Out  Time In cannot be later than Time Out 
 
top
 

Payroll_Timesheet_Day_Time_In_Time_Out_Hours_WWS

part of: Payroll_Timesheet_Day_Time_In_Time_Out_WWS
Element that encapsulates one interval of time worked within a day on a Time In Time Out timesheet, including the Time In, Time Out, Time Code, and Memo.
 
Parameter name Type/Value Cardinality Description Validations
Time_In  dateTime  [1..1]  The Time In (starting time) for this work interval.   
Time_Out  dateTime  [1..1]  The Time Out (ending time) for this work interval.   
Time_Code_Reference  Time_Entry_CodeObject  [1..1]  A reference to the Time Code for this work interval. 
Validation Description
Time Code selected must be used by Earnings.  Time Code selected must be used by Earnings. 
 
Memo  string  [0..1]  An optional Memo for the work interval.   
Validation Description
The time sequence entered for [time in] and [time out] overlaps with a time sequence on the current Timesheet.  The time interval specified by Time In and Time Out cannot overlap with a time sequence on a current or previously entered Timesheet. 
Time In cannot be later than Time Out  Time In cannot be later than Time Out 
top
 

Time_Entry_CodeObject

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

Time_Entry_CodeObjectID

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

part of: Payroll_Timesheet_Time_In_Time_OutObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

Time_Entry_CodeReferenceEnumeration

part of: Time_Entry_CodeObjectID
Base Type
string
top