Harvest

Version Latest

This is the documentation of the new Harvest app.
Here is the documentation of the legacy Harvest (legacy) app.

Getting Started with Harvest

The Harvest modules allow you to monitor, create, edit, or delete clients, contacts, projects, invoices, expenses, tasks, time entries and users in your Harvest account.

Prerequisites

  • A Harvest account

In order to use Harvest with Integromat, it is necessary to have a Harvest account. If you do not have one, you can create a Harvest account at www.getharvest.com/signup.

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Harvest to Integromat

To connect your Harvest account to Integromat follow the general instructions for Connecting to services.

After you click the Continue button, Integromat will redirect you to the Harvest website where you will be prompted to grant Integromat access to your account.

2019-06-18_10_52_43-Window.png

Confirm the dialog by clicking the Authorize App button.

Clients

Watch Clients

Triggers when a new client is added.

ConnectionEstablish a connection to your Harvest account.
WatchSelect whether you want to watch all changes or newly added clients only.
LimitSet the maximum number of clients Integromat will return during one execution cycle.

List Clients

Returns a list of your clients. The clients are returned sorted by creation date, with the most recently created clients appearing first.

ConnectionEstablish a connection to your Harvest account.
Number of Clients to ReturnSet the maximum number of clients Integromat will return during one execution cycle.
Active or InactiveSelect whether you want to return only active, only inactive, or both clients.
Updated SinceReturns only clients that have been updated since the entered date and time. The list of supported date and time formats.

Get a Client

Retrieves details about a desired client.

ConnectionEstablish a connection to your Harvest account.
Client IDMap or select the Client ID of the client you want to retrieve information about.

Create a Client

Creates a new client.

ConnectionEstablish a connection to your Harvest account.
NameEnter the name of the client.
AddressEnter the client’s physical address. May include new line characters.
CurrencyISO 4217 currency code. Example: USD. If not provided, the company’s currency will be used. List of supported currencies.
ActiveSet whether the client is active or archived.

Edit a Client

Updates the specific client by setting the provided values.

ConnectionEstablish a connection to your Harvest account.
Client IDSelect or map the Client ID of the client you want to update.
NameEnter the new name of the client.
AddressEnter the client’s new physical address. May include new line characters.
CurrencyISO 4217 currency code. Example: USD. If not provided, the company’s currency will be used. List of supported currencies.
ActiveSet whether the client is active or archived.

Delete a Client

Deletes a selected client.

ConnectionEstablish a connection to your Harvest account.
Client IDSelect or map the Client ID of the client you want to delete.

Contacts

Watch Contacts

Triggers when a new contact is created.

ConnectionEstablish a connection to your Harvest account.
Client ID

Appears when the Filter by Client option is enabled.

Allows you to return contacts that belong to the client with the provided Client ID.

WatchSelect whether you want to watch all changes or newly added contacts only.
LimitSet the maximum number of contacts Integromat will return during one execution cycle.

List Contacts

Returns a list of your contacts. The contacts are returned sorted by creation date, with the most recently created contacts appearing first.

ConnectionEstablish a connection to your Harvest account.
Number of Contacts to ReturnSet the maximum number of contacts Integromat will return during one execution cycle.
Client IDMap or select the client ID to return contacts belonging to that client only.
Updated SinceReturns only contacts that have been updated since the entered date and time. The list of supported date and time formats.

Get a Contact

Retrieves the details of a specified contact.

ConnectionEstablish a connection to your Harvest account.
Client ID

Map or select the Contact ID of the contact you want to retrieve information about.

Create a Contact

Creates a new contact.

ConnectionEstablish a connection to your Harvest account.
Client IDMap or select the ID of the client associated with this contact.
First NameEnter the client's first name.
Last NameEnter the client's last name.
TitleEnter the title of the contact.
EmailEnter the contact’s email address.
Office Number
Enter the contact’s office phone number.
Mobile NumberEnter the contact’s mobile phone number.
FaxEnter the contact’s fax number.

Edit a Contact

Updates a specified contact.

ConnectionEstablish a connection to your Harvest account.
Contact IDSelect or map the contact you want to update.
Client IDMap or select the ID of the client associated with this contact.
First NameEnter the client's first name.
Last NameEnter the client's last name.
TitleEnter the title of the contact.
EmailEnter the contact’s email address.
Office Number
Enter the contact’s office phone number.
Mobile NumberEnter the contact’s mobile phone number.
FaxEnter the contact’s fax number.

