Cashboard API

« Back to Overview

Expenses

List
GET /expenses

Permissions

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

Parameters

  • billable
    true returns only BILLABLE expenses
    false returns only NON-BILLABLE expenses
  • category
    Returns all that belong to a specific category
  • person_id
    Returns all recorded by Employee
  • project_id
    Returns all associated with a Project
  • start_date
    Returns all created after date.
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • end_date
    Returns all created before date.
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • updated_since
    Returns all last modified after the given date/time.
    Expects a CGI encoded datetime in the form of YYYY-MM-DD HH:MM:SS

New
GET /expenses/new

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

Create
POST /expenses

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

Employee Permissions

  • Can only create expenses for themselves
  • Can only create expenses for projects they have access to
  • Can not modify the following fields
    • payee_id
    • payee_type
    • is_billable

Actions

  • Employees can only access expenses that belong to them
  • Expenses that have been invoiced may not be modified in any way

Show
GET [expense link 'self']

Returns a single expense.

Update
PUT [expense link 'self']

Updates an existing expense.

Delete
DELETE [expense link 'self']

Deletes an expense.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<expense>
  <amount>0.00</amount>
  <category></category>
  <created_on></created_on>
  <description></description>
  <invoice_line_item_id read_only="true"></invoice_line_item_id>
  <is_billable>false</is_billable>
  <payee_id></payee_id>
  <payee_type></payee_type>
  <person_id></person_id>
  <project_id></project_id>
  <updated_at read_only="true"></updated_at>
</expense>