Connectors Reference

Harvest

Harvest is a simple tool to help track the time spent by your team on each project and task.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ListAllContacts ()

List all contacts

AddNewContact (AddNewContactParameterBody body)

Add new contact

ListAllClients ()

List all clients

AddNewClient (AddNewClientParameterBody body)

Add new client

ListAllUsers ()

List all users

CreateUser (CreateUserParameterBody body)

Add new user

UpdateTimeEntry (string DAY_ENTRY_ID, UpdateTimeEntryParameterBody body)

Update time entry

CreateTimeEntry (CreateTimeEntryParameterBody body)

Create time entry

ListProjects ()

List projects

DeleteTimeEntry (string DAY_ENTRY_ID)

Delete time entry

AddUserToProject (string project_id, AddUserToProjectParameterBody body)

Add user to a project

GetTimeEntry (string DAY_ENTRY_ID)

Get time entry by id

ListTasks ()

List tasks

GetUser (string USERID)

Get user info

 

Triggers:

Name

Summary

TrigNewUser ()

When a user is added

TrigNewClient ()

When a client is added

TrigNewContact ()

When a contact is added

TrigNewProject ()

When a project is created

TrigNewTimeEntryToday ([Optional]string of_user)

When a time entry is created for the current day

TrigNewTimeEntry (string date, [advanced][Optional]string of_user)

When a time entry is created for date

 

Objects:

Name

Summary

AddNewClientParameterBody

 

AddNewContactParameterBody

 

AddUserToProjectParameterBody

 

CreateTimeEntryParameterBody

 

CreateUserParameterBody

 

GetTimeEntriesForDay_Response

 

GetUserByID_Response

 

ListTasksResponseItem

 

TrigNewClientResponseItem

 

TrigNewContactResponseItem

 

TrigNewProjectResponseItem

 

UpdateTimeEntryParameterBody

 

UpdateTimeEntry_Response

 

 

Actions:

ListAllContacts

Summary: List all contacts

Description: Retrieves a list of all contacts for the authenticated user.

 

Syntax:

Harvest.ListAllContacts ()

 

Returns:

          Type:array of (TrigNewContactResponseItem)

 

AddNewContact

Summary: Add new contact

Description: Create a new contact.

 

Syntax:

