Overview
Configuration is provided for establishing connections with Harvest service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Harvest REST API using COZYROC's REST Connection Manager.
Step 1: Run "Visual Studio" under "Administrator account". Right-click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2: From the drop-down menu Configuration select Harvest. Then click New in the Token File parameter to create a new token file.
Step 3: In the next wizard, specify the value for parameter AccountId and then click on the Next button.
Step 4: Provide Email and Password. Then press Sign in.
Step 5: In the next wizard, click Authorize application to proceed with generating the token.
Step 6: Save generated access token to File or Database. We are setting the storage type to File in this demo. Specify token protection password. Click OK.
Step 7: Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Harvest instance.
This guide demonstrates how to read data from the Harvest service resource using the COZYROC REST Source component.
Step 1: Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open SSIS Toolbox and drag and drop COZYROC REST Source component.
Step 3: Double click on the REST Source component and select Harvest connection from the combo. Then, select the desired Harvest resource from the second dropdown.
Optionally, you can add extra parameters in the grid below if needed.
Step 4: Click on the Columns tab and select Harvest resource columns you want to read.
Step 5: Click Preview to verify that all necessary resource columns are included.
Congratulations! You've successfully learned how to read data from the Harvest service.
This guide explains how to write data to the Harvest service resource using the COZYROC REST Destination component.
Step 1: Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2: Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3: Double click on the REST Destination component and select Harvest connection from the combo. Also, select resource action and Harvest resource you want to work on.
Step 4: Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Harvest resource.
Configuration
Base URL address: https://api.harvestapp.com/v2.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- AccountId: Required. Specify account identifier.
The following request parameters will be automatically processed during the authentication process:
-
Harvest-Account-Id:
{{=token.AccountId}} -
Authorization:
Bearer {{=token.Access}}
Documentation: https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/#oauth2-application.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- AccountId: Required. Specify account identifier.
- Token: Required. Specify personal access token.
The following request parameters will be automatically processed during the authentication process:
-
Harvest-Account-Id:
{{=connection.user.AccountId}} -
Authorization:
Bearer {{=connection.user.Token}}
Documentation: https://help.getharvest.com/api-v2/authentication-api/authentication/authentication/#personal-access-tokens.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/company.
The result is extracted from:{{=[response]}}.Documentation: https://help.getharvest.com/api-v2/company-api/company/company/.
- base_uri
Template: ShortText.
- full_domain
Template: ShortText.
- name
Template: ShortText.
- is_active
Data type: DT_BOOL
- week_start_day
Template: ShortText.
- wants_timestamp_timers
Data type: DT_BOOL
- time_format
Template: ShortText.
- date_format
Template: ShortText.
- plan_type
Template: ShortText.
- expense_feature
Data type: DT_BOOL
- invoice_feature
Data type: DT_BOOL
- estimate_feature
Data type: DT_BOOL
- team_feature
Data type: DT_BOOL
- weekly_capacity
Data type: DT_I4
- approval_feature
Data type: DT_BOOL
- clock
Template: ShortText.
- currency
Template: ShortText.
- currency_code_display
Template: ShortText.
- currency_symbol_display
Template: ShortText.
- decimal_symbol
Template: ShortText.
- thousands_separator
Template: ShortText.
- color_scheme
Template: ShortText.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/clients.
The result is extracted from:{{=response.clients}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/clients/#list-all-clients.
- [Read Single] action
-
Endpoint URL address:
/clients/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the client identifier.
Documentation: https://help.getharvest.com/api-v2/clients-api/clients/clients/#retrieve-a-client.
- [Create] action
-
Endpoint URL address:
/clients.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/clients/#create-a-client.
- [Update] action
-
Endpoint URL address:
/clients/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/clients/#update-a-client.
- [Delete] action
-
Endpoint URL address:
/clients/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/clients/#delete-a-client.
The resource includes the fields from the Client template.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.contacts}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/contacts/#list-all-contacts.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the contact identifier.
Documentation: https://help.getharvest.com/api-v2/clients-api/clients/contacts/#retrieve-a-contact.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/contacts/#create-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/contacts/#update-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/clients-api/clients/contacts/#delete-a-contact.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
Template: ShortText.
- phone_office
Template: ShortText.
- phone_mobile
Template: ShortText.
- fax
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- client
Template: RefT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/expenses.
The result is extracted from:{{=response.expenses}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expenses/#list-all-expenses.
- [Read Single] action
-
Endpoint URL address:
/expenses/{{=parameters.expenseId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- expenseId: Required. Specify the expense identifier.
Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expenses/#retrieve-an-expense.
- [Create] action
-
Endpoint URL address:
/expenses.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expenses/#create-an-expense.
- [Update] action
-
Endpoint URL address:
/expenses/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expenses/#update-an-expense.
- [Delete] action
-
Endpoint URL address:
/expenses/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expenses/#delete-an-expense.
- id
A key field. Data type: DT_I4
- spent_date
Template: Date.
- notes
Template: LongText.
- total_cost
Data type: DT_R8
- units
Data type: DT_R8
- billable
Data type: DT_BOOL
- receipt
Data type: DT_IMAGE The value is gathered from
{{=item.receipt.url}}address.- is_closed
Data type: DT_BOOL
- is_locked
Data type: DT_BOOL
- is_billed
Data type: DT_BOOL
- locked_reason
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- expense_category
Template: ExpenseCategory.
- user_assignment
Template: UserAssignment.
- invoice
Field components:
-
Uses template:
ShortText. - Contains the following components: id, number.
-
Uses template:
- user
Template: RefT.
- client
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: currency.
-
Uses template:
- project
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: code.
-
Uses template:
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/expense_categories.
The result is extracted from:{{=response.expense_categories}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expense-categories/#list-all-expense-categories.
- [Read Single] action
-
Endpoint URL address:
/expense_categories/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the expense category identifier.
Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expense-categories/#retrieve-an-expense-category.
- [Create] action
-
Endpoint URL address:
/expense_categories.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expense-categories/#create-an-expense-category.
- [Update] action
-
Endpoint URL address:
/expense_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expense-categories/#update-an-expense-category.
- [Delete] action
-
Endpoint URL address:
/expense_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/expenses-api/expenses/expense-categories/#delete-an-expense-category.
The resource includes the fields from the ExpenseCategory template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/invoices.
The result is extracted from:{{=response.invoices}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/#list-all-invoices.
- [Read Single] action
-
Endpoint URL address:
/invoices/{{=parameters.invoiceId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- invoiceId: Required. Specify the invoice identifier.
Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/#retrieve-an-invoice.
- [Create] action
-
Endpoint URL address:
/invoices.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/#create-a-free-form-invoice.
- [Update] action
-
Endpoint URL address:
/invoices/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/#update-an-invoice.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoices/#delete-an-invoice.
- id
A key field. Data type: DT_I4
- client_key
Template: ShortText.
- number
Template: ShortText.
- client_id
Data type: DT_I4
- estimate_id
Data type: DT_I4
- retainer_id
Data type: DT_I4
- purchase_order
Template: ShortText.
- amount
Data type: DT_R8
- due_amount
Data type: DT_R8
- tax
Template: ShortText.
- tax_amount
Data type: DT_R8
- tax2
Template: ShortText.
- tax2_amount
Data type: DT_R8
- discount
Template: ShortText.
- discount_amount
Data type: DT_R8
- subject
Template: ShortText.
- notes
Template: LongText.
- state
Template: ShortText.
- period_start
Template: Date.
- period_end
Template: Date.
- issue_date
Template: Date.
- due_date
Template: Date.
- payment_term
Template: ShortText.
- sent_at
Template: DateTime. A read-only field.
- paid_at
Template: DateTime. A read-only field.
- closed_at
Template: Date.
- recurring_invoice_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- paid_date
Template: Date.
- currency
Template: ShortText.
- payment_options
Template: LongText. A composite field.
- estimate
Template: ShortText.
- retainer
Template: ShortText.
- creator
Template: RefT.
- line_items_import
Template: LineItemImport.
- client
Template: RefT.
- line_items
The value is sent to
/invoices/{{=item.id}}address. Field components:- An array.
-
Uses template:
LineItem.
- messages
The gathered value is processed with
{{=connection.resourceManager['Invoice Message'].getData({ parameters: ['invoiceId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Message. - Contains the following components: invoice_id, thank_you, reminder, send_reminder_on, attach_pdf, include_link_to_client_invoice, event_type.
- payments
The gathered value is processed with
{{=connection.resourceManager['Invoice Payment'].getData({ parameters: ['invoiceId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Payment.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/invoices/{{=parameters.invoiceId}}/messages.
The result is extracted from:{{=response.invoice_messages}}.The action has the following user-defined parameters:
- invoiceId: Required. Specify the invoice identifier.
Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-messages/#list-all-messages-for-an-invoice.
- [Create] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/messages.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-messages/#create-an-invoice-message.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/messages/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-messages/#delete-an-invoice-message.
The resource includes the fields from the Message template.
- invoice_id
A key field. Data type: DT_I4
- thank_you
Data type: DT_BOOL
- reminder
Data type: DT_BOOL
- send_reminder_on
Template: ShortText.
- attach_pdf
Data type: DT_BOOL
- include_link_to_client_invoice
Data type: DT_BOOL
- event_type
Template: ShortText. The value is sent to
/invoices/{{=item.invoice_id}}/messagesaddress.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/invoices/{{=parameters.invoiceId}}/payments.
The result is extracted from:{{=response.invoice_payments}}.The action has the following user-defined parameters:
- invoiceId: Required. Specify the invoice identifier.
Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-payments/#list-all-payments-for-an-invoice.
- [Create] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/payments.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-payments/#create-an-invoice-payment.
- [Delete] action
-
Endpoint URL address:
/invoices/{{=item.invoice_id}}/payments/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-payments/#delete-an-invoice-payment.
The resource includes the fields from the Payment template.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/invoice_item_categories.
The result is extracted from:{{=response.invoice_item_categories}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-item-categories/#list-all-invoice-item-categories.
- [Read Single] action
-
Endpoint URL address:
/invoice_item_categories/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the invoice item category identifier.
Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-item-categories/#retrieve-an-invoice-item-category.
- [Create] action
-
Endpoint URL address:
/invoice_item_categories.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-item-categories/#create-an-invoice-item-category.
- [Update] action
-
Endpoint URL address:
/invoice_item_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-item-categories/#update-an-invoice-item-category.
- [Delete] action
-
Endpoint URL address:
/invoice_item_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/invoices-api/invoices/invoice-item-categories/#delete-an-invoice-item-category.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- use_as_service
Data type: DT_BOOL
- use_as_expense
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/estimates.
The result is extracted from:{{=response.estimates}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimates/#list-all-estimates.
- [Read Single] action
-
Endpoint URL address:
/estimates/{{=parameters.estimateId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- estimateId: Required. Specify the estimate identifier.
Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimates/#retrieve-an-estimate.
- [Create] action
-
Endpoint URL address:
/estimates.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimates/#create-an-estimate.
- [Update] action
-
Endpoint URL address:
/estimates/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimates/#update-an-estimate.
- [Delete] action
-
Endpoint URL address:
/estimates/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimates/#delete-an-estimate.
- id
A key field. Data type: DT_I4
- client_key
Template: ShortText.
- number
Template: ShortText.
- client_id
Data type: DT_I4
- purchase_order
Template: ShortText.
- amount
Data type: DT_R8
- due_amount
Data type: DT_R8
- tax
Template: ShortText.
- tax_amount
Data type: DT_R8
- tax2
Template: ShortText.
- tax2_amount
Data type: DT_R8
- discount
Template: ShortText.
- discount_amount
Data type: DT_R8
- subject
Template: ShortText.
- notes
Template: LongText.
- state
Template: ShortText.
- issue_date
Template: Date.
- payment_term
Template: ShortText.
- sent_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- accepted_at
Template: DateTime. A read-only field.
- declined_at
Template: DateTime. A read-only field.
- currency
Template: ShortText.
- creator
Template: RefT.
- line_items_import
Template: LineItemImport.
- client
Template: RefT.
- line_items
The value is sent to
/estimates/{{=item.id}}address. Field components:- An array.
-
Uses template:
LineItem.
- messages
The gathered value is processed with
{{=connection.resourceManager['Estimate Message'].getData({ parameters: ['estimateId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Message.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/estimates/{{=parameters.estimateId}}/messages.
The result is extracted from:{{=response.estimate_messages}}.The action has the following user-defined parameters:
- estimateId: Required. Specify the estimate identifier.
Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-messages/#list-all-messages-for-an-estimate.
- [Create] action
-
Endpoint URL address:
/estimates/{{=item.estimate_id}}/messages.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-messages/#create-an-estimate-message.
- [Update] action
-
Endpoint URL address:
/estimates/{{=item.estimate_id}}/messages.
- [Delete] action
-
Endpoint URL address:
/estimates/{{=item.estimate_id}}/messages/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-messages/#delete-an-estimate-message.
The resource includes the fields from the Message template.
- estimate_id
A key field. Data type: DT_I4
- event_type
Template: ShortText. The value is sent to
/estimates/{{=item.estimate_id}}/messagesaddress.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/estimate_item_categories.
The result is extracted from:{{=response.estimate_item_categories}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-item-categories/#list-all-estimate-item-categories.
- [Read Single] action
-
Endpoint URL address:
/estimate_item_categories/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the estimate item category identifier.
Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-item-categories/#retrieve-an-estimate-item-category.
- [Create] action
-
Endpoint URL address:
/estimate_item_categories.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-item-categories/#create-an-estimate-item-category.
- [Update] action
-
Endpoint URL address:
/estimate_item_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-item-categories/#update-an-estimate-item-category.
- [Delete] action
-
Endpoint URL address:
/estimate_item_categories/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/estimates-api/estimates/estimate-item-categories/#delete-an-estimate-item-category.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/tasks.
The result is extracted from:{{=response.tasks}}.Documentation: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#list-all-tasks.
- [Read Single] action
-
Endpoint URL address:
/tasks/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the task identifier.
Documentation: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#retrieve-a-task.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#create-a-task.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#update-a-task.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#delete-a-task.
The resource includes the fields from the Task template.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/roles.
The result is extracted from:{{=response.roles}}.Documentation: https://help.getharvest.com/api-v2/roles-api/roles/roles/#list-all-roles.
- [Read Single] action
-
Endpoint URL address:
/roles/{{=Harvest.UI.SingleEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the role identifier.
Documentation: https://help.getharvest.com/api-v2/roles-api/roles/roles/#retrieve-a-role.
- [Create] action
-
Endpoint URL address:
/roles.Documentation: https://help.getharvest.com/api-v2/roles-api/roles/roles/#create-a-role.
- [Update] action
-
Endpoint URL address:
/roles/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/roles-api/roles/roles/#update-a-role.
- [Delete] action
-
Endpoint URL address:
/roles/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/roles-api/roles/roles/#delete-a-role.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- user_ids
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time_entries.
The result is extracted from:{{=response.time_entries}}.Documentation: https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#list-all-time-entries.
- [Read Single] action
-
Endpoint URL address:
/time_entries/{{=parameters.time_entryId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- time_entryId: Required. Specify the time entry identifier.
Documentation: https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#retrieve-a-time-entry.
- [Create] action
-
Endpoint URL address:
/time_entries.Documentation: https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#create-a-time-entry-via-duration.
- [Update] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#update-a-time-entry.
- [Delete] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#delete-a-time-entry.
- id
A key field. Template: ShortText.
- spent_date
Template: Date.
- project_id
Data type: DT_I4
- task_id
Data type: DT_I4
- user_id
Data type: DT_I4
- hours
Data type: DT_R8
- hours_without_timer
Data type: DT_R8
- rounded_hours
Data type: DT_R8
- notes
Template: LongText.
- is_locked
Data type: DT_BOOL
- locked_reason
Template: ShortText.
- is_closed
Data type: DT_BOOL
- is_billed
Data type: DT_BOOL
- timer_started_at
Template: DateTime.
- started_time
Template: ShortText.
- ended_time
Template: ShortText.
- is_running
Data type: DT_BOOL
- billable
Data type: DT_BOOL
- budgeted
Data type: DT_BOOL
- billable_rate
Data type: DT_R8
- cost_rate
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- user_assignment
Template: UserAssignment.
- task_assignment
Template: TaskAssignment.
- invoice
Field components:
-
Uses template:
ShortText. - Contains the following components: id, number.
-
Uses template:
- external_reference
Field components:
-
Uses template:
ShortText. - Contains the following components: id, group_id, account_id, permalink.
-
Uses template:
- user
Template: RefT.
- client
Template: RefT.
- task
Template: RefT.
- project
Template: RefT.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/projects.
The result is extracted from:{{=response.projects}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/projects/#list-all-projects.
- [Read Single] action
-
Endpoint URL address:
/projects/{{=Harvest.UI.ProjectEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/projects/#retrieve-a-project.
- [Create] action
-
Endpoint URL address:
/projects.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/projects/#create-a-project.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/projects/#update-a-project.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/projects/#delete-a-project.
The resource includes the fields from the Project template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user_assignments.
The result is extracted from:{{=response.user_assignments}}.
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
page:
{{=undefined}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#list-all-user-assignments.
-
cursor:
- [Read project] action
-
Endpoint URL address:
/projects/{{=Harvest.UI.ProjectEditor.getValue(parameters)}}/user_assignments.
The result is extracted from:{{=response.user_assignments}}.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#list-all-user-assignments-for-a-specific-project.
- [Read Single] action
-
Endpoint URL address:
/projects/{{=Harvest.UI.ProjectEditor.getValue(parameters)}}/user_assignments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
- id: Required. Specify the user assignment identifier.
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#list-all-user-assignments-for-a-specific-project.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/user_assignments.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#create-a-user-assignment.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/user_assignments/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#update-a-user-assignment.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/user_assignments/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/user-assignments/#delete-a-user-assignment.
The resource includes the fields from the UserAssignment template.
- user
Template: RefT.
- project_id
Data type: DT_I4
- project
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: code.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/task_assignments.
The result is extracted from:{{=response.task_assignments}}.
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
page:
{{=undefined}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#list-all-task-assignments.
-
cursor:
- [Read project] action
-
Endpoint URL address:
/projects/{{=Harvest.UI.ProjectEditor.getValue(parameters)}}/task_assignments.
The result is extracted from:{{=response.task_assignments}}.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#list-all-task-assignments-for-a-specific-project.
- [Read Single] action
-
Endpoint URL address:
/projects/{{=Harvest.UI.ProjectEditor.getValue(parameters)}}/task_assignments/{{=parameters.task_assignmentId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- projectId: Required. Specify the project identifier.
- task_assignmentId: Required. Specify the task assignment identifier.
Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#retrieve-a-task-assignment.
- [Create] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/task_assignments.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#create-a-task-assignment.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/task_assignments/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#update-a-task-assignment.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.project_id}}/task_assignments/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/projects-api/projects/task-assignments/#delete-a-task-assignment.
The resource includes the fields from the TaskAssignment template.
- task
Template: RefT.
- project_id
A key field. Template: ShortText.
- project
Template: RefT.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.users}}.Documentation: https://help.getharvest.com/api-v2/users-api/users/users/#list-all-users.
- [Read Single] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/users/#retrieve-a-user.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://help.getharvest.com/api-v2/users-api/users/users/#create-a-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/users-api/users/users/#update-a-user .
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://help.getharvest.com/api-v2/users-api/users/users/#delete-a-user.
The resource includes the fields from the User template.
- billable_rate
The gathered value is processed with
{{=connection.resourceManager['User Billable Rate'].getData({ parameters: ['userId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Rate.
- cost_rate
The gathered value is processed with
{{=connection.resourceManager['User Cost Rate'].getData({ parameters: ['userId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Rate.
- teammate
The gathered value is processed with
{{=connection.resourceManager['User Teammate'].getData({ parameters: ['userId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Teammate.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: archive.
-
Uses template:
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/teammates.
The result is extracted from:{{=response.teammates}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/teammates/#list-all-assigned-teammates-for-a-specific-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.user_id}}/teammates.Documentation: https://help.getharvest.com/api-v2/users-api/users/teammates/#update-a-users-assigned-teammates.
The resource includes the fields from the Teammate template.
- user_id
Template: ShortText.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/billable_rates.
The result is extracted from:{{=response.billable_rates}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/billable-rates/#list-all-billable-rates-for-a-specific-user.
- [Read Single] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/billable_rates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
- id: Required. Specify the billable rate identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/billable-rates/#retrieve-a-billable-rate.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/billable_rates.Documentation: https://help.getharvest.com/api-v2/users-api/users/billable-rates/#create-a-billable-rate.
The resource includes the fields from the Rate template.
- user_id
Template: ShortText.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/cost_rates.
The result is extracted from:{{=response.cost_rates}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/cost-rates/#list-all-cost-rates-for-a-specific-user.
- [Read Single] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/billable_rates/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
- id: Required. Specify the cost rate identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/cost-rates/#retrieve-a-cost-rate.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/cost_rates.Documentation: https://help.getharvest.com/api-v2/users-api/users/cost-rates/#create-a-cost-rate.
The resource includes the fields from the Rate template.
- user_id
Template: ShortText.
Based on resource template Cursor.
- [Read] action
-
Endpoint URL address:
/users/{{=Harvest.UI.UserEditor.getValue(parameters)}}/project_assignments.
The result is extracted from:{{=response.project_assignments}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://help.getharvest.com/api-v2/users-api/users/project-assignments/#list-active-project-assignments.
- id
A key field. Data type: DT_I4
- is_project_manager
Data type: DT_BOOL
- is_active
Data type: DT_BOOL
- use_default_rates
Data type: DT_BOOL
- budget
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- hourly_rate
Data type: DT_I4
- task_assignments
Field components:
- An array.
-
Uses template:
TaskAssignment.
- client
Template: RefT.
- project
Template: RefT.
Based on resource template Report.
- [Read] action
-
Endpoint URL address:
/reports/uninvoiced.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/uninvoiced-report/#uninvoiced-report.
- currency
Template: ShortText.
- total_hours
Data type: DT_R8
- uninvoiced_hours
Data type: DT_R8
- uninvoiced_expenses
Data type: DT_R8
- uninvoiced_amount
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports/project_budget.
The result is extracted from:{{=response.results}}.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/project-budget-report/#project-budget-report.
- client_id
Data type: DT_I4
- client_name
Template: ShortText.
- project_id
Data type: DT_I4
- project_name
Template: ShortText.
- budget_is_monthly
Data type: DT_BOOL
- budget_by
Template: ShortText.
- is_active
Data type: DT_BOOL
- budget
Data type: DT_R8
- budget_spent
Data type: DT_R8
- budget_remaining
Data type: DT_R8
Based on resource template Report.
- [Read client] action
-
Endpoint URL address:
/reports/time/clients.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/time-reports/#clients-report.
- [Read project] action
-
Endpoint URL address:
/reports/time/projects.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/time-reports/#projects-report.
- [Read task] action
-
Endpoint URL address:
/reports/time/tasks.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/time-reports/#tasks-report.
- [Read team] action
-
Endpoint URL address:
/reports/time/team.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/time-reports/#team-report.
- task_id
A key field. Data type: DT_I4
- task_name
Template: ShortText.
- user_id
A key field. Data type: DT_I4
- user_name
Template: ShortText.
- total_hours
Data type: DT_R8
- billable_hours
Data type: DT_R8
- currency
Template: ShortText.
- billable_amount
Data type: DT_R8
- weekly_capacity
Data type: DT_I4
- avatar_url
Template: LongText.
Based on resource template Report.
- [Read client] action
-
Endpoint URL address:
/reports/expenses/clients.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/expense-reports/#clients-report.
- [Read project] action
-
Endpoint URL address:
/reports/expenses/projects.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/expense-reports/#projects-report.
- [Read category] action
-
Endpoint URL address:
/reports/expenses/categories.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/expense-reports/#expense-categories-report.
- [Read team] action
-
Endpoint URL address:
/reports/expenses/team.Documentation: https://help.getharvest.com/api-v2/reports-api/reports/expense-reports/#team-report.
- task_id
A key field. Data type: DT_I4
- task_name
Template: ShortText.
- user_id
A key field. Data type: DT_I4
- user_name
Template: ShortText.
- total_hours
Data type: DT_R8
- billable_hours
Data type: DT_R8
- currency
Template: ShortText.
- billable_amount
Data type: DT_R8
- weekly_capacity
Data type: DT_I4
- avatar_url
Template: LongText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=undefined}} -
cursor:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- from: Required. Specify from parameter to return only report on date on or after the given date.
- to: Required. Specify from parameter to return only report on date on or before the given date.
- client_id
Data type: DT_I4
- client_name
Template: ShortText.
- project_id
Data type: DT_I4
- project_name
Template: ShortText.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Date
Data type: DT_DBDATE
- DateTime
Data type: DT_DBTIMESTAMP
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: id, first_name, last_name, email, telephone, timezone, weekly_capacity, has_access_to_all_future_projects, is_contractor, is_active, calendar_integration_enabled, calendar_integration_source, created_at, updated_at, can_create_projects, default_hourly_rate, cost_rate, roles, access_roles, permissions_claims, avatar_url.
-
Uses template:
- RefT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- Client
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, is_active, address, statement_key, created_at, updated_at, currency.
-
Uses template:
- Recipient
Field components:
-
Uses template:
ShortText. - Contains the following components: name, email.
-
Uses template:
- Message
Field components:
-
Uses template:
ShortText. - Contains the following components: id, event_type, sent_by, sent_by_email, sent_from, sent_from_email, send_me_a_copy, created_at, updated_at, recipients, include_link_to_client_invoice, subject, body.
-
Uses template:
- Gateway
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- UserAssignment
Field components:
-
Uses template:
DateTime. - Contains the following components: id, is_project_manager, is_active, use_default_rates, budget, created_at, updated_at, hourly_rate, user_id.
-
Uses template:
- TaskAssignment
Field components:
-
Uses template:
DateTime. - Contains the following components: id, billable, is_active, created_at, updated_at, hourly_rate, budget.
-
Uses template:
- Payment
Field components:
-
Uses template:
DateTime. - Contains the following components: id, amount, paid_at, recorded_by, recorded_by_email, notes, transaction_id, created_at, updated_at, paid_date, payment_gateway.
-
Uses template:
- Teammate
Field components:
-
Uses template:
ShortText. - Contains the following components: id, first_name, last_name, email, teammate_ids.
-
Uses template:
- Task
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, billable_by_default, default_hourly_rate, is_default, is_active, created_at, updated_at.
-
Uses template:
- Project
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, code, is_active, bill_by, budget, budget_by, budget_is_monthly, notify_when_over_budget, over_budget_notification_percentage, over_budget_notification_date, show_budget_to_all, created_at, updated_at, starts_on, ends_on, is_billable, is_fixed_fee, notes, cost_budget, cost_budget_include_expenses, hourly_rate, fee, client.
-
Uses template:
- Rate
Field components:
-
Uses template:
Date. - Contains the following components: id, amount, start_date, end_date, created_at, updated_at.
-
Uses template:
- ExpenseCategory
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, unit_name, unit_price, is_active, created_at, updated_at.
-
Uses template:
- LineItemImport
Field components:
-
Uses template:
LongText. - Contains the following components: project_ids, time, expenses.
-
Uses template:
- LineItemProject
Template: RefT. Field components:
-
Uses template:
ShortText. - Contains the following components: code.
-
Uses template:
- LineItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, project_id, kind, description, quantity, unit_price, amount, taxed, taxed2, _destroy, project.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.