Cashboard API

« Back to Overview

Client Companies

Client Companies allow you to group Client Contacts into organizations.

You can assign resources to Client Companies if you wish for all people in that company to access them.
Resources being things like estimates, invoices, payments, and projects.

Operations on this resource are restricted to admins only.

List
GET /client_companies

New
GET /client_companies/new

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

Create
POST /client_companies

Creates a new client company. Use the template provided by the NEW action.

Actions

Show
GET [client_company link 'self']

Returns a single client company.

Update
PUT [client_company link 'self']

Updates an existing client company.

Delete
DELETE [client_company link 'self']

Deletes a client company.

Be aware that deleting a Client Company will also destroy ALL RESOURCES assigned directly to it.

Company Memberships

Company memberships assign a Contact to a Client Company. 

<?xml version="1.0" encoding="UTF-8"?>
<company_membership>
  <person_id></person_id>
  <company_id></company_id>
</company_membership>

List
GET [client_company link 'memberships']

Lists all company memberships for this client

New
GET [client_company link 'memberships']/new

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

Create
POST [client_company link 'memberships']

Assign a client contact to a company.

Delete
DELETE [company_membership link 'self']

Removes the association between a contact and their company.

Data Reference

<?xml version="1.0" encoding="UTF-8"?>
<client_company>
  <name></name>
  <address></address>
  <address2></address2>
  <city></city>
  <state></state>
  <zip></zip>
  <country_code></country_code>
  <url></url>
  <telephone></telephone>
  <currency_type_code></currency_type_code>
  <notes></notes>
  <custom_1></custom_1>
  <custom_2></custom_2>
  <custom_3></custom_3>
  <is_archived>false</is_archived>
</client_company>

COUNTRY_CODES

Must be a valid ISO 3166 country code.

CURRENCY_TYPE_CODES

Available values are ISO 4217 currency codes.
Sets the currency that will be shown to your clients in their Cashboard UI and sent documents.