Timesheet approval records

An approval record is the history of a specific timesheet entry’s approvals. An approval record does not exist for timesheet entries that are auto-approved or those that do not require approval. Approvals can include from 1 to 5 levels. For example, a level 1 approval might simply require a department manager's approval. A level 2 approval might require a department manager's approval followed by a department director's approval.

The approval record also includes the current approval state. Approval states are: Submitted, Pending Approval, Approved, and Declined. For more information about timesheet approval status, see Track timesheet status.

List timesheet approval records

get/objects/time/timesheet-approval-record

Returns a collection with a key, ID, and link for each timesheet approval record. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "46",
      • "id": "46",
      • "href": "/objects/time/timesheet-approval-record/46"
      },
    • {
      • "key": "44",
      • "id": "44",
      • "href": "/objects/time/timesheet-approval-record/44"
      },
    • {
      • "key": "40",
      • "id": "40",
      • "href": "/objects/time/timesheet-approval-record/40"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 5,
    • "next": 0,
    • "previous": 0
    }
}

Get a timesheet approval record

get/objects/time/timesheet-approval-record/{key}

Returns detailed information for a specified timesheet approval record.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the timesheet approval record.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "200",
    • "id": "200",
    • "href": "/objects/time/timesheet-approval-record/200",
    • "approvalStage": 1,
    • "approvalType": "Department Approval",
    • "approvalLevel": "2",
    • "comments": "Approved by Admin",
    • "recordDate": "2021-01-23",
    • "state": "submitted",
    • "timesheet": {
      • "key": "101",
      • "id": "101",
      • "href": "/objects/time/timesheet/101"
      },
    • "timesheetLine": {
      • "key": "142",
      • "id": "142",
      • "lineNumber": 3,
      • "href": "/objects/time/timesheet-line/142"
      },
    • "approvedBy": {
      • "key": "202",
      • "id": "cjackson",
      • "href": "/objects/company-config/user/202"
      },
    • "approver": {
      • "key": "203",
      • "id": "jlee",
      • "href": "/objects/company-config/user/203"
      },
    • "completedBy": {
      • "key": "204",
      • "id": "gadams",
      • "href": "/objects/company-config/user/204"
      },
    • "initiatedBy": {
      • "key": "205",
      • "id": "vluce",
      • "href": "/objects/company-config/user/205"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}