Approve timecards

In this tutorial, we approve an employee's timecard and view employee timecard approvals.

Approve an employee timecard

The manager calls the Approve Timecard as Manager operation using the POST HTTP method to approve an employee's timecard.

  1. POST a request to the following URL: https://<<hostName>>/api/v1/timekeeping/timecard_approvals
  2. Include the standard Headers.
  3. Include an appropriate JSON call body. Refer to the examples below.

Example request

{
  "dateRange": {
    "endDate": "2018-02-04",
    "startDate": "2018-01-22"
  },
  "employee": {
    "id": 308
  }
}

Example response

[
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-22",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-23",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-24",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-25",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-26",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-27",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-28",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-29",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-30",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-31",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-01",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-02",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-03",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-04",
        "enteredOnDTM": "2018-02-08T17:10:47"
    }
]

View employee timecard approvals

The manager calls the Retrieve Timecard Approvals as Manager operation using the GET HTTP method to view an employee's timecard approvals.

  1. Send a GET request to the following URL: https://<<hostName>>/api/v1/timekeeping/timecard_approvals
  2. Include the standard Headers.
  3. Include the following Query Parameters:
    • employee_id : <<employeeId>>
    • start_date : <<start date in YYYY-MM-DD>>
    • end_date : <<end date in YYYY-MM-DD>>

Note: A symbolic_period or symbolic_period_id can be provided instead of a date range. The date range, symbolic period, and symbolic period ID are all mutually exclusive, but one is required.

Example response

[
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-22",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-23",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-24",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-25",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-26",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-27",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-28",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-29",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-30",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-01-31",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-01",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-02",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-03",
        "enteredOnDTM": "2018-02-08T17:10:47"
    },
    {
        "isEmployeeApproved": false,
        "employee": {
            "id": 308,
            "qualifier": "10027"
        },
        "approvingManager": {
            "id": 8,
            "qualifier": "SEANIVAN"
        },
        "approvalDate": "2018-02-04",
        "enteredOnDTM": "2018-02-08T17:10:47"
    }
]