Delete a Contact

Deletes a specified contact.

ConnectionEstablish a connection to your Harvest account.
Contact IDMap or select the contact you want to delete.

Projects

Watch Projects

Triggers when a new project is created.

ConnectionEstablish a connection to your Harvest account.
WatchSelect whether you want to watch all changes or newly added projects only.
LimitSet the maximum number of projects Integromat will return during one execution cycle.

List Projects

Returns a list of projects in your Harvest account.

ConnectionEstablish a connection to your Harvest account.
Number of Projects to ReturnSet the maximum number of projects Integromat will return during one execution cycle.
Active or inactiveSelect whether you want to return only active, only inactive, or both project statuses.
Client IDMap or select the client ID to return projects belonging to that client only.
Updated SinceReturns only projects that have been updated since the entered date and time. The list of supported date and time formats.

Get a Project

Retrieves details about a specified project.

ConnectionEstablish a connection to your Harvest account.
Project IDMap or select the Project ID of the project you want to retrieve information about.

Create a Project

Creates a new project.

ConnectionEstablish a connection to your Harvest account.
Client IDSelect or map the ID of the client to associate this project with.
NameEnter the name of the project.
Bill byEnter the method by which the project is invoiced.
Budget bySelect the method by which the project is budgeted.
NotesEnter notes for the project.
You can see notes when creating an invoice for Fixed Fee projects.
Code
Enter the project code.
The Project Code helps identify your project. You can use any combo of numbers or letters.
ActiveSelect whether the project is active or archived.

Edit a Project

ConnectionEstablish a connection to your Harvest account.
Project IDSelect or map the ID of the project you want to update.
New nameEnter the name of the project.
Bill byEnter the method by which the project is invoiced.
Budget bySelect the method by which the project is budgeted.
NotesEnter notes for the project.
You can see notes when creating an invoice for Fixed Fee projects.
Client IDSelect or map the ID of the client to associate this project with.
Code
Enter the project code.
The Project Code helps identify your project. You can use any combo of numbers or letters.
ActiveSelect whether the project is active or archived.

Delete a Project

Deletes a project and any time entries or expenses tracked to it.

Invoices associated with the project will not be deleted. If you don’t want the project’s time entries and expenses to be deleted, you should archive the project using the Edit a Project module.
ConnectionEstablish a connection to your Harvest account.
Project IDMap or select the project you want to delete.

List Task Assignments

Returns a list of your task assignments. The task assignments are returned sorted by creation date, with the most recently created task assignments appearing first.

ConnectionEstablish a connection to your Harvest account.
Number of Task Assignments to ReturnSet the maximum number of task assignments Integromat will return during one execution cycle.
Project IDMap or select the project ID you want to filter results by.
Active or inactiveSelect whether you want to return only active, only inactive, or both task assignment statuses.
Updated SinceReturns only task assignments that have been updated since the entered date and time. The list of supported date and time formats.

Get a Task Assignment

Retrieves details about a specified task assignment.

ConnectionEstablish a connection to your Harvest account.
Project IDEnter or map the ID of the project associated with the task assignment you want to retrieve.
Task Assignment IDEnter (map) the ID of the task assignment you want to retrieve information about.

List User Assignments

Returns a list of your project's user assignments, active and archived.

ConnectionEstablish a connection to your Harvest account.
Number of User Assignments to ReturnSet the maximum number of user assignments Integromat will return during one execution cycle.
Project IDMap or select the project ID you want to filter results by.
User IDReturns only user assignments belonging to the user with the entered ID.
Active or inactiveSelect whether you want to return only active, only inactive, or both user assignment statuses.
Updated SinceReturns only user assignments that have been updated since the entered date and time. The list of supported date and time formats.

Invoices

Watch Invoices

Triggers when a new invoice is created.

ConnectionEstablish a connection to your Harvest account.
Client ID

Appears when the Filter by Client option is enabled.

Allows you to return invoices that belong to the client with the provided Client ID.

WatchSelect whether you want to watch all changes or newly added invoices only.
LimitSet the maximum number of invoices Integromat will return during one execution cycle.

List Invoices

Returns a list of your invoices. The invoices are returned sorted by issue date, with the most recently issued invoices appearing first.

