Cashboard API

« Back to Overview

Payments

Operations on this resource are restricted to admins only.

List
GET /payments

Parameters

  • client_id / client_type
    client_id is an id of either a Client Company or Client Contact.
    client_type must be set to either 'Company' (Client Company) or 'Person' (Client Contact) if client_id is set.
  • low_amount
    Returns all payments with an amount >= the amount given
  • high_amount
    Returns all payments with an amount <= the amount given
  • start_date
    Returns all payments with a created_on date AFTER the one given
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • end_date
    Returns all payments with a created_on date BEFORE the one given
    Expects a CGI encoded date in the form of YYYY-MM-DD
  • updated_since
    Returns all payments last modified after the given date/time
    Expects a CGI encoded datetime in the form of YYYY-MM-DD HH:MM:SS

New
GET /payments/new

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

Create
POST /payments

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

Actions

Show
GET [payment link 'self']

Returns a single payment.

Can return payment in a variety of formats,
including HTML and PDF as you'd see in the Cashboard web UI.

Supported Content Types

  • application/xml
  • application/pdf
  • text/html

Update
PUT [payment link 'self']

Updates a payment.

Delete
DELETE [payment link 'self']

Deletes a payment and all comments associated with it.

List Invoices
GET [payment link 'invoices']

Returns all invoice payments associated with this payment.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<payment>
  <amount rel="financial">0.00</amount>
  <assigned_id></assigned_id>
  <client_id></client_id>
  <client_type></client_type>
  <comments_count read_only="true">0</comments_count>
  <created_on></created_on>
  <document_template_id></document_template_id>
  <notes></notes>
  <person_id></person_id>
  <transaction_id></transaction_id>
  <updated_at read_only="true"></updated_at>
</payment>