Overview

Provides access to Workbench Timesheet data.

Endpoints

The resources available in this module.

TimesheetListApi

Provides API access to the Daily Desktop Timesheets (#/Timesheets/List.aspx) Web Workbench screen.

/api/TimesheetListApi
Method	Performed As	Request Query	Request Body	Response
POST Retrieve a filtered list of the User’s Timesheets.	GridRequestParametersApi.IntValue, if specified; otherwise Logged in User.	-	GridRequestParametersApi	GridResult<TimesheetLine>

TimesheetDetailApi

Provides API access to the Daily Timesheet Detail (#/Timesheets/Daily.aspx) Web Workbench screen.

/api/TimesheetDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific Timesheet.	Admin User	TimesheetKey	-	TimesheetApiModel
POST Update an existing, or create a new Timesheet.	TimesheetApiModel.Form.Key.PersonId	-	TimesheetApiModel	TimesheetApiModel

TimesheetDefaultsApi

Note: In order to create a Timesheet Line, please use POST with {Workbench.Mvc4.Areas.Api.Controllers.TimesheetDefaultsApiController} TimesheetDefaultsApi.

/api/TimesheetDefaultsApi
Operation	Logged in User	Parameters	Body	Response
GET Retrieves timesheet default values for client side, calculation by PersonID and JobCode		jobTranId personId finCoCode jobCode activityCode workCentreCode activityType activitySubType timeCode costType costRate gstRate profileId statusFlag tranDate employeeClass

TimesheetAttendanceApi

[Description]

/api/TimesheetAttendanceApi
Operation	Logged in User	Parameters	Body	Response
POST

Models

The definitions of models specific to endpoints in this module.

TimesheetKey

Property	Data Type	Description
PersonId	Integer	The ID of the Person this Timesheet is for.
TimesheetDate	DateTime	The Timesheet Date.

⬆️ Back to top

TimesheetLine

Property	Data Type	Description
Key	TimesheetKey	The unique key for the line.
PersonName	CellData	The Person this Timesheet if for.
TimesheetDate	String	The Timesheet Date, formatted.
Entered	CellData	The total hours entered on the Timesheet.
Standard	CellData	The number of hours expected on the Timesheet.
Variance	CellData	The difference between Entered and Standard.
Completed	Boolean	The Completed flag on the Timesheet.
Approved	Boolean	The Approved flag on the Timesheet.
UpdatedDate	DateTime	The date the Timesheet was last modified.

⬆️ Back to top

TimesheetApiModel

Property	Data Type	Description
Form	TimesheetForm	The general data associated withe the Timesheet.
Rows	Array<TimesheetDetailLine>	The Timesheet Lines.
AttendanceFields.Rows	Array<TimesheetAttendanceLine>	The Timesheet Attendance Lines.
Day1Complete	Boolean	A flag to indicate if the first day of the Timesheet is complete.
Day2Complete	Boolean	A flag to indicate if the second day of the Timesheet is complete.
Day3Complete	Boolean	A flag to indicate if the third day of the Timesheet is complete.
Day4Complete	Boolean	A flag to indicate if the fourth day of the Timesheet is complete.
Day5Complete	Boolean	A flag to indicate if the fifth day of the Timesheet is complete.
Day6Complete	Boolean	A flag to indicate if the sixth day of the Timesheet is complete.
Day7Complete	Boolean	A flag to indicate if the seventh day of the Timesheet is complete.
SuccessMessage	String	A message indicating the update was successful.
WarningMessage	String	A warning message about the Timesheet.
ValidationErrors	Array<MvcValidationError>	A list of specific validation errors if the save was unsuccessful.

⬆️ Back to top

TimesheetForm

Property	Data Type	Description
Key	TimesheetsKey
ApprovalOnHoldField	BoolViewData
ApprovedField	BoolViewData	Value of Approval field.
CompletedField	BoolViewData	Value of Completed field.
NoEditMessage	String
TimesheetDate	String	Timesheet date,
TimesheetNew	Boolean
VarianceNotes	StringViewData	The difference between total and standard hours.
ToilJobBalance	DecimalViewData	Time Off In Lieu balance

⬆️ Back to top

TimesheetDetailKey

Property	Data Type	Description
JobTranId	Integer
PersonId	Integer	Person id.
FinCoCode	String	Financial company code.
JobCode	String	Job code.
ActivityCode	String	Activity code.
WorkCentreCode	String	Work Centre code.
ActivityType	String	Activity type.
ActivitySubType	String	Activity sub type.
TimeCode	String	Time code.
CostType	String	Cost type.
CostRate	Number	Cost rate
GstRate	Number	Tax rate.
ProfileId	Integer	User profile id.
StatusFlag	Integer	Status.
TranDate	String
EmployeeClass	String	Employee class.

⬆️ Back to top

TimesheetDetailLine

Property	Data Type	Description
TranDate	String
FinCoCode	String	Code of financial company.
FileAttachment	CellData	File attachment.
JobCode	CellData	Job code.
Action	CellData	Action.
LogHeader	CellData	Log header.
WorkCentreCode	CellData	Work Centre code.
Profile	CellData
ActivityCode	CellData	Activity code.
Allowance	CellData	Allowance.
ActivityType	String	Activity type.
TimeCode	CellData	Time code.
StartTime	CellData	Start time.
EndTime	CellData	End time.
Breaks	CellData	Breaks.
Quantity	CellData	Quantity of hours.
QuantityOnly	CellData
NoteOnly	CellData
Details	String
Duplicate	CellData
Delete	CellData
PlantIssues	CellData	Plant issue if applied.
Payroll	CellData
JobManagerApproved	Boolean
PlantIssuesCount	Integer
StockIssuesCount	Integer
SourceID	Integer
SourceIDSpecified	Boolean
TimesheetRef1	CellData
TimesheetRef2	CellData
EmployeeClass	String	Employee class.
EmployeeClassValue	CellData	Employee class.
PlantIssuesData	WebGridDataModel_TimesheetsPlantIssueKey
Status	String	Status.
ReadonlyFlag	Integer	Read Only status.
ReadonlyMessage	String	Read Only message.
OriginalKey	TimesheetsDetailKey
CurrentKey	TimesheetsDetailKey
Key	TimesheetsDetailKey
Index	Integer

⬆️ Back to top

TimesheetAttendanceKey

Property	Data Type	Description
Action	String	= ['FirstIn', 'FirstOut', 'SecondIn', 'SecondOut']
PersonId	Integer	Person id.
TimesheetDate	String	Timesheet date.

⬆️ Back to top

TimesheetAttendanceLine

Property	Data Type	Description
LineNo	String	Line number.
ShiftNo	String	Shift number.
Shift	String	Shift work.
Day1	CellData	Day 1 in the week.
Day2	CellData	Day 2 in the week.
Day3	CellData	Day 3 in the week.
Day4	CellData	Day 4 in the week.
Day5	CellData	Day 5 in the week.
Day6	CellData	Day 6 in the week.
Day7	CellData	Day 7 in the week.
ReadonlyFlag	Integer	Read Only status.
ReadonlyMessage	String	Read Only message.
OriginalKey	TimesheetsAttendanceKey
CurrentKey	TimesheetsAttendanceKey
Key	TimesheetsAttendanceKey
Index	Integer

⬆️ Back to top

TimesheetsDetailDefaults

Property	Data Type	Description
keys	TimesheetsDetailDefaultsKey

⬆️ Back to top

TimesheetsDetailDefaultsKey

Property	Data Type	Description
FinCoCode	String	Financial company code.
ActivityCode	CellData	Activity code.
ActivityType	String	Activity type.
ActivitySubType	String	Activity sub type.
CostRate	Number	Cost rate.
CostType	String	Cost type.
GstRate	Number	Tax rate.
WorkCentreCode	CellData	Work Centre code.
TimeCode	CellData	Time code.
TimesheetDate	String	Timesheet date.
EmployeeClass	String	Employee class.

⬆️ Back to top

TimesheetsPlantIssueKey

Property	Data Type	Description
JobTranID	Integer
ItemId	Integer	Item id.
JobCode	String	Job code.
WorkCentreCode	String	Work Centre code.
RateCode	String	Rate code.
TranDate	String
NewRow	String
PlantCode	String	Plant code
TimeWorkCentreCode	String

⬆️ Back to top

TimesheetsPlantIssuesLine

Property	Data Type	Description
Selected	CellData
PlantCode	CellData	Plant code.
RateCode	CellData	Rate code.
UnitCode	CellData	Unit code.
ActivityCode	CellData	Activity code.
WorkCentreCode	CellData	Work Centre code.
DefaultQuantity	CellData
ActualQuantity	CellData
Note	CellData	Note.
Delete	CellData
Status	String	Status.
ReadonlyFlag	Integer	Read Only status.
ReadonlyMessage	String	Read Only message.
OriginalKey	TimesheetsPlantIssueKey
CurrentKey	TimesheetsPlantIssueKey
Key	TimesheetsPlantIssueKey
Index	Integer

⬆️ Back to top

WebGridDataModel_TimesheetsPlantIssueKey

Property	Data Type	Description
data	Array [TimesheetsPlantIssuesLine]

⬆️ Back to top