ConnectionEstablish a connection to your Harvest account.
Number of Invoices to ReturnSet the maximum number of invoices Integromat will return during one execution cycle.
Updated SinceReturns only invoices that have been updated since the entered date and time. The list of supported date and time formats.
Client IDReturns only user assignments belonging to the client with the entered ID.
Project IDMap or select the project ID you want to filter results by.
FromEnter the date in order to return invoices with an issue_date on or after the entered date. The list of supported date and time formats.
ToEnter the date in order to return invoices with an issue_date on or before the entered date.
StateSelect the state of the invoices you want to return.

Get an Invoice

Retrieves details about a specified invoice.

ConnectionEstablish a connection to your Harvest account.
Invoice IDEnter (map) or select the ID of the invoice you want to retrieve information about.

Create a free-form invoice

Creates a new invoice.

ConnectionEstablish a connection to your Harvest account.
Client IDSelect or map the ID of the client this invoice belongs to.
NumberEnter the invoice number. If no number is entered, the number will be automatically generated.
Purchase Order NumberEnter the purchase order number.
TaxEnter the tax (percentage). This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%
Tax 2Apply another tax. This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%
DiscountEnter the discount (percentage). This percentage is subtracted from the subtotal. Example: use 10.0 for 10.0%.
SubjectEnter the invoice subject.
NotesEnter additional notes that will be included on the invoice.
CurrencyEnter the currency used by the invoice. If not provided, the client’s currency will be used. See a list of supported currencies.
Issue DateEnter the date when the invoice was issued. Default date = today's date. The list of supported date and time formats.
Due DateEnter the invoice's due date. Defaults to the Issue date if no Payment Term is specified.
Payment TermSelect the timeframe in which the invoice should be paid. Defaults to custom. Options: upon receiptnet 15net 30net 45, or net 60. Net 15, for example, means that payment is due fifteen days after the invoice issue date.
Line Items

Add desired line items.

Project IDEnter the ID of the project associated with this line item.
KindEnter the name of an invoice item category.
DescriptionText description of the line item.
QuantityThe unit quantity of the item. Defaults to 1.
Unit PriceThe individual price per unit.
TaxedSelect whether the invoice’s tax percentage applies to this line item. Defaults to No.
Taxed2Select whether the invoice’s tax2 percentage applies to this line item. Defaults to No.
Retainer IDEnter the retainer ID in order to create a retainer invoice.
Estimate IDEnter the ID of the estimate associated with this invoice.

Delete an Invoice

Deletes a specified invoice.

ConnectionEstablish a connection to your Harvest account.
Invoice IDEnter (map) or select the ID of the invoice you want to delete.

List Payments

Returns a list of payments associated with the selected invoice.

ConnectionEstablish a connection to your Harvest account.
Invoice IDSelect or map the ID of the invoice that the payments belongs to.
Number of Invoices to returnSet the maximum number of invoices Integromat will return during one execution cycle.
Updated SinceEnter the date to return invoice payments that have been updated since the date and time. The list of supported date and time formats.

Create Invoice Payments

Creates a new invoice payment.

ConnectionEstablish a connection to your Harvest account.
Invoice IDEnter the invoice you want to create a payment for.
AmountEnter the amount of the payment.
Payment dateSelect whether to set time and date or the date only.
DateEnter the payment date (and time). The list of supported date and time formats.

Expenses

List expenses

Returns a list of your expenses.

ConnectionEstablish a connection to your Harvest account.
Number of Expenses to ReturnSet the maximum number of expenses Integromat will return during one execution cycle.
User IDReturns only expenses belonging to the client with the entered ID.
Client IDReturns only expenses belonging to the client with the entered ID.
Project IDMap or select the project ID you want to filter expenses by.
Updates SinceReturns only expenses that have been updated since the entered date and time. The list of supported date and time formats.
FromEnter the date in order to return expenses with a Spent Date on or after the entered date. The list of supported date and time formats.
ToEnter the date in order to return expenses with a Spent date on or before the entered date.
InvoicedSelect whether to return expenses that were invoiced, not invoiced, or both.

Get an Expense

Retrieves a specified expense.

ConnectionEstablish a connection to your Harvest account.
Expense IDEnter (map) or select the ID of the expense you want to retrieve information about.

Create an Expense

Creates a new expense.

ConnectionEstablish a connection to your Harvest account.
Spent dateEnter the date the expense occurred. The list of supported date and time formats.
Project IDSelect the ID of the project associated with this expense.
Category IDEnter the ID of the expense category this expense is being tracked against.
Total Cost
Enter the total amount of the expense.
NotesEnter the expense description.
BillableSet whether this expense is billable or not.

