Service Directory > v32.1 > Resource_Management > Get_Timesheets
 

Operation: Get_Timesheets

This service operation will get Worker Timesheets for the specified criteria. Timesheets include data such as Supervisory Organization, Worker, Start and End Date for the time reporting period. They also include hours per day, time code, billable flag and memo information. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if Supervisory Organization is specified. There are also other criteria that will return different types of timesheets.


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

Request document wrapper element for the Get_Timesheets operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Timesheet_Request_References  [0..1]  Encapsulating element including the information for identifying the Timesheet.   
Request_Criteria [Choice]   Timesheet_Request_Criteria  [0..1]  Element containing the request criteria for retrieving Timesheets.   
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Timesheet_Response_Group  [0..1]  Element containing Timesheet information to be included in the response.   
top
 

Response Element: Get_Timesheets_Response

Response wrapper element for the Get_Timesheet operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Timesheet_Request_References  [0..1]  Encapsulating element including the information for identifying the Timesheet.   
Request_Criteria  Timesheet_Request_Criteria  [0..1]  Element containing the request criteria for retrieving Timesheets.   
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  Timesheet_Response_Group  [0..1]  Element containing Timesheet information to be included 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  Timesheet_Response_Data  [0..1]  Element that contains the response data for the Get_Timesheet operation.   
top
 

Timesheet_Request_References

part of: Get_Timesheets_Request, Get_Timesheets_Response
Encapsulating element including the information for identifying the Timesheet.
 
Parameter name Type/Value Cardinality Description Validations
Timesheet_Reference  TimesheetObject  [0..*]  Timesheets being requested. The values are either Workday IDs or Timesheet Reference IDs.   
top
 

TimesheetObject

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

TimesheetObjectID

part of: TimesheetObject
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, Payroll_Timesheet_Total_Hours_ID, Project_Timesheet_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
 

Timesheet_Request_Criteria

part of: Get_Timesheets_Request, Get_Timesheets_Response
Element containing the request criteria for retrieving Timesheets.
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  Supervisory_OrganizationObject  [1..1]  One criteria for the Get_Timesheet operation.   
Worker_Reference  WorkerObject  [0..*]  One criteria for the Get_Timesheet operation.   
Start_Date_On_or_After  date  [0..1]  One criteria for the Get_Timesheet operation.   
Start_Date_On_or_Before  date  [0..1]  One criteria for the Get_Timesheet operation.   
Last_Updated_On_or_After  date  [0..1]  One criteria for the Get_Timesheet operation.   
Last_Updated_On_or_Before  date  [0..1]  One criteria for the Get_Timesheet operation.   
Payroll_Timesheets_Only  boolean  [0..1]  Will return all types of Payroll timesheets (including Time In Time Out).   
Project_Timesheets_Only  boolean  [0..1]  One criteria for the Get_Timesheet operation.   
Time_In_Time_Out_Timesheets_Only  boolean  [0..1]  One criteria for the Get_Timesheet operation.   
Multi-Worker_Timesheets_Only  boolean  [0..1]  One criteria for the Get_Timesheet operation.   
Worker_Time_Card_Reference_ID  string  [0..1]  One criteria for the Get_Timesheet operation.   
top
 

Supervisory_OrganizationObject

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

Supervisory_OrganizationObjectID

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

WorkerObject

part of: Timesheet_Request_Criteria, Worker_Time_Card_WWS_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
 

Response_Filter

part of: Get_Timesheets_Request, Get_Timesheets_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
 

Timesheet_Response_Group

part of: Get_Timesheets_Request, Get_Timesheets_Response
Element containing Timesheet information to be included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean to include/exclude the Timesheet Reference information in the response for Get_Timesheet operation.   
Include_Worker_Time_Card_Data  boolean  [0..1]  Boolean to include/exclude the Worker Time Card (Timesheet) information.   
Include_Time_Card_Daily_Data  boolean  [0..1]  Boolean to include/exclude time card line details.   
Include_Time_In_Time_Out_Data  boolean  [0..1]  Boolean to include/exclude Time In Time Out details.   
top
 

Response_Results

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

Timesheet_Response_Data

part of: Get_Timesheets_Response
Element that contains the response data for the Get_Timesheet operation.
 
Parameter name Type/Value Cardinality Description Validations
Timesheet  Timesheet  [0..*]  Element that contains the response data for the Get_Timesheet operation.   
top
 

Timesheet

part of: Timesheet_Response_Data
Element that contains the response data for the Get_Timesheet operation.
 
Parameter name Type/Value Cardinality Description Validations
Timesheet_Reference  TimesheetObject  [0..1]  Timesheet reference that will be returned as part of the response for the Get_Timesheet operation.   
Timesheet_Data  Worker_Time_Card_WWS_Data  [0..1]  Element that contains Worker Time Card (Timesheet) Data.   
Timesheet_Daily_Data  Timesheet_Daily_WWS_Data  [0..*]  Element that contains Timesheet Day details for a Timesheet for a Get_Timesheet operation.   
top
 

