Harvest

Node: harvest · Full type: n8n-nodes-base.harvest · Version: 1

Credentials

harvestApi (alias: @harvest) / harvestOAuth2Api (alias: @harvest)

CREDENTIAL @harvest = harvestApi "My Harvest"

Operations

Resource: client

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: address, currency, is_active

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: is_active, updated_since

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: address, currency, is_active, name

Resource: company

get

No additional parameters.

Resource: contact

create

Parameter	Type	Default	Details
firstName	string	""	required
clientId	string	""	required
additionalFields	collection	{}	keys: email, fax, last_name, phone_mobile, phone_office, title

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: is_active, updated_since

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: client_id, email, fax, first_name, last_name, phone_mobile, ...

Resource: estimate

create

Parameter	Type	Default	Details
clientId	string	""	required
additionalFields	collection	{}	keys: currency, over_budget_notification_percentage, issue_date, notes, number, purchase_order, ...

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: client_id, from, state, to, updated_since, page

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: client_id, currency, over_budget_notification_percentage, issue_date, number, notes, ...

Resource: expense

create

Parameter	Type	Default	Details
projectId	string	""	required
expenseCategoryId	string	""	required
spentDate	dateTime	""	required
additionalFields	collection	{}	keys: billable, notes, total_cost, units, user_id

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: client_id, from, is_billed, page, project_id, to, ...

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: billable, expense_category_id, notes, project_id, spent_date, total_cost, ...

Resource: invoice

create

Parameter	Type	Default	Details
clientId	string	""	required
additionalFields	collection	{}	keys: currency, over_budget_notification_percentage, ends_on, estimate_id, issue_date, notes, ...

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: client_id, from, page, project_id, state, to, ...

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: client_id, currency, over_budget_notification_percentage, ends_on, estimate_id, issue_date, ...

Resource: project

create

Parameter	Type	Default	Details
name	string	""	required
clientId	string	""	required
isBillable	boolean	true	required
billBy	options	"none"	required; none, People, Project, Tasks
budgetBy	string	"none"	required
additionalFields	collection	{}	keys: budget, budget_is_monthly, cost_budget, cost_budget_include_expenses, ends_on, fee, ...

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: client_id, is_active, page, updated_since

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: bill_by, budget, budget_by, budget_is_monthly, client_id, cost_budget, ...

Resource: task

create

Parameter	Type	Default	Details
name	string	""	required
additionalFields	collection	{}	keys: billable_by_default, default_hourly_rate, is_active, is_default

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: is_active, page, updated_since

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: billable_by_default, default_hourly_rate, is_active, is_default, name

Resource: timeEntry

createByDuration

Parameter	Type	Default	Details
projectId	string	""	required
taskId	string	""	required
spentDate	dateTime	""	required
additionalFields	collection	{}	keys: hours, notes, user_id

createByStartEnd

Parameter	Type	Default	Details
projectId	string	""	required
taskId	string	""	required
spentDate	dateTime	""	required
additionalFields	collection	{}	keys: ended_time, notes, started_time, user_id

delete

Parameter	Type	Default	Details
id	string	""	required

deleteExternal

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: client_id, from, is_billed, is_running, page, to, ...

restartTime

Parameter	Type	Default	Details
id	string	""	required

stopTime

Parameter	Type	Default	Details
id	string	""	required

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: ended_time, hours, notes, started_time

Resource: user

create

Parameter	Type	Default	Details
firstName	string	""	required
lastName	string	""	required
email	string	""	required
additionalFields	collection	{}	keys: can_create_invoices, can_create_projects, can_see_rates, cost_rate, default_hourly_rate, has_access_to_all_future_projects, ...

delete

Parameter	Type	Default	Details
id	string	""	required

get

Parameter	Type	Default	Details
id	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filters	collection	{}	keys: is_active, updated_since, page

me

No additional parameters.

update

Parameter	Type	Default	Details
id	string	""	required
updateFields	collection	{}	keys: can_create_invoices, can_create_projects, can_see_rates, cost_rate, default_hourly_rate, email, ...

Common Parameters

Parameter	Type	Default	Details
authentication	options	"accessToken"	accessToken, oAuth2
accountId	options	""	required

Parameter Details

filters children:

Parameter	Type	Default	Details
is_active	boolean	true
updated_since	dateTime	""

additionalFields children:

Parameter	Type	Default	Details
address	string	""
currency	string	""
is_active	string	""

updateFields children:

Parameter	Type	Default	Details
address	string	""
currency	string	""
is_active	boolean	true
name	string	""

Example

NODE "harvest" @harvest AS "Harvest" {
  resource: "client",
  operation: "get",
  id: {{ $json.id }},
  name: {{ $json.name }},
  firstName: {{ $json.firstName }}
}