tap-harvest

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from the [Harvest API].

• Extracts the following resources:

  • Projects

  • Clients

  • Contacts

  • EstimateItemCategories

  • Estimates

    • EstimateLineItems

    • EstimateMessages

  • ExpenseCategories

  • Expenses

  • InvoiceItemCategories

  • Invoices

    • InvoiceLineItems

    • InvoiceMessages

    • InvoicePayments

  • ProjectTasks

  • ProjectUsers

  • Roles

    • UserRoles

  • Tasks

  • TimeEntries

    • ExternalReference

    • TimeEntryExternalReference

  • Users

    • UserProjects
      • UserProjectTasks

• Outputs the schema for each resource

• Incrementally pulls data based on the input state

Streams

projects

• Data Key = projects
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

clients

• Data Key = clients
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

contacts

• Data Key = contacts
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

estimate_item_categories

• Data Key = estimate_item_categories
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

estimate_line_items

• Data Key = estimate_line_items
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

estimate_messages

• Data Key = estimate_messages
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

estimates

• Data Key = estimates
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

expense_categories

• Data Key = expense_categories
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

expenses

• Data Key = expenses
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

external_reference

• Data Key = external_reference
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

invoice_item_categories

• Data Key = invoice_item_categories
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

invoice_line_items

• Data Key = invoice_line_items
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

invoice_messages

• Data Key = invoice_messages
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

invoice_payments

• Data Key = invoice_payments
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

invoices

• Data Key = invoices
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

project_tasks

• Data Key = task_assignments
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

project_users

• Data Key = project_users
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

roles

• Data Key = roles
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

tasks

• Data Key = tasks
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

time_entries

• Data Key = time_entries
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

time_entry_external_reference

• Data Key = time_entry_external_reference
• Primary keys: ['time_entry_id', 'external_reference_id']
• Replication strategy: INCREMENTAL

user_project_tasks

• Data Key = user_project_tasks
• Primary keys: ['user_id', 'project_task_id']
• Replication strategy: INCREMENTAL

user_projects

• Data Key = project_assignments
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

user_roles

• Data Key = user_roles
• Primary keys: ['role_id', 'user_id']
• Replication strategy: INCREMENTAL

users

• Data Key = users
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

Authentication

Quick Start

1. Install

   Clone this repository, and then install using setup.py. We recommend using a virtualenv:

   > virtualenv -p python3 venv
   > source venv/bin/activate
   > python setup.py install
   OR
   > cd .../tap-harvest
   > pip install -e .

2. Dependent libraries. The following dependent libraries were installed.

   > pip install singer-python
   > pip install target-stitch
   > pip install target-json
   

   • singer-tools
   • target-stitch

3. Create your tap's config.json file. The tap config file for this tap should include these entries:

   • start_date - the default value to use if no bookmark exists for an endpoint (rfc3339 date string)
   • user_agent (string, optional): Process and email for API logging purposes. Example: tap-harvest <api_user_email@your_company.com>
   • request_timeout (integer, 300): Max time for which request should wait to get a response. Default request_timeout is 300 seconds.

   {
       "start_date": "2019-01-01T00:00:00Z",
       "user_agent": "tap-harvest <api_user_email@your_company.com>",
       "request_timeout": 300,
       ...
   }

   Optionally, also create a state.json file. currently_syncing is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off.

   {
       "currently_syncing": "engage",
       "bookmarks": {
           "export": "2019-09-27T22:34:39.000000Z",
           "funnels": "2019-09-28T15:30:26.000000Z",
           "revenue": "2019-09-28T18:23:53Z"
       }
   }

4. Run the Tap in Discovery Mode This creates a catalog.json for selecting objects/fields to integrate:

   tap-harvest --config config.json --discover > catalog.json

   See the Singer docs on discovery mode here

5. Run the Tap in Sync Mode (with catalog) and write out to state file

   For Sync mode:

   > tap-harvest --config tap_config.json --catalog catalog.json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To load to json files to verify outputs:

   > tap-harvest --config tap_config.json --catalog catalog.json | target-json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To pseudo-load to Stitch Import API with dry run:

   > tap-harvest --config tap_config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

6. Test the Tap

   While developing the harvest tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality

   > pylint tap_harvest -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments

   Pylint test resulted in the following score:

   Your code has been rated at 9.67/10

   To check the tap

   > tap_harvest --config tap_config.json --catalog catalog.json | singer-check-tap > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   Unit Tests

   Unit tests may be run with the following.

   python -m pytest --verbose
   

   Note, you may need to install test dependencies.

   pip install -e .'[dev]'
   

---

Copyright © 2025 Stitch