Cashboard API

« Back to Overview

Time Entries

List
GET /time_entries

Parameters

  • billable
    true returns only BILLABLE entries
    false returns only NON-BILLABLE entries
  • line_item_id
    Returns all time entries associated with the Line Item
  • person_id
    Returns all time entries associated with the Employee
  • project_id
    Returns all time entries associated with the Project
  • start_date
    Returns all time entries created after date.
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • end_date
    Returns all time entries created before date.
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • updated_since
    Returns all time entries last modified after the given date/time.
    Expects a CGI encoded datetime in the form of YYYY-MM-DD HH:MM:SS

Permissions

  • Cashboard Administrators can see all time entries in the account
  • Employees will only see their own time entries

New
GET /time_entries/new

Returns a data template that you can fill in to use the CREATE action.

Create
POST /time_entries

Creates a new time entry. Use the template provided by the NEW action.

Starting / Stopping timers

Creating a new entry with blank values for the minutes and hours will start the timer on the newly created entry.
If a currently running timer is stopped during this process it will be returned in the response data.

Employee Permissions

  • Can only create entries for themselves
  • Can only create entries for projects they have access to
  • Can't set the is_billable field

Actions

  • Employees can only access time entries that belong to them
  • Time Entries that have been invoiced or belong to a closed project may not be modified in any way

Show
GET [time_entry link 'self']

Returns a single time entry.

Update
PUT [time_entry link 'self']

Updates a time entry.

Delete
DELETE [time_entry link 'self']

Deletes a time entry.

Toggle Timer
PUT [time_entry link 'toggle_timer']

Starts or stops a timer running for the selected time entry.
If another time entry's timer was stopped because of this action it will be returned in the data.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<time_entry>
  <created_on></created_on>
  <updated_at read_only="true"></updated_at>
  <description></description>
  <invoice_line_item_id read_only="true"></invoice_line_item_id>
  <is_billable>false</is_billable>
  <is_running read_only="true">false</is_running>
  <line_item_id>0</line_item_id>
  <minutes>0</minutes>
  <minutes_with_timer read_only="true">0</minutes_with_timer>
  <person_id></person_id>
  <timer_started_at read_only="true"></timer_started_at>
</time_entry>

Field notes
minutes_with_timer contains stored minutes plus however long the timer has been running.