harvest.md

Harvest

This page contains the setup guide and reference information for the Harvest source connector.

Prerequisites

See Harvest documentation for more details.

Setup guide

Step 1: Set up Harvest

This connector supports only authentication with API Key. To obtain API key follow the instructions below:

1. Go to Account Settings page;
2. Under Integrations section press Authorized OAuth2 API Clients button;
3. New page will be opened on which you need to click on Create New Personal Access Token button and follow instructions.

Step 2: Set up the Harvest connector in Airbyte

1. Navigate to the Airbyte Open Source dashboard
2. Set the name for your source
3. Enter your api_token
4. Enter your account_id
5. Enter the replication_start_date you want your sync to start from
6. Click Set up source

Supported sync modes

The Harvest source connector supports the following sync modes:

Feature	Supported?
Full Refresh Sync	Yes
Incremental Sync	Yes
Replicate Incremental Deletes	No
SSL connection	Yes
Namespaces	No

Supported Streams

• Client Contacts (Incremental)
• Clients (Incremental)
• Company
• Invoice Messages (Incremental)
• Invoice Payments (Incremental)
• Invoices (Incremental)
• Invoice Item Categories (Incremental)
• Estimate Messages (Incremental)
• Estimates (Incremental)
• Estimate Item Categories (Incremental)
• Expenses (Incremental)
• Expense Categories (Incremental)
• Tasks (Incremental)
• Time Entries (Incremental)
• Project User Assignments (Incremental)
• Project Task Assignments (Incremental)
• Projects (Incremental)
• Roles (Incremental)
• User Billable Rates
• User Cost Rates
• User Project Assignments (Incremental)
• Expense Reports
• Uninvoiced Report
• Time Reports
• Project Budget Report

Performance considerations

The Harvest connector will gracefully handle rate limits. For more information, see the Harvest docs for rate limitations.

Changelog

Version	Date	Pull Request	Subject
0.1.11	2022-09-28	17326	Migrate to per-stream states.
0.1.10	2022-08-08	15221	Added parent_id for all streams which have parent stream
0.1.9	2022-08-04	15312	Fix started_time and ended_time format schema error and updated report slicing
0.1.8	2021-12-14	8429	Update titles and descriptions
0.1.6	2021-11-14	7952	Implement OAuth 2.0 support
0.1.5	2021-09-28	5747	Update schema date-time fields
0.1.4	2021-06-22	5701	Harvest normalization failure: fixing the schemas
0.1.3	2021-06-22	4274	Fix wrong data type on statement_key in clients stream
0.1.2	2021-06-07	4222	Correct specification parameter name
0.1.1	2021-06-09	3973	Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.0	2021-06-07	3709	Release Harvest connector!