Service Directory > v31.2 > Resource_Management > Get_Payroll_Timesheets_Total_Hours
 

Operation: Get_Payroll_Timesheets_Total_Hours

This web service operation will retrieve instances of Payroll Timesheet Total Hours. This type of timesheet contains references to the Worker and Period the timesheet is for, and one or more Timesheet Lines. A Timesheet Line contains references to a Time Code, a Position, a Cost Center, and Hours worked for each Day for the date range the timesheet covers. On the web service request, you can specify a specific reference to a Payroll Timesheet Total Hours to return, or find them by supplying search criteria of Period, Supervisory Organization, timesheet Status, and Worker.


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

This element is the top-level wrapper element for Payroll Timesheet Total Hours "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Timesheet_Total_Hours_Request_References  [0..1]  This element is a wrapper containing references to Payroll Timesheet Total Hours.   
Request_Criteria [Choice]   Payroll_Timesheet_Total_Hours_Request_Criteria  [0..1]  This element contains the search criteria to use to find Payroll Timesheets Total Hours. Criteria include Supervisory Organization, Worker, Timesheet Status, and Period.   
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_Total_Hours_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 Total Hours response. If this element is not included then ALL of the Response Groups are included in the response.   
top
 

Response Element: Get_Payroll_Timesheets_Total_Hours_Response

This element is the top-level wrapper containing all the same data that was on the web service request, as well as the Payroll Timesheets Total Hours that were found from the search criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Timesheet_Total_Hours_Request_References  [0..1]  This element is a wrapper containing references to Payroll Timesheet Total Hours.   
Request_Criteria  Payroll_Timesheet_Total_Hours_Request_Criteria  [0..1]  This element contains the search criteria to use to find Payroll Timesheets Total Hours. Criteria include Supervisory Organization, Worker, Timesheet Status, and Period.   
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_Total_Hours_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 Total Hours response. If this element is not included then ALL of the Response Groups are 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  Payroll_Timesheet_Total_Hours_Response_Data  [0..1]  This element is a wrapper containing one sub-element for each Payroll Timesheet Total Hours that was returned by the search criteria in the web service Request.   
top
 

Payroll_Timesheet_Total_Hours_Request_References

part of: Get_Payroll_Timesheets_Total_Hours_Request, Get_Payroll_Timesheets_Total_Hours_Response
This element is a wrapper containing references to Payroll Timesheet Total Hours.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Total_Hours_Reference  Payroll_Timesheet_Total_HoursObject  [1..*]  References to Payroll Timesheet Total Hours.   
top
 

Payroll_Timesheet_Total_HoursObject

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

Payroll_Timesheet_Total_HoursObjectID

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

part of: Get_Payroll_Timesheets_Total_Hours_Request, Get_Payroll_Timesheets_Total_Hours_Response
This element contains the search criteria to use to find Payroll Timesheets Total Hours. Criteria include Supervisory Organization, Worker, Timesheet Status, and Period.
 
Parameter name Type/Value Cardinality Description Validations
Supervisory_Organization_Reference  OrganizationObject  [1..1]  Reference to the Supervisory Organization to search for Timesheets in.   
Worker_Reference  WorkerObject  [0..*]  References to Workers to find timesheets for.   
Start_Date_On_or_After  date  [0..1]  Date to find Timesheets with a Period that starts on or after the date specified.   
Start_Date_On_or_Before  date  [0..1]  Date to find Timesheets with a Period that starts on or before the date specified.   
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_Total_Hours_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_Total_Hours_Request_Criteria, Payroll_Timesheet_Total_Hours_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_Total_Hours_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_Total_Hours_Request_Criteria, Payroll_Timesheet_Total_Hours_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_Total_Hours_Request, Get_Payroll_Timesheets_Total_Hours_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_Total_Hours_Response_Group

part of: Get_Payroll_Timesheets_Total_Hours_Request, Get_Payroll_Timesheets_Total_Hours_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Get Payroll Timesheets Total Hours 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 Total Hours Reference data is to be included in the response   
top
 

Response_Results

part of: Get_Payroll_Timesheets_Total_Hours_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_Total_Hours_Response_Data

part of: Get_Payroll_Timesheets_Total_Hours_Response
This element is a wrapper containing one sub-element for each Payroll Timesheet Total Hours that was returned by the search criteria in the web service Request.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Total_Hours  Payroll_Timesheet_Total_Hours  [0..*]  This element is a wrapper for a single Payroll Timesheet Total Hours. It contains a reference to the timesheet, and all the data in a sub-element.   
top
 

Payroll_Timesheet_Total_Hours

