Cashboard API

« Back to Overview

Account

New
GET /account/new

No authentication required.

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

Create
POST /accounts

No authentication required.

Unlike other services, we actually allow you to create accounts via the API.

This enables you to write client applications that require no interaction
with the Cashboard web interface to get set up.

Creates a new Cashboard account. Use the template provided by the NEW action.

Returns information about the account upon success, including user information for the account owner.

Show
GET /account

Shows Cashboard account information and preferences.

Note
This will include information for "current_user" as well, which would be the user who's authenticated the request. We include this information here so you only have to make one request to setup any 3rd party client preferences and restrict access to features based on account level.

Update
PUT /account

Updates account, owner, and company information.

Authenticate
POST /account/auth

Allows you to fetch an API KEY by passing in a customer's email address, password, and Cashboard subdomain.

API clients should NOT store email addresses or passwords. Instead, use this action to retrieve a customer's API key, then store that information for authentication.

Successful posts will return API KEY in the response body. Failures will return a 401 response with nothing else.

XML 

 <user>
   <email_address></email_address>
   <password></password>
   <subdomain></subdomain>
 </user>

JSON 
 {
   user: {
     email_address: '',
     password: '',
     subdomain: ''
   }
 }

Data Reference

Write-once attributes

Subdomain and referrer may only be set during account creation.
They may not be modified by update requests.

If you wish to get credit for referred accounts, be sure to set referrer to your own Cashboard subdomain. If we implement a referral program with payouts in the future we will use this as an identifier. 

<?xml version="1.0" encoding="UTF-8"?>
<account>
  <created_at read_only="true"></created_at>
  <currency_type_code>USD</currency_type_code>
  <currency_symbol read_only="true">$</currency_symbol>
  <date_format>mm/dd/yyyy</date_format>
  <expenses_billable>true</expenses_billable>
  <is_disabled read_only="true">false</is_disabled>
  <next_payment_date read_only="true"></next_payment_date>
  <referrer read_only="true"></referrer>
  <round_time_to_nearest_minutes>1</round_time_to_nearest_minutes>
  <subdomain read_only="true"></subdomain>
  <time_entries_billable>true</time_entries_billable>
  <use_number_format_usa>true</use_number_format_usa>
  <owner>
    <id></id>
    <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>
    <default_bill_rate>0.00</default_bill_rate>
    <default_pay_rate>0.00</default_pay_rate>
    <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>
  </owner>
  <company>
    <id></id>
    <name></name>
    <address></address>
    <address2></address2>
    <city></city>
    <state></state>
    <zip></zip>
    <country_code></country_code>
    <url></url>
    <telephone></telephone>
    <notes></notes>
    <custom_1></custom_1>
    <custom_2></custom_2>
    <custom_3></custom_3>
  </company>
</account>