airbyte/docs/integrations/sources/harvest.md

Harvest

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

Prerequisites

To set up the Harvest source connector, you'll need the Harvest Account ID and API key.

Setup guide

For Airbyte Cloud:

1. Log into your Airbyte Cloud.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Harvest from the Source type dropdown.
4. Enter the name for the Harvest connector.
5. Enter your Harvest Account ID.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. For Authentication mechanism, select Authenticate via Harvest (OAuth) from the dropdown and click Authenticate your Harvest account. Log in and authorize your Harvest account.
8. Click Set up source.

For Airbyte Open Source:

1. Navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Harvest from the Source type dropdown.
4. Enter the name for the Harvest connector.
5. Enter your Harvest Account ID.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. For Authentication mechanism, select Authenticate with Personal Access Token from the dropdown. Enter your Personal Access Token.
8. Click Set up source.

Supported sync modes

The Harvest source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Deduped History

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 connector is restricted by the Harvest rate limits.

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!