Service Directory > v25.1 > Resource_Management > Submit_Payroll_Timesheet_Total_Hours
 

Operation: Submit_Payroll_Timesheet_Total_Hours

This web service operation will add or update 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.


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

This element is a wrapper for the request to add or update a Payroll Timesheet Total Hours.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. If an existing instance is found and this flag is set there will be an error.   
Payroll_Timesheet_Total_Hours_Reference  Payroll_Timesheet_Total_HoursObject  [0..1]  Reference to existing Payroll Timesheet Total Hours to update.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Contains data for business processing   
Payroll_Timesheet_Total_Hours_Data  Payroll_Timesheet_Total_Hours_Data_WWS  [1..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. 
 
Validation Description
This Timesheet is not allowed to be updated at this time. A Timesheet may only be updated if Payroll has not yet been run for the period and if the Period Schedule is marked "Allow Timesheet Changes".  This Timesheet is not allowed to be updated at this time. A Timesheet may only be updated if Payroll has not yet been run for the period and if the Period Schedule is marked "Allow Timesheet Changes". 
top
 

Response Element: Submit_Payroll_Timesheet_Total_Hours_Response

This element is a wrapper for the response data upon submitting the service request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Timesheet_Total_Hours_Reference  Payroll_Timesheet_Total_HoursObject  [0..1]  A reference to the Timesheet updated or created.   
Application_Instance_Related_Exceptions_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Payroll_Timesheet_Total_HoursObject

part of: Submit_Payroll_Timesheet_Total_Hours_Request, Submit_Payroll_Timesheet_Total_Hours_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  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
 

Financials_Business_Process_Parameters

part of: Submit_Payroll_Timesheet_Total_Hours_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Payroll_Timesheet_Total_Hours_Data_WWS

part of: Submit_Payroll_Timesheet_Total_Hours_Request
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. 
Validation Description
The Worker on a timesheet cannot be changed once the timesheet has been created.  The Worker on a timesheet cannot be changed once the timesheet has been created. 
 
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
 

PeriodObject

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

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
 

Application_Instance_Related_Exceptions_Data

part of: Submit_Payroll_Timesheet_Total_Hours_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Payroll_Timesheet_Total_HoursReferenceEnumeration

part of: Payroll_Timesheet_Total_HoursObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

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