Sign in
latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Timesheet

Retrieve timesheet details by ID

Get detailed information about a specific timesheet including all time entries.

This endpoint allows you to:

  • Retrieve complete timesheet information
  • View all daily time entries with work times and break times
  • Access time summary broken down by day type and hours type
  • See approval status and timestamps

Returns comprehensive timesheet data including individual entries for each day, work time periods, break time periods, overtime calculations, and approval information.

get/v1/timesheets/{timesheetId}

Path parameters

timesheetIdstring required

Unique identifier of the timesheet

Query parameters

employeeIdstring uuid required

Employee ID (employment ID) - required for authorization and to identify which employment's timesheet to retrieve

Response

Timesheet details retrieved successfully

timesheetIdstring required

Unique identifier for the timesheet

employeeIdstring

Unique identifier for the timesheet

startDatestring date required

Start date of the timesheet period

endDatestring date required

End date of the timesheet period

status'OPEN' | 'PARTIALLY_SUBMITTED' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' | 'UNKNOWN' required

Current status of the timesheet

commentstring

Comment on the timesheet

totalDaysinteger

Total number of days in the period

totalSubmittedDaysinteger

Number of days with submitted entries

totalApprovedDaysinteger

Number of days with approved entries

totalRejectedDaysinteger

Number of days with rejected entries

cutOffDatestring date

Cut-off date for timesheet submission

timeValueInputMethod'START_TIME_END_TIME' | 'TOTAL_HOURS' | 'UNKNOWN'

Method used for time entry input

submittedOnstring date-time

When the timesheet was submitted

approvedOnstring date-time

When the timesheet was approved

createdOnstring date-time

When the timesheet was created

updatedOnstring date-time

When the timesheet was last updated

Example response

{
  "timesheetId": "TS-001",
  "employeeId": "123e4567-e89b-12d3-a456-426614174000",
  "startDate": "2025-10-01",
  "endDate": "2025-10-31",
  "status": "APPROVED",
  "comment": "October timesheet",
  "totalDays": 31,
  "totalSubmittedDays": 22,
  "totalApprovedDays": 22,
  "cutOffDate": "2025-11-05",
  "timeValueInputMethod": "START_TIME_END_TIME",
  "totalTimeSummary": {
    "totalTimeInMinutes": 10560,
    "totalLateTimeInMinutes": 45,
    "summaryItems": [
      {
        "dayType": "REGULAR_DAY",
        "hoursType": "REGULAR_HOURS",
        "totalTimeInMinutes": 9600
      }
    ]
  },
  "entries": [
    {
      "entryId": "entry-001",
      "date": "2025-10-01",
      "status": "APPROVED",
      "dayType": "REGULAR_DAY",
      "regularTimeInMinutes": 480,
      "overtimeTotalInMinutes": 60,
      "workTimes": [
        {
          "startTime": "09:00:00",
          "endTime": "64800"
        }
      ],
      "breakTimes": [
        {
          "startTime": "09:00:00",
          "endTime": "64800"
        }
      ],
      "comment": "Regular work day",
      "submittedOn": "2025-10-01T18:30:00Z",
      "approvedOn": "2025-10-02T10:00:00Z"
    }
  ],
  "submittedOn": "2025-11-01T09:00:00Z",
  "approvedOn": "2025-11-02T14:30:00Z",
  "createdOn": "2025-10-01T00:00:00Z",
  "updatedOn": "2025-11-02T14:30:00Z"
}