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:
- Log into your Airbyte Cloud.
- Click Sources and then click + New source.
- On the Set up the source page, select Harvest from the Source type dropdown.
- Enter the name for the Harvest connector.
- Enter your Harvest Account ID.
- For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
- For Authentication mechanism, select Authenticate via Harvest (OAuth) from the dropdown and click Authenticate your Harvest account. Log in and authorize your Harvest account.
- Click Set up source.
For Airbyte Open Source:
- Navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Harvest from the Source type dropdown.
- Enter the name for the Harvest connector.
- Enter your Harvest Account ID.
- For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
- For Authentication mechanism, select Authenticate with Personal Access Token from the dropdown. Enter your Personal Access Token.
- Click Set up source.
Supported sync modes
The Harvest source connector supports the following sync modes:
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)
- Users (Incremental)
- User Billable Rates
- User Cost Rates
- User Project Assignments (Incremental)
- Expense Clients Report (Incremental)
- Expense Projects Report (Incremental)
- Expense Categories Report (Incremental)
- Expense Team Report (Incremental)
- Uninvoiced Report (Incremental)
- Time Clients Report (Incremental)
- Time Projects Report (Incremental)
- Time Tasks Report (Incremental)
- Time Team Report (Incremental)
- Project Budget Report
Performance considerations
The connector is restricted by the Harvest rate limits.
Reference
Config fields reference
Field
Type
Property name
string
account_id
string
replication_start_date
string
replication_end_date
object
credentials
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.0.13 | 2024-08-17 | 44263 | Update dependencies |
| 1.0.12 | 2024-08-10 | 43463 | Update dependencies |
| 1.0.11 | 2024-08-03 | 43123 | Update dependencies |
| 1.0.10 | 2024-07-27 | 42831 | Update dependencies |
| 1.0.9 | 2024-07-20 | 42326 | Update dependencies |
| 1.0.8 | 2024-07-13 | 41841 | Update dependencies |
| 1.0.7 | 2024-07-10 | 41381 | Update dependencies |
| 1.0.6 | 2024-07-09 | 41303 | Update dependencies |
| 1.0.5 | 2024-07-06 | 41002 | Update dependencies |
| 1.0.4 | 2024-06-25 | 40475 | Update dependencies |
| 1.0.3 | 2024-06-22 | 40169 | Update dependencies |
| 1.0.2 | 2024-05-08 | 38055 | Fix error handler for retriable errors |
| 1.0.1 | 2024-04-24 | 36641 | Schema descriptions and CDK 0.80.0 |
| 1.0.0 | 2024-04-15 | 35863 | Migrates connector to Low Code CDK, Updates incremental substream state to per-partition state |
| 0.2.0 | 2024-04-08 | 36889 | Unpin CDK version |
| 0.1.24 | 2024-02-26 | 35541 | Improve check command to avoid missing alerts |
| 0.1.23 | 2024-02-19 | 35305 | Fix pendulum parsing error |
| 0.1.22 | 2024-02-12 | 35154 | Manage dependencies with Poetry. |
| 0.1.21 | 2023-11-30 | 33003 | Update expected records |
| 0.1.20 | 2023-10-19 | 31599 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 0.1.19 | 2023-07-26 | 28755 | Changed parameters for Time Reports to use 365 days as opposed to 1 year |
| 0.1.18 | 2023-05-29 | 26714 | Remove authSpecification from spec in favour of advancedAuth |
| 0.1.17 | 2023-03-03 | 22983 | Specified date formatting in specification |
| 0.1.16 | 2023-02-07 | 22417 | Turn on default HttpAvailabilityStrategy |
| 0.1.15 | 2023-01-27 | 22008 | Set AvailabilityStrategy for streams explicitly to None |
| 0.1.14 | 2023-01-09 | 21151 | Skip 403 FORBIDDEN for all stream |
| 0.1.13 | 2022-12-22 | 20810 | Skip 403 FORBIDDEN for EstimateItemCategories stream |
| 0.1.12 | 2022-12-16 | 20572 | Introduce replication end date |
| 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! |