Clients

Overview

Clients are the entities that are billed. A client may have multiple projects. For instance, "Nike" may be the client, and you may have multiple contracts with them, such as "NY Times Print Ad – 002" and "Air Jordan Interactive App" – each with their own billing rates and other information.

Client Model

{
  "id": "5b85951bb7d8cf5cf9cc3b18",
  "created_at": "2018-08-28T18:31:55.985Z",
  "name": "Black Mesa",
  "address": "P.O. Box 3985, Black Mesa Drive, NM 87545",
  "phone": "1 (800) 786-1410",
  "note": "That was a joke. Fat chance.",
  "avatar_url": "http://www.bmrf.us/img/logo.png"
}

Create Client

POST /api/v2/clients HTTP/1.1
{
  "name": "Black Mesa", // Required
  "address": "P.O. Box 3985, Black Mesa Drive, NM 87545",
  "phone": "1 (800) 786-1410",
  "note": "That was a joke. Fat chance.",
  "avatar_url": "http://www.bmrf.us/img/logo.png"
}

Update Client

PUT /api/v2/clients/{id} HTTP/1.1

List Clients

GET /api/v2/clients HTTP/1.1

Optional Query Parameters

{
  "per_page": 20,
  "page": 1,
  "order_by": "name"
}

Single Client

GET /api/v2/clients/{id} HTTP/1.1

Delete/ Recover Client

DELETE /api/v2/clients/{id} HTTP/1.1
POST /api/v2/clients/{id}/recover HTTP/1.1