Cashboard API

« Back to Overview

Client Contacts

Client Contacts are people that you may assign resources to inside Cashboard.
Resources being things like estimates, invoices, payments, and projects.

Client Contacts may also belong to Client Companies,
which allow you to assign resources to multiple people at once.

Operations on this resource are restricted to admins only.

List
GET /client_contacts

New
GET /client_contacts/new

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

Create
POST /client_contacts

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

Actions

Show
GET [client_contact link 'self']

Returns a single client contact.

Update
PUT [client_contact link 'self']

Updates an existing client contact.

Delete
DELETE [client_contact link 'self']

Deletes a client contact.

Be aware that deleting a Client Contact will also destroy ALL RESOURCES assigned directly to them.

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_contact link 'memberships']

Lists all company memberships for this client

New
GET [client_contact link 'memberships']/new

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

Create
POST [client_contact 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_contact>
  <api_key read_only="true"></api_key>
  <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>
  <currency_type_code></currency_type_code>
  <custom_1></custom_1>
  <custom_2></custom_2>
  <custom_3></custom_3>
  <email_address></email_address>
  <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>
</client_contact>

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.