Edit an Expense

Updates an existing expense.

ConnectionEstablish a connection to your Harvest account.
Expense IDSelect or map the ID of the expense ID you want to update.
Spent dateEnter the date the expense occurred. The list of supported date and time formats.
Project IDSelect the ID of the project associated with this expense.
Category IDEnter the ID of the expense category this expense is being tracked against.
UnitsThe quantity of units to use in calculating the Total Cost of the expense.
Total Cost
Enter the total amount of the expense.
NotesEnter the expense description.
BillableSet whether this expense is billable or not.
Delete receiptDefine whether an attached expense receipt should be deleted or not. Select Yes to delete the expense receipt.

Delete an Expense

Deletes an expense.

ConnectionEstablish a connection to your Harvest account.
Expense IDEnter (map) or select the ID of the expense you want to delete.

Tasks

Watch Tasks

Triggers when a new task is created.

ConnectionEstablish a connection to your Harvest account.
WatchSelect whether you want to watch all changes or newly added tasks only.
LimitSet the maximum number of tasks Integromat will return during one execution cycle.

List Tasks

Returns a list of your tasks.

ConnectionEstablish a connection to your Harvest account.
Number of Tasks to ReturnSet the maximum number of tasks Integromat will return during one execution cycle.
Active or inactiveSelect whether you want to return only active, only inactive, or both task statuses.
Updated SinceReturns only tasks that have been updated since the entered date and time. The list of supported date and time formats.

Get a Task

Retrieves information about a specific task.

ConnectionEstablish a connection to your Harvest account.
Task IDEnter (map) or select the ID of the task you want to retrieve information about.

Create a Task

Creates a new task.

ConnectionEstablish a connection to your Harvest account.
NameEnter the name for the task.
Default hourly rateThe default hourly rate to use for this task when it is added to a project. Defaults to 0.
Billable by defaultSet whether default tasks should be marked billable when creating a new project.
DefaultSet whether this task should be automatically added to future projects.

Edit a Task

Updates an existing task.

ConnectionEstablish a connection to your Harvest account.
Task IDSelect the task you want to update.
New NameEnter the new name for the task.
Default hourly rateThe default hourly rate to use for this task when it is added to a project. Defaults to 0.
Billable by defaultSet whether default tasks should be marked billable when creating a new project.
DefaultSet whether this task should be automatically added to future projects.

Delete a Task

Deletes an existing task.

ConnectionEstablish a connection to your Harvest account.
Task IDEnter (map) or select the ID of the task you want to delete.

Time Entries

Watch Time Entries

Triggers when a new time entry is created.

ConnectionEstablish a connection to your Harvest account.
NameEnter the name for the task.
Filter BySelect the user, client, or project you want to filter time entries by.
WatchSelect whether you want to watch all changes or newly added time entries only.
LimitSet the maximum number of time entries Integromat will return during one execution cycle.

List Time Entries

Returns a list of time entries based on the filter settings.

ConnectionEstablish a connection to your Harvest account.
Number of time entries to returnSet the maximum number of time entries Integromat will return during one execution cycle.
Invoiced or not invoicedSelect whether you want to return only invoiced, only not invoiced, or both time entry states.
Running or Non-runningSelect whether you want to return only running, only non-running, or both time entry states.
User IDReturns only time entries belonging to the user with the entered ID.
Client IDReturns only time entries belonging to the client with the entered ID.
Project IDReturns only time entries belonging to the project with the entered ID.
Updated SinceReturns only tasks that have been updated since the entered date and time. The list of supported date and time formats.
FromReturns only time entries with a spent date on or after the entered date. The list of supported date and time formats.
ToReturns only time entries with a spent date on or before the entered date.

Get a Time Entry

Retrieves details about a time entry.

ConnectionEstablish a connection to your Harvest account.
Time entry IDEnter (map) or select the ID of the time entry you want to retrieve information about.

Create a Time Entry

Creates a new time entry.

ConnectionEstablish a connection to your Harvest account.
Project IDSelect the ID of the project to associate with the time entry.
Task IDSelect the ID of the task to associate with the time entry.
Spent atEnter the date when the time entry was spent. The list of supported date and time formats.
NotesEnter a description of the time entry.
HoursThe current amount of time tracked. If provided, the time entry will be created with the specified hours and is_running will be set to false. If not provided, hours will be set to 0.0 and is_running will be set to true.

Edit a Time Entry

Updates an existing time entry.

