Timesheet Settings API

List timesheet settings

List all timesheet settings for an account:

GET /timesheet_settings

Response

Status: 200 OK
[
  {
    "id": 321,
    "sourceID": null,
    "name": "8hr workday, 40hr workweek, hours&minutes, 1hr incr.",
    "created_at": "2016-03-22T21:03:35-05:00",
    "updated_at": "2016-03-22T21:03:35-05:00"
  },
  {
    "id": 485,
    "sourceID": null,
    "name": "7:30 workday, 36hr workweek, hours&minutes, 0:30 incr.",
    "created_at": "2016-03-27T18:53:12-05:00",
    "updated_at": "2016-03-28T22:56:03-05:00"
  },
  "..."
]

The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of timesheet settings.

States

The following states are available:

Collection Fields

By default the following fields will appear in collections of timesheet settings:

id sourceID name created_at updated_at

Obtain a different set of fields using the ?fields= parameter.

Sorting

By default a collection of timesheet settings is sorted ascending by name.

The following fields are accepted by the ?sort= parameter:

id sourceID name created_at updated_at

Get a single timesheet settings

GET /timesheet_settings/:id

Response

Status: 200 OK
{
  "disabled": false,
  "allocation_time_tracking": true,
  "allow_workday_overtime": false,
  "allow_workweek_overtime": false,
  "assignment_time_tracking": true,
  "id": 485,
  "name": "7:30 workday, 36hr workweek, hours&minutes, 0:30 incr.",
  "percentage_increment": null,
  "source": null,
  "sourceID": null,
  "time_increment": 30,
  "track_cost_of_time_spent": false,
  "unit": "hours_and_minutes",
  "workday": 450,
  "workweek": 2160,
  "created_at": "2016-03-27T18:53:12-05:00",
  "updated_at": "2016-03-28T22:56:03-05:00"
}

The response contains these fields.

Create a timesheet settings

POST /timesheet_settings

When creating a new timesheet settings these fields are available.

Response

Status: 201 Created
{
  "coverage": "...",
  "...": "..."
}

The response contains all fields of the created timesheet settings and is similar to the response in Get a single timesheet settings

Update a timesheet settings

PATCH /timesheet_settings/:id

When updating a timesheet settings these fields are available.

Response

Status: 200 OK
{
  "name": "...",
  "...": "..."
}

The response contains all fields of the updated timesheet settings and is similar to the response in Get a single timesheet settings

Fields

allocation_time_tracking
Optional boolean, default: true — The Allocation time tracking box is checked when people of the related organizations need to be able to register time entries for the time allocations that are linked to their organizations.
allow_workday_overtime
Optional boolean, default: true — The Allow workday overtime box is checked when the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single day than the amount of time specified in the Workday field.
allow_workweek_overtime
Optional boolean, default: true — The Allow workweek overtime box is checked when the people of the organizations to which the timesheet settings are linked are allowed to register more time for a single week than the amount of time specified in the Workweek field.
assignment_time_tracking
Optional boolean, default: true — The Assignment time tracking box is checked when the Time spent field needs to be available in requests, problems and tasks for specialists of the related organizations to specify how long they have worked on their assignments.
created_at
Readonly datetime — The date and time at which the timesheet settings was created.
disabled
Optional boolean, default: false — The Disabled box is checked when the timesheet settings may no longer be related to any more organizations.
id
Readonly integer — The unique ID of the timesheet settings.
name
Required string (max 160) — The Name field is used to enter the name of the timesheet settings.
percentage_increment
Optional enum, default: 12.5 — The Percentage Increment field is used to select the minimum amount percentage of a workday that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This percentage of a workday is also the increment by which they can increase this minimum percentage of a workday. Valid values are:
  • 12.5: 12.5%
  • 25: 25%
  • 50: 50%
  • 100: 100%
source
Optional string (max 30) - See source
sourceID
Optional string (max 128) - See source
time_increment
Optional integer, default: 60 — The Time Increment field is used to select the minimum amount of time that the people of the organizations to which the timesheet settings are linked can select when they register a time entry. This amount of time is also the increment by which they can increase this minimum amount of time.
track_cost_of_time_spent
Optional boolean, default: true — The Track cost of time spent box is checked when the Cost per hour field needs to be available on the Person form and the value in this field needs to be used to calculate the cost of the time people enter in the Time spent field of requests, problems and tasks, and in their time entries.
unit
Required enum, default: hours_and_minutes — The Unit field is used to specify whether the people of the organizations to which the timesheet settings are linked need to register their time in hours and minutes, or as a percentage of a workday. Valid values are:
  • hours_and_minutes: Hours & Minutes
  • percentage_of_workday: Percentage of Workday
updated_at
Readonly datetime — The date and time of the last update of the timesheet settings. If the timesheet settings has no updates it contains the created_at value.
workday
Optional integer, default: 480 — The Workday field is used to specify the duration of a workday in minutes.
workweek
Optional integer, default: 2400 — The Workweek field is used to specify the duration of a workweek in minutes.