part of: Payroll_Timesheet_Total_Hours_Response_Data
This element is a wrapper for a single Payroll Timesheet Total Hours. It contains a reference to the timesheet, and all the data in a sub-element.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Total_Hours_Reference  Payroll_Timesheet_Total_HoursObject  [0..1]  A reference to the Payroll Timesheet Total Hours.   
Payroll_Timesheet_Total_Hours_Data  Payroll_Timesheet_Total_Hours_Data_WWS  [0..1]  This element encapsulates all the data associated with a single Payroll Timesheet Total Hours. The data includes the ID, Status, Worker, Period, and additional data for each Line on the timesheet. 
Validation Description
Period for Payroll Timesheet must have Period Schedule usage type of Timesheet.  Period for Payroll Timesheet must have Period Schedule usage type of Timesheet. 
Another Timesheet exists for this Period and Worker. Only one Payroll Timesheet per Period and Worker is permitted.  Another Timesheet exists for this Period and Worker. Only one Payroll Timesheet per Period and Worker is permitted. 
 
top
 

Payroll_Timesheet_Total_Hours_Data_WWS

part of: Payroll_Timesheet_Total_Hours
This element encapsulates all the data associated with a single Payroll Timesheet Total Hours. The data includes the ID, Status, Worker, Period, and additional data for each Line on the timesheet.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Timesheet_Total_Hours_ID  string  [0..1]  The unique ID for this Payroll Timesheet Total Hours.   
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.   
Worker_Reference  WorkerObject  [1..1]  A reference to the Worker this timesheet is for.   
Period_Reference  PeriodObject  [1..1]  A reference to the Period this timesheet covers.   
Payroll_Timesheet_Line_Replacement_Data  Payroll_Timesheet_Line_Data  [0..*]  This element encapsulates data for a Payroll Timesheet Line, which contains multiple days' worth of timesheet information. A Payroll Timesheet Line is for one Time Code, a Position, and a Cost Center, and can contain a memo. 
Validation Description
Only one Timesheet Line per reporting criteria is permitted.  Only one Timesheet Line per reporting criteria is permitted. 
 
Validation Description
Period for Payroll Timesheet must have Period Schedule usage type of Timesheet.  Period for Payroll Timesheet must have Period Schedule usage type of Timesheet. 
Another Timesheet exists for this Period and Worker. Only one Payroll Timesheet per Period and Worker is permitted.  Another Timesheet exists for this Period and Worker. Only one Payroll Timesheet per Period and Worker is permitted. 
top
 

Payroll_Timesheet_Line_Data

part of: Payroll_Timesheet_Total_Hours_Data_WWS
This element encapsulates data for a Payroll Timesheet Line, which contains multiple days' worth of timesheet information. A Payroll Timesheet Line is for one Time Code, a Position, and a Cost Center, and can contain a memo.
 
Parameter name Type/Value Cardinality Description Validations
Time_Code_Reference  Time_Entry_CodeObject  [1..1]  A reference to the Time Code for this line. 
Validation Description
Time Code selected must be used by Earnings.  Time Code selected must be used by Earnings. 
 
Cost_Center_Reference  Cost_CenterObject  [0..1]  A reference to the Cost Center this line is being tracked to.   
Position_Reference  PositionObject  [0..1]  A reference to the Position for this line. 
Validation Description
The Position for the Timesheet line must be a valid position for the Worker on the Timesheet effective as of the Timesheet Period's End Date.  The Position for the Timesheet line must be a valid position for the Worker on the Timesheet effective as of the Timesheet Period's End Date. The Position field is ignored if multiple positions is not configured in Tenant Setup, or if the Worker only has one assigned position. 
 
Memo  string  [0..1]  An optional memo for the Timesheet line.   
Payroll_Timesheet_Day_Total_Hours_Data  Payroll_Timesheet_Day_Total_Hours_Data  [0..*]  This element encapsulates data for a single Payroll Timesheet Day. It contains the date of the day being tracked, and the total hours worked. 
Validation Description
The date for the day on a Timesheet Line must be unique to other dates on the same Timesheet Line.  The date for the day on a Timesheet Line must be unique to other dates on the same Timesheet Line. 
 
Validation Description
Only one Timesheet Line per reporting criteria is permitted.  Only one Timesheet Line per reporting criteria is permitted. 
top
 

Time_Entry_CodeObject

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

Cost_CenterObject

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

Cost_CenterObjectID

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

PositionObject

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

Payroll_Timesheet_Day_Total_Hours_Data

part of: Payroll_Timesheet_Line_Data
This element encapsulates data for a single Payroll Timesheet Day. It contains the date of the day being tracked, and the total hours worked.
 
Parameter name Type/Value Cardinality Description Validations
Timesheet_Day_Date  date  [1..1]  The date this day contains hours for. 
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. 
 
Hours_Worked  decimal (14, 2)   [0..1]  The total hours worked on this day.   
Validation Description
The date for the day on a Timesheet Line must be unique to other dates on the same Timesheet Line.  The date for the day on a Timesheet Line must be unique to other dates on the same Timesheet Line. 
top
 

Payroll_Timesheet_Total_HoursReferenceEnumeration

part of: Payroll_Timesheet_Total_HoursObjectID
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_Entry_CodeReferenceEnumeration

part of: Time_Entry_CodeObjectID
Base Type
string
top
 

Cost_CenterReferenceEnumeration

part of: Cost_CenterObjectID
Base Type
string
top
 

PositionReferenceEnumeration

part of: PositionObjectID
Base Type
string
top