Toggle Sidebar

Customers

In TrackingTime, you can assign projects to customers, so that at the end of the day you know how much time your company worked for each of your customers.

Available Endpoints

Parameters

Type Parameter Description Required
Integer id Read only
String name A human readable identifier. UNIQUE
Boolean is_archived Indicates whether a customer is archived or not. Default: false NO
String notes Some text. Anything you want to include here will be fine. NO
String contact_name Your contact person at the customer's company. NO
String contact_email Used to send invoices to this customer. NO
String contact_notes Some text. Anything you want to include here will be fine. NO
Double worked_hours The total number of hours worked for this customer. Read only
Double worked_hours_today The total number of hours worked for this customer today. Read only
Double worked_hours_this_week The total number of hours worked for this customer this week. Read only
Double worked_hours_this_month The total number of hours worked for this customer this month. Read only
Integer total_projects The total number of projects for this customer. Read only
Integer archived_projects The total number of archived projects for this customer. Read only
Integer active_projects The total number of active projects for this customer. Read only

JSON Object

{  
 "name": "Acme, Inc.",
 "notes": "",
 "contact": null,
 "is_archived": true,
 "worked_hours": 69.89,
 "loc_worked_hours": "69:53",
 "total_projects": 1,
 "archived_projects": 1,
 "active_projects": 0,
 "average_hourly_rate": null,
 "worked_hours_today": 0.0,
 "worked_hours_this_week": 0.0,
 "worked_hours_this_month": 0.0,
 "loc_worked_hours_today": "00:00",
 "loc_worked_hours_this_week": "00:00",
 "loc_worked_hours_this_month": "00:00",
 "id": 3029,
 "created_at": null,
 "updated_at": "2015-11-21 21:47:41"
}

Endpoints

List Customers

List all account customers. This action has no parameters.


Endpoint

https://app.trackingtime.co/api/v4/customers

Parameters

Type Parameter Description Required
String filter [ALL | ACTIVE | ARCHIVED]. Default = ACTIVE NO

Permissions

  • Only admins and project managers can view customers

Get Customer

Retrieve a single customer by id. If no object is found you'll get a 500 response code.


Endpoint

https://app.trackingtime.co/api/v4/customers/:id

Permissions

  • Only admins and project managers can view customers

Add Customer

Add a new customer. You must enter all required parameters.


Endpoint

https://app.trackingtime.co/api/v4customers/add

Permissions

  • Only admins and project managers can add new customers

Update Customer

Update an existing customer. You only need to enter the parameters your want to update.


Endpoint

https://app.trackingtime.co/api/v4customers/update/:id

Permissions

  • Only admins and project managers can update customers

Delete Customer

Delete an existing customer. All project references to the deleted object will be set to null.


Endpoint

https://app.trackingtime.co/api/v4customers/delete/:id

Permissions

  • Only admins and project managers can delete customers

Archive / Re-activate Customer

You can archive an re-open your customers any time.

Endpoint

https://app.trackingtime.co/api/v4/customers/close/:id to archive the customer with the given id

https://app.trackingtime.co/api/v4/customers/open/:id to re-activate the customer with the given id

Permissions

  • Only admins and project managers can archive and re-activate customers