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

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

/api/TimesheetDefaultsApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieves Timesheet Line default values for a given line key.	Admin User	TimesheetDetailKey	-	TimesheetDefaultLineApiModel

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	TimesheetKey	The unique key for the line.
ApprovalOnHoldField	BoolViewData	The Approval On Hold flag on the Timesheet.
ApprovedField	BoolViewData	The Approved flag on the Timesheet.
CompletedField	BoolViewData	The Completed flag on the Timesheet.
VarianceNotes	StringViewData	The Variance notes on the Timesheet.
ToilJobBalance	DecimalViewData	The User’s Time Off In Lieu balance.

⬆️ Back to top

TimesheetDetailKey

Property	Data Type	Description
JobTranId	Integer	The unique ID of the Timesheet Line.
PersonId	Integer	The Person ID.
FinCoCode	String	The Financial Company Code.
JobCode	String	The Job Code.
ActivityCode	String	The Activity Code.
WorkCentreCode	String	The Work Centre Code.
ActivityType	String	The Activity Type.
ActivitySubType	String	The Activity Sub Type.
TimeCode	String	The Time Code.
CostType	String	The Cost Type of the Activity and Time Code.

⬆️ Back to top

TimesheetDetailLine

Property	Data Type	Description
Key	TimesheetDetailKey	The unique key for the line.
TranDate	String	The transaction date.
FinCoCode	String	The Financial Company Code on the transaction.
JobCode	CellData	The Job on the transaction.
Action	CellData	The Action on the transaction.
LogHeader	CellData	The Log on the transaction.
ActivityCode	CellData	The Activity on the transaction.
ActivityType	String	The Type of Activity.
TimeCode	CellData	The Time Code on the transaction.
WorkCentreCode	CellData	The Work Centre on the transaction.
Profile	CellData	The Employee Profile on the transaction
StartTime	CellData	The Start Time on the transaction.
EndTime	CellData	The End Time on the transaction.
Breaks	CellData	The Breaks value on the transaction.
Quantity	CellData	The hours Quantity, and Notes, on the transaction.
QuantityOnly	CellData	The hours Quantity on the transaction.
NoteOnly	CellData	The Notes on the transaction.
JobManagerApproved	Boolean	The flag to indicate if the transaction has been approved.
PlantIssuesCount	Integer	The number of Plant Issues on the transaction.
PlantIssuesData.data	Array<PlantIssueLine>	The Plant Issues on the transaction.
StockIssuesCount	Integer	The number of Stock transactions on the transaction.
SourceID	Integer	The Source ID on the transaction.
SourceIDSpecified	Boolean	The flag to indicate if the transaction has a source.
TimesheetRef1	CellData	The TimesheetRef1 details on the transaction.
TimesheetRef2	CellData	The TimesheetRef2 details on the transaction.
EmployeeClass	String	The Employee Class on the transaction.
EmployeeClassValue	CellData	The Employee Class on the transaction.

⬆️ Back to top

PlantIssueKey

Property	Data Type	Description
JobTranID	Integer	The unique ID of the Plant Issue.
ItemId	Integer	The ID of the Plant Item.
JobCode	String	The Job Code.
WorkCentreCode	String	The Work Centre Code.
ActivityCode	String	The Activity Code.
RateCode	String	The Plant Rate Code.
TranDate	String	The Date of the Plant Issue.

⬆️ Back to top

PlantIssueLine

Property	Data Type	Description
Key	PlantIssueKey	The unique key for the line.
Selected	CellData	A flag to indicate the Plant Issue is being edited.
PlantCode	CellData	The Plant Item on the Plant Issue.
RateCode	CellData	The Plant Rate on the Plant Issue.
UnitCode	CellData	The Unit on the Plant Issue.
ActivityCode	CellData	The Activity on the Plant Issue.
WorkCentreCode	CellData	The Work Centre on the Plant Issue.
DefaultQuantity	CellData	The Default Quantity on the Plant Issue.
ActualQuantity	CellData	The Actual Quantity on the Plant Issue.
Note	CellData	The Note on the Plant Issue.
Delete	CellData	A flag to indicate the Plant Issue is being deleted.
Status	String	Either "from-database" if pre-existing, or "generated-line" if pre-populated by default.

⬆️ Back to top

TimesheetDefaultLineApiModel

Property	Data Type	Description
keys	TimesheetDefaultLine	The default values for the Timesheet Line.

⬆️ Back to top

TimesheetDefaultLine

Property	Data Type	Description
FinCoCode	String	The default Financial Company Code.
ActivityCode	CellData	The default Activity.
ActivityType	String	The Type of the Activity.
ActivitySubType	String	The Sub Type of the Activity.
CostRate	Number	The Cost Rate of the Activity.
CostType	String	The Cost Type of the Activity.
GstRate	Number	The GST Rate of the Activity.
WorkCentreCode	CellData	The default Work Centre.
TimeCode	CellData	The default Time Code.
TimesheetDate	String	the default Timesheet Date.

⬆️ 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