Harvest.AddNewContact (AddNewContactParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

AddNewContactParameterBody

 

 

True

 

Returns:

 

ListAllClients

Summary: List all clients

Description: Retrieves a list of all clients for the authenticated account.

 

Syntax:

Harvest.ListAllClients ()

 

Returns:

          Type:array of (TrigNewClientResponseItem)

 

AddNewClient

Summary: Add new client

Description: Create a new client.

 

Syntax:

Harvest.AddNewClient (AddNewClientParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

AddNewClientParameterBody

 

 

True

 

Returns:

 

ListAllUsers

Summary: List all users

Description: Retrieves a list of all users of the authenticated account.

 

Syntax:

Harvest.ListAllUsers ()

 

Returns:

          Type:array of (GetUserByID_Response)

 

CreateUser

Summary: Add new user

Description: Create a new user.

 

Syntax:

Harvest.CreateUser (CreateUserParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateUserParameterBody

 

 

True

 

Returns:

 

UpdateTimeEntry

Summary: Update time entry

Description: Update an existing time entry.

 

Syntax:

Harvest.UpdateTimeEntry (string DAY_ENTRY_ID, UpdateTimeEntryParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

DAY_ENTRY_ID

string

(Time Entry Id)

 

True

body

UpdateTimeEntryParameterBody

 

 

True

 

Returns:

          Type:UpdateTimeEntry_Response

 

CreateTimeEntry

Summary: Create time entry

Description: Create a new time entry.

 

Syntax:

Harvest.CreateTimeEntry (CreateTimeEntryParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateTimeEntryParameterBody

 

 

True

 

Returns:

          Type:UpdateTimeEntry_Response

 

ListProjects

Summary: List projects

Description: Lists all projects for the current user.

 

Syntax:

Harvest.ListProjects ()

 

Returns:

          Type:array of (TrigNewProjectResponseItem)

 

DeleteTimeEntry

Summary: Delete time entry

Description: Delete an existing time entry.

 

Syntax:

Harvest.DeleteTimeEntry (string DAY_ENTRY_ID)

 

Parameters:

Name

Type

Summary

Required

Related Action

DAY_ENTRY_ID

string

(Time Entry Id)

 

True

 

Returns:

 

AddUserToProject

Summary: Add user to a project

Description: Add an existing user to a project.

 

Syntax:

Harvest.AddUserToProject (string project_id, AddUserToProjectParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

Project Id

True

ListProjects

body

AddUserToProjectParameterBody

 

 

True

 

Returns:

 

GetTimeEntry

Summary: Get time entry by id

Description: Get an existing time entry by id.

 

Syntax:

Harvest.GetTimeEntry (string DAY_ENTRY_ID)

 

Parameters:

Name

Type

Summary

Required

Related Action

DAY_ENTRY_ID

string

(Time Entry Id)

 

True

 

Returns:

          Type:UpdateTimeEntry_Response

 

ListTasks

Summary: List tasks

Description: Retrieves a list of all tasks.

 

Syntax:

Harvest.ListTasks ()

 

Returns:

          Type:array of (ListTasksResponseItem)

 

GetUser

Summary: Get user info

Description: Retrieve a user's details by user id or email.

 

Syntax:

Harvest.GetUser (string USERID)

 

Parameters:

Name

Type

Summary

Required

Related Action

USERID

string

(User id or email)

User id or email

True

 

Returns:

          Type:GetUserByID_Response

 

Triggers:

Trigger TrigNewUser

Summary: When a user is added

Description: Triggers when a new user is added.

 

Syntax:

Harvest.TrigNewUser ()

 

Returns:

          Type:array of (GetUserByID_Response)

 

Trigger TrigNewClient

Summary: When a client is added

Description: Triggers when a new client is added.

 

Syntax:

Harvest.TrigNewClient ()

 

Returns:

          Type:array of (TrigNewClientResponseItem)

 

Trigger TrigNewContact

Summary: When a contact is added

Description: Triggers when a new contact is added.

 

Syntax:

Harvest.TrigNewContact ()

 

Returns:

          Type:array of (TrigNewContactResponseItem)

 

Trigger TrigNewProject

Summary: When a project is created

Description: Triggers when a new project is created.

 

Syntax:

Harvest.TrigNewProject ()

 

Returns:

          Type:array of (TrigNewProjectResponseItem)

 

Trigger TrigNewTimeEntryToday

Summary: When a time entry is created for the current day

Description: Triggers when a new time entry is created for the current day.

 

Syntax:

Harvest.TrigNewTimeEntryToday ([Optional]string of_user)

 

Parameters:

Name

Type

Summary

Required

Related Action

of_user

string

(Other User ID)

The id of the user to check time entries for. Defaults to your id.

False

ListAllUsers

 

Returns:

          Type:GetTimeEntriesForDay_Response

 

Trigger TrigNewTimeEntry

Summary: When a time entry is created for date

Description: Triggers when a new time entry is created for a specific date.

 

Syntax:

Harvest.TrigNewTimeEntry (string date, [advanced][Optional]string of_user)

 

Parameters:

Name

Type

Summary

Required

Related Action

date

string

(Date)

YYYY-MM-DD or ISO format datetime

True

of_user

string

(Other User ID)

The id of the user to check time entries for.

False

ListAllUsers

 

Returns:

          Type:GetTimeEntriesForDay_Response

 


 

AddNewClientParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

client

Client

 

 

 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Client's name

active

boolean

 

 

currency

string

Currency

The currency you'd like to use for the client.

currency_symbol

string

Currency symbol

Symbol that correlates to the selected currency.

details

string

Details

Additional details, normally used for address information.

 


 

AddNewContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

contact

Contact

 

contact

 

Contact

Summary:

Description: contact

 

          Properties:

Name

Type

Summary

client_id

integer(int32)

Client id

Unique identifier of the client.

first_name

string

First name

Contact's first name.

last_name

string

Last name

Contact's last name.

email

string

Email

Contact's email.

phone_office

string

Office phone

Contact's office phone.

phone_mobile

string

Mobile phone

Contact's mobile phone.

fax

string

Fax

Contact's fax.

title

string

Title

Contact's title.

 


 

AddUserToProjectParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

user

User

 

 

 

User

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

User Id

User

 


 

CreateTimeEntryParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

notes

string

 

 

hours

integer(int32)

 

 

project_id

string

Project Id

Project

task_id

string

Task Id

Task

spent_at

string

Date

Spent at


 

CreateUserParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

user

User

 

 

 

User

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Email

 

is_admin

boolean

Is admin

 

first_name

string

First name

 

last_name

string

Last name

 

is_contractor

boolean

Is contractor

 

telephone

string

Phone

 

is_active

boolean

 

 

has_access_to_all_future_projects

boolean

 

 

default_hourly_rate

number(float)

Hourly rate

Default hourly rate.

department

string

Department

 

cost_rate

number(float)

Cost rate

 

timezone

string

 

 

 


 

GetTimeEntriesForDay_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

day_entries

array of (Day_entriesItem)

day_entries

day_entries

for_day

string

for_day

for_day

 

Day_entriesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

project_id

string

Project id

Unique identifier of the porject.

project

string

Project name

Name of the project.

user_id

integer(int32)

User id

Unique identifier of the user.

spent_at

string

Date

YYYY-MM-DD

task_id

string

Task id

Id of task the time entry is associated with.

task

string

Task

Name of task the time entry is associated with.

client

string

Client

Name of client the time entry is associated with.

id

integer(int32)

Time entry id

Unique identifier of the time entry.

notes

string

Notes

Time entry notes.

started_at

string

Started date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

ended_at

string

Ended date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

hours_without_timer

number(float)

Hours without timer

Current amount of time tracked, if timer is not running.

hours

number(float)

Hours

Number of (decimal time) hours tracked in this time entry.

 


 

GetUserByID_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

user

User

 

 

 

User

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

User id

Unique identifier of the user.

email

string

Email

User's email.

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

is_admin

boolean

Is admin

True if the user is an admin.

first_name

string

First name

User's first name.

last_name

string

Last name

User's last name.

timezone

string

 

 

is_contractor

boolean

Is contractor

True if the user is a contractor.

telephone

string

Phone

User's phone.

is_active

boolean

Is active

True if the user is currently active.

has_access_to_all_future_projects

boolean

 

 

default_hourly_rate

number(float)

Hourly rate

User's hourly rate

department

string

Department

Department name the user works in.

wants_newsletter

boolean

Newsletter subscription

True if the user wants to subscribe to the newsletter.

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC  format).

cost_rate

number(float)

Cost rate

User's cost rate.

weekly_capacity

integer(int32)

Weekly capacity

User's weekly capacity.

 


 

ListTasksResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

task

Task

 

 

 

Task

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Task id

Unique identifier of the task.

name

string

Name

Task name.

billable_by_default

boolean

internal

 

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC).

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC).

is_default

boolean

 

 

default_hourly_rate

number(float)

Default hourly rate

Default rate for the task.

deactivated

boolean

 

 

 


 

TrigNewClientResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

client

Client

 

 

 

Client

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Client id

Unique identifier of the client.

name

string

Name

Client's name.

active

boolean

 

 

currency

string

Currency

Currency to use for client billing.

cache_version

integer(int32)

 

 

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

statement_key

string

 

 

default_invoice_kind

string

 

 

default_invoice_timeframe

string

 

 

address

string

Address

Client's address.

currency_symbol

string

Currency symbol

Symbol that correlates to the selected currency.

details

string

Details

Additional details, normally used for address information.

last_invoice_kind

string

 

 

 


 

TrigNewContactResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

contact

Contact

 

contact

 

Contact

Summary:

Description: contact

 

          Properties:

Name

Type

Summary

id

integer(int32)

Contact id

Unique identifier of the contact.

client_id

integer(int32)

Client id

Unique identifier of the client.

first_name

string

First name

Contact's first name.

last_name

string

Last name

Contact's last name.

email

string

Email

Contact's email.

phone_office

string

Office phone

Contact's office phone.

phone_mobile

string

Mobile phone

Contact's mobile phone.

fax

string

Fax

Contact's fax.

title

string

Title

Contact's title.

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

 


 

TrigNewProjectResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

project

Project

 

 

 

Project

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project id

Unique identifier of the project.

client_id

integer(int32)

Client id

Id of client for the project.

name

string

Name

Project name.

code

string

Code

Project code.

active

boolean

Is active

True if the project is currently active.

billable

boolean

Is billable

True if the project is billable.

bill_by

string

Bill by

Method by which the project is invoiced.

hourly_rate

string

Hourly rate

Billing rate by the hour.

budget

string

Budget

Budget value for the project.

budget_by

string

Budget by

Budgeting method for the project.

notify_when_over_budget

boolean

 

 

over_budget_notification_percentage

number(float)

 

 

over_budget_notified_at

string

 

 

show_budget_to_all

boolean

 

 

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

starts_on

string

Start date

YYYY-MM-DD

ends_on

string

End date

YYYY-MM-DD

estimate

string

Estimate

Project estimate.

estimate_by

string

Estimated by

Method of estimation for project.

hint_earliest_record_at

string

Earliest record date

YYYY-MM-DD

hint_latest_record_at

string

Latest record date

YYYY-MM-DD

notes

string

Notes

Project notes.

cost_budget

string

Cost budget

Budget value for Total Project Fees projects.

cost_budget_include_expenses

boolean

Cost budget includes expenses

Option for budget of Total Project Fees projects to include tracked expenses.

 


 

UpdateTimeEntryParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

project_id

string

Project Id

Project

task_id

string

Task Id

Task

notes

string

Notes

 

started_at

string

Started date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

ended_at

string

Ended date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

spent_at

string

Date

YYYY-MM-DDThh:mm:ssZ (UTC format).


 

UpdateTimeEntry_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Time entry id

Unique identifier of the time entry.

user_id

integer(int32)

User id

Unique identifier of the user who created the time entry.

spent_at

string

Date

Date of time entry.

created_at

string(date-time)

Created date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

updated_at

string(date-time)

Updated date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

project_id

string

Project id

Id of the project time entry is associated with.

task_id

string

Task id

Id of the task time entry is associated with.

project

string

Project

Name of project the time entry is associated with.

task

string

Task

Name of task the time entry is associated with.

client

string

Client

Name of client the time entry is associated with.

notes

string

Notes

Time entry notes.

hours_without_timer

number(float)

Hours without timer

Current amount of time tracked, if timer is not running.

hours

number(float)

Hours

Number of (decimal time) hours tracked in this time entry.