Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Provides access to Workbench Timesheet data.
Endpoints
TimesheetAttendanceApi
[Description]The resources available in this module.
TimesheetListApi
Provides API access to the Desktop Timesheets (#/Timesheets/List.aspx) Web Workbench screen.
/api/ |
|---|
TimesheetListApi |
|---|
Operation
Logged in User
Parameters
Method | Performed As | Request Query | Request Body | Response |
POST |
TimesheetDefaultsApi
[Description]
/api/TimesheetDefaultsApi
Operation
Retrieve a filtered list of the User’s Timesheets. | GridRequestParametersApi.IntValue, if specified; otherwise Logged in User. |
- |
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
TimesheetDetailApi
Note: In order to create a Timesheet Line, please use POST with {Workbench.Mvc4.Areas.Api.Controllers.TimesheetDefaultsApiController} TimesheetDefaultsApi.
/api/TimesheetDetailApi | ||||
|---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET | personId | |||
POST | ||||
TimesheetDefaultsApi
[Description]
/api/ |
|---|
TimesheetDefaultsApi | ||||
|---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
Returns a list of timesheets. If IntValue is specified, then the list of Timesheet is filtered by this PersonID.
GET | jobTranId |
TimesheetAttendanceApi
[Description]
/api/TimesheetAttendanceApi | ||||
|---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST | ||||
Models
TimesheetApiModel
Property | Data Type | Description |
|---|---|---|
Day1Complete | Boolean | |
Day2Complete | Boolean | |
Day3Complete | Boolean | |
Day4Complete | Boolean | |
Day5Complete | Boolean | |
Day6Complete | Boolean | |
Day7Complete | Boolean | |
AttendanceFields | ||
Form | ||
Rows | Array [TimesheetsDailyDetailLine] | |
ReadonlyMessages | Array [Tuple_String] | |
ValidationErrors | Array [MvcValidationError] | |
WarningMessage | String | |
SuccessMessage | String | |
ErrorMessage | String |
⬆️ Back to top
TimesheetsAttendanceKey
Property | Data Type | Description |
|---|---|---|
Action | String | = ['FirstIn', 'FirstOut', 'SecondIn', 'SecondOut'] |
PersonId | Integer | Person id. |
TimesheetDate | String | Timesheet date. |
⬆️ Back to top
TimesheetApiAttendanceFields
Property | Data Type | Description |
|---|---|---|
Rows | GridResult_TimesheetsAttendanceLine |
⬆️ Back to top
TimesheetsAttendanceKey
Property | Data Type | Description |
|---|---|---|
Action | String | =['FirstIn', 'FirstOut', 'SecondIn', 'SecondOut'] |
PersonId | Integer | |
TimesheetDate | String |
⬆️ Back to top
TimesheetsAttendanceLine
Property | Data Type | Description |
|---|---|---|
LineNo | String | Line number. |
ShiftNo | String | Shift number. |
Shift | String | Shift work. |
Day1 | Day 1 in the week. | |
Day2 | Day 2 in the week. | |
Day3 | Day 3 in the week. | |
Day4 | Day 4 in the week. | |
Day5 | Day 5 in the week. | |
Day6 | Day 6 in the week. | |
Day7 | Day 7 in the week. | |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
TimesheetsDetailDefaults
Property | Data Type | Description |
|---|---|---|
keys |
⬆️ Back to top
TimesheetsDetailDefaultsKey
Property | Data Type | Description |
|---|---|---|
FinCoCode | String | Financial company code. |
ActivityCode | Activity code. | |
ActivityType | String | Activity type. |
ActivitySubType | String | Activity sub type. |
CostRate | Number | Cost rate. |
CostType | String | Cost type. |
GstRate | Number | Tax rate. |
WorkCentreCode | Work Centre code. | |
TimeCode | ||
TimesheetDate | String | Timesheet date. |
EmployeeClass | String | Employee class. |
⬆️ Back to top
TimesheetsDetailKey
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 | |
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
TimesheetsDailyDetailLine
Property | Data Type | Description |
|---|---|---|
TranDate | String | |
FinCoCode | String | Code of financial company. |
FileAttachment | File attachment. | |
JobCode | Job code. | |
Action | Action. | |
LogHeader | Log header. | |
WorkCentreCode | Work Centre code. | |
Profile | ||
ActivityCode | Activity code. | |
Allowance | Allowance. | |
ActivityType | String | Activity type. |
TimeCode | ||
StartTime | Start time. | |
EndTime | End time. | |
Breaks | Breaks. | |
Quantity | Quantity of hours. | |
QuantityOnly | ||
NoteOnly | ||
Details | String | |
Duplicate | ||
Delete | ||
PlantIssues | Plant issue if applied. | |
Payroll | ||
JobManagerApproved | Boolean | |
PlantIssuesCount | Integer | |
StockIssuesCount | Integer | |
SourceID | Integer | |
SourceIDSpecified | Boolean | |
TimesheetRef1 | ||
TimesheetRef2 | ||
EmployeeClass | String | Employee class. |
EmployeeClassValue | Employee class. | |
PlantIssuesData | WebGridDataModel_TimesheetsPlantIssueKey | |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer | |
⬆️ Back to top
TimesheetsKey
Property | Data Type | Description |
|---|---|---|
PersonId | Integer | Person id. |
TimesheetDate | String | Timesheet date. |
⬆️ Back to top
TimesheetsListItem
Property | Data Type | Description |
|---|---|---|
PersonName | Person name. | |
TimesheetDate | String | Timesheet date. |
Entered | ||
Standard | ||
Variance | ||
Completed | Boolean | Completed status. |
Approved | Boolean | Approved status. |
ExpenseClaim | Expense claim. | |
UpdatedDate | String | Updated date. |
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ 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 | ||
PlantCode | Plant code. | |
RateCode | Rate code. | |
UnitCode | Unit code. | |
ActivityCode | Activity code. | |
WorkCentreCode | Work Centre code. | |
DefaultQuantity | ||
ActualQuantity | ||
Note | Note. | |
Delete | ||
Status | String | Status. |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
TimesheetsTimesheetFormResult
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
WebGridDataModel_TimesheetsPlantIssueKey
Property | Data Type | Description |
|---|---|---|
data | Array [TimesheetsPlantIssuesLine] |
⬆️ Back to top
Example
V
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Top of page
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|