ConnectionEstablish a connection to your Harvest account.
Time entry IDEnter (map) the time entry you want to update.
Project IDSelect the ID of the project to associate with the time entry.
NotesEnter a description of the time entry.
HoursThe current amount of time tracked. If provided, the time entry will be created with the specified hours and is_running will be set to false. If not provided, hours will be set to 0.0 and is_running will be set to true.
Spent atEnter the date when the time entry was spent. The list of supported date and time formats.

Delete a Time Entry

Deletes an existing time entry.

ConnectionEstablish a connection to your Harvest account.
Time Entry IDEnter (map) or select the ID of the time entry you want to delete.

Users

Watch users

Triggers when a new user is created.

ConnectionEstablish a connection to your Harvest account.
WatchSelect whether you want to watch all changes or newly added users only.
LimitSet the maximum number of users Integromat will return during one execution cycle.

List Users

Returns a list of users. The users are returned sorted by creation date, with the most recently created users appearing first.

ConnectionEstablish a connection to your Harvest account.
Number of users to returnSet the maximum number of users Integromat will return during one execution cycle.
Active or inactiveSelect whether you want to return only active, only inactive, or both time entry states.
Updated SinceReturns only users that have been updated since the entered date and time. The list of supported date and time formats.

Get a User

Retrieves details about a specified user.

ConnectionEstablish a connection to your Harvest account.
User IDEnter (map) or select the ID of the user you want to retrieve information about.

Create a User

Creates a new user.

ConnectionEstablish a connection to your Harvest account.
First nameEnter the new user's first name. Can’t be updated if the user is inactive.
Last nameEnter the new user's last name. Can’t be updated if the user is inactive.
Email addressEnter the new user's email address. Can’t be updated if the user is inactive.
TelephoneEnter the new user's phone number.
TimezoneThe user’s timezone. Defaults to the company’s timezone. See a list of supported time zones.
RolesEnter the role names assigned to this person.
AdministratorSelect the Yes option to set the new user as the administrator with admin permissions.

Edit a User

Updates an existing user.

ConnectionEstablish a connection to your Harvest account.
User IDSelect or map the user ID of the user you want to update.
First nameEnter the new user's first name. Can’t be updated if the user is inactive.
Last nameEnter the new user's last name. Can’t be updated if the user is inactive.
Email addressEnter the new user's email address. Can’t be updated if the user is inactive.
TelephoneEnter the new user's phone number.
TimezoneThe user’s timezone. Defaults to the company’s timezone. See a list of supported time zones.
RolesEnter the role names assigned to this person.
AdministratorSelect the Yes option to set the new user as the administrator with admin permissions.

Delete a User

Deletes an existing user.

Deleting a user is only possible if they have no time entries or expenses associated with them.
ConnectionEstablish a connection to your Harvest account.
User IDEnter (map) or select the ID of the user you want to delete.

Make an API Call

Allows you to perform a custom API call.

ConnectionEstablish a connection to your Harvest account.
URL

Enter a path relative to https://api.harvestapp.com/v2/. E.g. projects

For the list of available endpoints, refer to the Harvest API V2 documentation.
Method

Select the HTTP method you want to use:

GET
to retrieve information for an entry.

POST
to create a new entry.

PUT
to update/replace an existing entry.

PATCH
to make a partial entry update.

DELETE
to delete an entry.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Users

The following API call returns all users:

2019-06-20_10_35_25-Window.png

Matches of the search can be found in the module's Output under Bundle > Body > users. 
In our example, 4 users were returned:

2019-06-20_10_37_37-Window.png

 

Popular use cases from our blog

facebook-leads-airtable-article-illustration

How to Easily Import Leads from Facebook to Mailchimp and Airtable

Active-campaign-automation-illustration.png

How to Boost ActiveCampaign Automations With Integromat

Instagram-for-business-2-illustration

Instagram for Business Automation: 3 Powerful Templates to Get Started

How-to-automate-reporting-with-nocode-illustration

Automated Reporting: Get Rolling With 4 Easy, Practical Solutions

How-to-manage-Twitter-from-a-Notion-database-part-1-Illustzration

Can You Tweet From Notion? Yes, and Here’s How to Do It [Tutorial]

slack-automation-illustration

Slack Automation: 20 Free Templates to Get You Inspired

Didn’t find what you were looking for?

Ticket

Create a ticket

Contact our world-class support team and tell us what’s happening.

Create a ticket
Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.