Cashboard API

« Back to Overview

Project Lists

Project Lists allow you to organize Line Items into groups within a Project

A note about permissions...

  • Administrators have access to all Project Lists within the system
  • Employees will only have access to Project lists
    that belong to projects they have access to.

List
GET /project_lists

Parameters

  • is_archived
    true returns only ARCHIVED lists
    false returns only OPEN lists
  • person_id
    Returns all lists that belong to a particular Employee or Client Contact
  • project_id
    Returns all lists that belong to a particular Project
  • updated_since
    Returns all lists last modified after the given date/time.
    Expects a CGI encoded datetime in the form of YYYY-MM-DD HH:MM:SS

New
GET /project_lists/new

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

Create
POST /project_lists

Creates a new list. Use the template provided by the NEW action.
You can also post to a Project List url

Order
PUT [project_list link 'order']

Changes the order of Project Lists and the Line Items within.
Will allow you to move items between lists if you so desire. Items must belong to the same project or the operation will fail.

Expects data like the examples below. You may send partial updates, such as one list and the items within, or just the lists you'd like ordered.

XML 

  <project_lists>
    <project_list id="1" rank="1">
      <line_items>
        <line_item id="100" rank="1" />
        <line_item id="50" rank="2" />
      </line_item>
    </project_list>
    <project_list id="2" rank="2" />
  </project_lists>

JSON 
  {
    project_lists: [
      {id: 1, rank: 1, line_items: [{id: 100, rank: 1}, {id: 50, rank: 2}]},
      {id: 2, rank: 2}
    ]
  }

Actions

Show
GET [project_list link 'self']

Returns a single list.

Update
PUT [project_list link 'self']

Updates an existing project list.

Delete
DELETE [project_list link 'self']

Deletes a project list.

Toggle Status
PUT [project_list link 'toggle_status']

Archives an open project_list, or opens an archived one.
Will also mark all Line Items within COMPLETE.

Data Reference

Write-once attributes

Project_id may only be set during list creation. 

<?xml version="1.0" encoding="UTF-8"?>
<project_list>
  <created_at></created_at>
  <is_archived read_only="true">false</is_archived>
  <person_id></person_id>
  <project_id read_only="true"></project_id>
  <rank></rank>
  <title></title>
  <updated_at read_only="true"></updated_at>
</project_list>