Worker_Time_Card_WWS_Data

part of: Timesheet
Element that contains Worker Time Card (Timesheet) Data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Time_Card_ID  string  [0..1]  The ID returned for each Timesheet (Worker Time Card) for Get_Timesheet operation's response.   
Last_Updated_Date  date  [0..1]  The Last Updated Date of Worker Time Card for Get_Timesheet operation's response.   
Is_Payroll_Timesheet  boolean  [0..1]  Is this a Payroll Timesheet for Worker Time Card for Get_Timesheet operation's response.   
Worker_Time_Card_Status  string  [0..1]  Status for worker time card (timesheet) for Get_Timesheet operation's response.   
Worker_Reference  WorkerObject  [0..1]  Worker for worker time card (timesheet) for Get_Timesheet operation's response.   
Period_Reference  PeriodObject  [0..1]  Period for the Timesheet. A Period may have only one Timesheet per worker per timesheet type (project or payroll).   
Start_Date  date  [0..1]  The period start date for worker time card (timesheet) for Get_Timesheet operation.   
End_Date  date  [0..1]  Period end date for worker time card (timesheet) for Get_Timesheet operation's response.   
Time_Zone_Reference  Time_ZoneObject  [0..1]  The Time Zone chosen on the Worker Time Card for TITO Timesheets.   
top
 

PeriodObject

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

Time_ZoneObject

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

Timesheet_Daily_WWS_Data

part of: Timesheet
Element that contains Timesheet Day details for a Timesheet for a Get_Timesheet operation.
 
Parameter name Type/Value Cardinality Description Validations
Timesheet_Day_Date  date  [0..1]  The date of the time card line for Get_Timesheet operation's response.   
Time_Code_Reference  Time_Entry_CodeObject  [0..1]  Time Code for the Time Card Line reference provided for Get_Timesheet operation's response.   
Hours_Worked  decimal (14, 2)   [0..1]  The amount of hours worked for the time card line specified for Get_Timesheet operation's response.   
Billable  boolean  [0..1]  If the time card line is set to billable for Get_Timesheet operation's response.   
Memo  string  [0..1]  The comment field for the time card line for Get_Timesheet operation's response.   
Worktags_Reference  Audited_Accounting_WorktagObject  [0..*]  Worktags associated with time card line for Get_Timesheet operation's response. For Payroll Timesheet this is limited to Cost Center.   
Project_Reference  ProjectObject  [0..1]  Project associated with time card line for Get_Timesheet operation's response. Payroll timesheets will not have a value populated in this field.   
Project_Task_Reference  Project_Plan_TaskObject  [0..1]  Project task associated with time card line for Get_Timesheet operation's response. Payroll timesheets will not have a value populated in this field.   
Position_Reference  PositionObject  [0..*]  The Position selected when entering the Payroll Timesheet. Only applies if the Tenant Setup is configured for Multiple Jobs.   
Percent_Complete_Proposed_for_Timesheet_Day  decimal (7, 4) >0   [0..1]  Proposed Percent complete from the Timesheet Line in decimal format (0.5 for 50%, 1 for 100%)   
Time_In_Time_Out_Data  Time_In_Time_Out_WWS_Data  [0..*]  Time In Time Out Data   
top
 

Time_Entry_CodeObject

part of: Timesheet_Daily_WWS_Data, Time_In_Time_Out_WWS_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  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
 

Audited_Accounting_WorktagObject

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

Audited_Accounting_WorktagObjectID

part of: Audited_Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Donor_ID, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_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
 

ProjectObject

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

ProjectObjectID

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

Project_Plan_TaskObject

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

Project_Plan_TaskObjectID

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

PositionObject

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

PositionObjectID

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

Time_In_Time_Out_WWS_Data

part of: Timesheet_Daily_WWS_Data
This is the Time Card Daily Lines
 
Parameter name Type/Value Cardinality Description Validations
Time_In  dateTime  [0..1]  Time In   
Time_Out  dateTime  [0..1]  Time Out   
Time_Card_Factor_Reference  Time_Entry_CodeObject  [0..1]  Time Code   
Time_In_Time_Out_Memo  string  [0..1]  Time In Time Out Memo   
top
 

TimesheetReferenceEnumeration

part of: TimesheetObjectID
Base Type
string
top
 

Supervisory_OrganizationReferenceEnumeration

part of: Supervisory_OrganizationObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

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

Audited_Accounting_WorktagReferenceEnumeration

part of: Audited_Accounting_WorktagObjectID
Base Type
string
top
 

ProjectReferenceEnumeration

part of: ProjectObjectID
Base Type
string
top
 

Project_Plan_TaskReferenceEnumeration

part of: Project_Plan_TaskObjectID
Base Type
string
top
 

PositionReferenceEnumeration

part of: PositionObjectID
Base Type
string
top