Harvest integration summary

Stitch’s Harvest integration replicates data using the Harvest REST API V1. Refer to the Schema section for a list of objects available for replication.

Harvest feature snapshot

A high-level look at Stitch's Harvest (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Sunset on December 1, 2019

Supported by

Singer Community

Stitch plan

Standard

API availability

Not available

Singer GitHub repository

singer-io/tap-harvest

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Unsupported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Unsupported

Column selection

Unsupported

Select all

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Harvest table reference

clients

The clients table contains info about the clients in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

clients schema on GitHub

Harvest API method

active

BOOLEAN

cache_version

INTEGER

created_at

DATE-TIME

currency

STRING

currency_symbol

STRING

default_invoice_timeframe

STRING

details

STRING

highrise_id

BOOLEAN

id

INTEGER

last_invoice_kind

STRING

name

STRING

updated_at

DATE-TIME

contacts

The contacts table contains info about the client contacts in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

contacts schema on GitHub

Harvest API method

client_id

INTEGER

created_at

DATE-TIME

email

STRING

fax

STRING

first_name

STRING

id

INTEGER

last_name

STRING

phone_mobile

STRING

phone_office

STRING

title

STRING

updated_at

DATE-TIME

expense_categories

The expense_categories table contains info about the expense categories in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

expense_categories schema on GitHub

Harvest API method

created_at

DATE-TIME

deactivated

BOOLEAN

id

INTEGER

name

STRING

unit_name

STRING

unit_price

NUMBER

updated_at

DATE-TIME

expenses

The expenses table contains info about the expenses recorded in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

expenses schema on GitHub

Harvest API method

billable

BOOLEAN

company_id

INTEGER

created_at

DATE-TIME

expense_category_id

INTEGER

has_receipt

BOOLEAN

id

INTEGER

invoice_id

INTEGER

is_closed

BOOLEAN

is_locked

BOOLEAN

locked_reason

STRING

notes

STRING

project_id

INTEGER

receipt_url

STRING

spent_at

STRING

total_cost

NUMBER

units

NUMBER

updated_at

DATE-TIME

user_id

INTEGER

invoice_item_categories

The invoice_item_categories table contains info about the various categories that can be applied to invoice line items.

Note: Harvest includes two non-removable categories by default for the hours and expenses you bill.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

invoice_item_categories schema on GitHub

Harvest API method

created_at

DATE-TIME

id

INTEGER

name

STRING

updated_at

DATE-TIME

use_as_expense

BOOLEAN

use_as_service

BOOLEAN

invoice_messages

The invoice_messages table contains info about invoice messages, or emails sent to clients about invoices.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

invoice_messages schema on GitHub

Harvest API method

body

STRING

created_at

DATE-TIME

full_recipient_list

STRING

id

INTEGER

include_pay_pal_link

BOOLEAN

invoice_id

INTEGER

send_me_a_copy

BOOLEAN

send_reminder_on

DATE-TIME

sent_by

STRING

sent_by_email

STRING

sent_from

STRING

sent_from_email

STRING

subject

STRING

thank_you

BOOLEAN

updated_at

DATE-TIME

invoice_payments

The invoice_payments table contains info about the payments applied to invoices in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

invoice_payments schema on GitHub

Harvest API method

amount

NUMBER

authorization

STRING

created_at

DATE-TIME

id

INTEGER

invoice_id

INTEGER

notes

STRING

paid_at

DATE-TIME

payment_gateway_id

INTEGER

paypal_transaction_id

INTEGER

recorded_by

STRING

recorded_by_email

STRING

updated_at

DATE-TIME

invoices

The invoices table contains info about the invoices in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

invoices schema on GitHub

amount

NUMBER

client_id

INTEGER

client_key

STRING

client_name

STRING

created_at

DATE-TIME

created_by_id

INTEGER

currency

STRING

discount

STRING, NUMBER

discount_amount

NUMBER

due_amount

NUMBER

due_at

STRING

due_at_human_format

STRING

estimate_id

INTEGER

id

INTEGER

issued_at

STRING

notes

STRING

number

STRING

period_end

STRING

period_start

STRING

purchase_order

STRING

recurring_invoice_id

INTEGER

retainer_id

INTEGER

state

STRING

subject

STRING

tax

STRING, NUMBER

tax2

STRING, NUMBER

tax2_amount

NUMBER

tax_amount

NUMBER

updated_at

DATE-TIME

people

The people table contains info about the people - or users - in your Harvest account.

Note: These are internal users. Info about external users, or clients, is in the clients table.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

people schema on GitHub

Harvest API method

cost_rate

NUMBER

created_at

DATE-TIME

default_hourly_rate

NUMBER

department

STRING

email

STRING

first_name

STRING

has_access_to_all_future_projects

BOOLEAN

id

INTEGER

identity_account_id

INTEGER

indentity_user_id

INTEGER

is_active

BOOLEAN

is_admin

BOOLEAN

is_contractor

BOOLEAN

last_name

STRING

telephone

STRING

timezone

STRING

updated_at

DATE-TIME

wants_newsletter

BOOLEAN

project_tasks

The project_tasks table contains info about the tasks assigned to projects.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

project_tasks schema on GitHub

Harvest API method

billable

BOOLEAN

budget

NUMBER

created_at

DATE-TIME

deactivated

BOOLEAN

estimate

NUMBER

hourly_rate

NUMBER

id

INTEGER

project_id

INTEGER

task_id

INTEGER

updated_at

DATE-TIME

project_users

The project_users table contains info about the users assigned to projects.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

project_users schema on GitHub

Harvest API method

budget

NUMBER

created_at

DATE-TIME

deactivated

BOOLEAN

estimate

NUMBER

hourly_rate

NUMBER

id

INTEGER

is_project_manager

BOOLEAN

project_id

INTEGER

updated_at

DATE-TIME

user_id

INTEGER

projects

The projects table contains info about the projects in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

projects schema on GitHub

Harvest API method

active

BOOLEAN

bill_by

STRING

billable

BOOLEAN

budget

NUMBER

budget_by

STRING

client_id

INTEGER

code

STRING

cost_budget

NUMBER

cost_budget_include_expenses

BOOLEAN

created_at

DATE-TIME

ends_on

STRING

estimate

NUMBER

estimate_by

STRING

hint_earliest_record_at

STRING

hint_latest_record_at

STRING

hourly_rate

NUMBER

id

INTEGER

name

STRING

notes

STRING

notify_when_over_budget

BOOLEAN

over_budget_notification_percetange

INTEGER

over_budget_notified_at

STRING

show_budget_to_all

BOOLEAN

starts_on

STRING

updated_at

DATE-TIME

tasks

The tasks table contains info about the tasks in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

tasks schema on GitHub

Harvest API method

billable_by_default

BOOLEAN

created_at

DATE-TIME

deactivated

BOOLEAN

default_hourly_rate

NUMBER

id

INTEGER

is_default

BOOLEAN

name

STRING

updated_at

DATE-TIME

time_entries

The time_entries table contains info about the time entries in your Harvest account.

Replication Method

Key-based Incremental

Primary Key

id

Replication Key

updated_at

Useful links

Harvest documentation

time_entries schema on GitHub

adjustment_record

BOOLEAN

created_at

DATE-TIME

hours

NUMBER

hours_with_timer

NUMBER

id

INTEGER

is_billed

BOOLEAN

is_closed

BOOLEAN

notes

STRING

project_id

INTEGER

spent_at

STRING

task_id

INTEGER

timer_started_at

DATE-TIME

updated_at

DATE-TIME

user_id

INTEGER


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.