Cashboard API

« Back to Overview

Comments

List
GET /comments

A note about permissions...

  • Cashboard Administrators and Employees can see all comments

Parameters

  • estimate_id
    Returns all recorded against an Estimate
  • invoice_id
    Returns all recorded against a Invoice
  • line_item_id
    Returns all recorded against a Line Item
  • person_id
    Returns all recorded by Employee or Client Contact
  • payment_id
    Returns all recorded against a Payment
  • 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 /comments/new

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

Create
POST /comments

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

Employee Permissions

  • Can only create comments for themselves
  • Can only create comments for resources they have access to

Actions

  • Employees can only update/delete comments that belong to them

Show
GET [comment link 'self']

Returns a single comment.

Update
PUT [comment link 'self']

Updates an existing comment.

Delete
DELETE [comment link 'self']

Deletes an comment.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<comment>
  <created_at read_only="true"></created_at>
  <commentable_id></commentable_id>
  <commentable_type></commentable_type>
  <content></content>
  <person_id></person_id>
  <updated_at read_only="true"></updated_at>
</comment>