API: Clients

The client object

Attributes

id: integer

The client's unique id.

currency_id: integer

The client's currency id.

business_name: string

The client's business name.

billing_contact_name: string

The client's billing contact name. Invoices for this client will be addressed to their billing contact.

billing_email_address: string

The client's billing email address. Invoices for this client will sent to their billing email address.

billing_address: string

The client's business address. Invoices for this client will include their billing address.

shortname: string

The client's invoice prefix.

hourly_rate: decimal

The client's default hourly rate, in dollars and cents. For example: 50.0, 59.99.

active: boolean

Whether or not the client is a current client. Current clients can have invoices created for them, and time logged towards their jobs.

locale: string

The client's locale to use for invoice translations.

invoicing_threshold: decimal

The threshold at which the client is flagged as ready to invoice, in dollars and cents.

Example response

{
  "client": {
    "id": 1234,
    "currency_id": 2,
    "business_name": "Bluth Company",
    "billing_contact_name": "Geroge Bluth",
    "billing_email_address": "george@bluthcompany.com",
    "billing_address": "123 Only Drive\nSudden Valley\nCA",
    "shortname": "blu",
    "hourly_rate": "85.0",
    "active": true,
    "locale": "en",
    "invoicing_threshold": 1000
  }
}

---

List all clients

Returns a list of all of your account's clients.

Arguments
(none)

Returns
An array of client objects.

Definition

GET /v1/clients

Fetch a client

Retrieves the details of an existing client.

Arguments
(none)

Returns
A client object, if a valid id was provided.

Definition

GET /v1/clients/{CLIENT_ID}

Create a new client

Arguments

business_name: string (required)

The client's business name.

Returns
The newly created client object, if valid parameters were provided.

Definition

POST /v1/clients

Updates an existing client

Arguments
(none)

business_name: string (optional)

The client's business name.

Returns
The updated client object, if valid parameters were provided.

Definition

PUT /v1/clients/{CLIENT_ID}

Delete an existing client

Deletes an existing client, and all projects, jobs, expenses, invoices, quotes, and time logs associated with it.

Arguments
(none)

Returns
The removed client.

Definition

DELETE /v1/clients/{CLIENT_ID}