Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Public API
Hours

Create or Update Hour Records

Bulk add/edit hour records. The endpoint can return HTTP 201 even when individual items fail validation; inspect each item's success flag and per-item response.message for partial failures.

OAuth Scopes: time_tracking.write

post/api/v1/timetracking/record

Request body

timeTrackingIdstring required

A unique identifier for the record. Use this ID to adjust or delete these hours. It can be any ID you use to track the record up to 36 characters in length. (i.e. UUID).

employeeIdinteger required

The ID of the employee.

divisionIdinteger

[Optional] The ID of the division for the employee.

departmentIdinteger

[Optional] The ID of the department for the employee.

jobTitleIdinteger

[Optional] The ID of the job title for the employee.

payCodestring

[Optional] Only necessary if the payroll provider requires a pay code

dateHoursWorkedstring required

The date the hours were worked. Please use the ISO-8601 date format YYYY-MM-DD.

payRatenumber

[Optional] The rate of pay. e.g. $15.00/hour should use 15.00 here. Only necessary if the payroll provider requires a pay rate.

rateTypestring required

The type of hours - regular or overtime. Please use either "REG", "OT", or "DT" here.

hoursWorkednumber required

The number of hours worked.

jobCodeinteger

[Optional] A job code.

jobDatastring

[Optional] A list of up to four 20 characters max job numbers in comma delimited format with no spaces.

Response

Returns an array of per-item results. Each item has a success boolean and a response object containing the resulting id on success, or a message describing the failure. Note: HTTP 201 is returned even when individual items fail; inspect each item's success field for partial failures.

successboolean

Indicates whether the operation was successful

Example response

{
  "response": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}