Cashboard API

« Back to Overview

Employees

Operations on this resource are restricted to admins only.

List
GET /employees

New
GET /employees/new

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

Create
POST /employees

Creates a new employee. Use the template provided by the NEW action.

Single Employee Actions

Show*
GET [employee link 'self']

Returns a single employee.

Update*
PUT [employee link 'self']

Updates an existing employee.

Delete*
DELETE [employee link 'self']

Deletes an employee.
Will not destroy any time entries or expenses logged for this person.

Project Assignments

List Assignments
GET [employee link 'project_assignments']

Returns all project assignments for this employee.

Manager Memberships

Gives employee extended permissions to manage client accounts when that employee is marked as a Client Account Manager by setting the correct employee_status_code. 

  <?xml version="1.0" encoding="UTF-8"?>
<manager_membership>
  <client_id></client_id>
  <client_type></client_type>
  <person_id></person_id>
  <created_at read_only="true"></created_at>
  <updated_at read_only="true"></updated_at>
</manager_membership>

List
GET [employee link 'manager_memberships']

Returns all manager memberships

Create
POST [employee link 'manager_memberships']

Creates new account manager membership

Delete
DELETE [membership link 'self']

Deletes a client manager membership

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<employee>
  <last_login read_only="true"></last_login>
  <login_count read_only="true">0</login_count>
  <updated_at read_only="true"></updated_at>
  <address></address>
  <address2></address2>
  <city></city>
  <country_code></country_code>
  <custom_1></custom_1>
  <custom_2></custom_2>
  <custom_3></custom_3>
  <email_address></email_address>
  <employee_status_code read_only="true">0</employee_status_code>
  <first_name></first_name>
  <is_archived>false</is_archived>
  <last_name></last_name>
  <notes></notes>
  <password></password>
  <state></state>
  <telephone></telephone>
  <url></url>
  <zip></zip>
</employee>

COUNTRY_CODES

Must be a valid ISO 3166 country code.

EMPLOYEE_STATUS_CODES

Read-only for non-admins. You're able to set it via the API on this resource.
Should be one of the following.