Skip to main content

Harvest Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Harvest location.
harvest_api.png

Harvest

Follow the instructions below to create a new data flow that ingests data from a Harvest source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Harvest connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Harvest account, and click Next; or, create a new Harvest credential for use in this flow.

  3. In Nexla, Harvest data sources can be created using pre-built endpoint templates, which expedite source setup for common Harvest endpoints. Each template is designed specifically for the corresponding Harvest endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Harvest sources can also be configured manually, allowing you to ingest data from Harvest endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Harvest endpoints. Each template is designed specifically for the corresponding Harvest endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch all Records of a Resource

    Fetch all records of any resource. Use the advanced tab for fetching a filtered list of records.

    • Select or enter the resource type you want to fetch from the Resource Type field. Available resource types include Projects, Invoices, Expenses, Time entries, and Tasks. You can also add custom resource types if needed. The default value is projects if not specified. The resource type determines which type of data will be retrieved from your Harvest account.
    • The endpoint uses GET requests to https://api.harvestapp.com/api/v2/{resource_type} where {resource_type} is the Resource Type you provide. The endpoint URL is automatically constructed based on the Harvest API base URL and the resource type.
    • The endpoint uses URL-based pagination (iteration.type: paging.next.url) through the links.next mechanism. The response data path is $.{resource_type}[*], which extracts all items from the resource type array in the API response.
    • When a response includes a links.next value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results until all records have been retrieved.

    This endpoint retrieves all records of the specified resource type from your Harvest account. Available resource types include Projects, Invoices, Expenses, Time entries, and Tasks. You can also add custom resource types if needed. The endpoint supports pagination through the links.next URL, which allows you to retrieve large datasets efficiently. You can use the advanced tab for fetching a filtered list of records with custom query parameters. For detailed information about available resource types and the API response format, see the Harvest API documentation.

    Fetch Resource By ID

    Fetch individual resource in user account by ID.

    • Select or enter the resource type you want to fetch from the Resource Type field. Available resource types include Projects, Invoices, Expenses, Time entries, and Tasks. You can also add custom resource types if needed. The default value is projects if not specified. The resource type determines which type of data will be retrieved from your Harvest account.
    • Enter the ID of the specific resource you want to fetch in the Resource ID field. This should be the unique identifier for the resource you want to retrieve.
    • The endpoint uses GET requests to https://api.harvestapp.com/api/v2/{resource_type}/{resource_id} where {resource_type} is the Resource Type you provide and {resource_id} is the Resource ID you provide. The endpoint URL is automatically constructed based on the Harvest API base URL, the resource type, and the resource ID.
    • The endpoint does not use pagination (iteration.type: static) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response.

    This endpoint retrieves a specific resource of the specified resource type from your Harvest account by its ID. Available resource types include Projects, Invoices, Expenses, Time entries, and Tasks. You can also add custom resource types if needed. You must provide the unique identifier (Resource ID) for the resource you want to retrieve. The endpoint returns a single resource matching the specified resource type and ID. For detailed information about available resource types and the API response format, see the Harvest API documentation.

Configure Manually​

Harvest data sources can be manually configured to ingest data from any valid Harvest API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Harvest sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Harvest API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Harvest API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Harvest API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Harvest API endpoints typically follow the pattern https://api.harvestapp.com/api/v2/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Personal Access Token authentication via the Authorization: Bearer {token} header and Harvest-Account-ID: {account_id} header, which are handled automatically by your credential configuration. For detailed information about Harvest API endpoints and available APIs, see the Harvest API documentation.