Harvest: Most-used fields

Harvest: Most-used fields#

The table below gives information about most-used fields that you can import from Harvest. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

access_roles

access_roles

The access role(s) that define the user’s permissions within Harvest.

dimension

address

address

The physical address of the client.

dimension

approval_status

approval_status

The approval status of the time entry, which can be “unsubmitted”, “submitted”, or “approved”.

dimension

avatar_url

avatar_url

The URL for the user’s avatar image.

dimension

bill_by

bill_by

The method by which a project is invoiced, such as by project, tasks, people, or none.

dimension

billable

billable

Indicates whether the project is billable.

dimension

billable_rate

billable_rate

The hourly rate used for projects billed by a project hourly rate.

dimension

budget

budget

The allocated budget for a project, representing the total hours assigned when the project is budgeted by time.

dimension

budget_by

budget_by

The method used to budget the project, such as by hours per project, total project fees, hours per task, fees per task, hours per person, or no budget.

dimension

budget_is_monthly

budget_is_monthly

Indicates whether the project budget resets every month.

dimension

client.currency

client.currency

The currency code associated with the client.

dimension

client.id

client.id

The unique identifier for the client.

metric

client.name

client.name

The name of the client.

dimension

code

code

The code associated with the project.

metric

cost_budget

cost_budget

The monetary budget set for a project when the budgeting method is by money.

dimension

cost_budget_include_expenses

cost_budget_include_expenses

Option to include tracked expenses in the budget for projects that use ‘Total Project Fees’ as their budgeting method.

dimension

cost_rate

cost_rate

The cost rate used for a user in calculating a project’s costs versus the billable amount.

dimension

created_at

created_at

The date and time when the record was created.

dimension

currency

currency

The currency code associated with a client or tracked hours.

dimension

date

date

The date associated with the record, such as the date a time entry was spent or an expense occurred.

dimension

default_hourly_rate

default_hourly_rate

The default billable hourly rate for the user when assigned to a project.

dimension

email

email

The email address of the user.

dimension

ended_time

ended_time

The time when the time entry ended.

dimension

ends_on

ends_on

The date when the project is scheduled to end.

dimension

external_reference

external_reference

An object containing details of an external reference associated with the time entry.

dimension

external_reference.account_id

external_reference.account_id

The account ID from the associated external reference.

dimension

external_reference.group_id

external_reference.group_id

The group ID from the associated external reference.

dimension

external_reference.id

external_reference.id

The unique identifier from the associated external reference.

dimension

external_reference.permalink

external_reference.permalink

The permalink URL from the associated external reference.

dimension

external_reference.service

external_reference.service

The name of the service from the associated external reference.

dimension

external_reference.service_icon_url

external_reference.service_icon_url

The URL for the service icon from the associated external reference.

dimension

fee

fee

The planned invoice amount for fixed-fee projects.

dimension

first_name

first_name

The first name of the user.

dimension

has_access_to_all_future_projects

has_access_to_all_future_projects

Indicates whether the user is automatically added to all future projects.

dimension

hourly_rate

hourly_rate

This field indicates the hourly billing rate. It can represent the billing rate for an entire project, a custom rate for a specific user on a project, or the rate for a particular task when the project is billed by tasks.

dimension

hours

hours

The number of hours tracked in a time entry.

metric

hours_without_timer

hours_without_timer

The number of hours tracked in a time entry before the timer was last started.

metric

id

id

The unique identifier for the record.

dimension

invoice

invoice

An object containing information about the associated invoice once the record has been invoiced.

dimension

invoice.id

invoice.id

The unique identifier of the associated invoice.

metric

invoice.number

invoice.number

The number of the associated invoice.

metric

is_active

is_active

Indicates whether the record is active or archived.

dimension

is_billable

is_billable

Indicates whether the item (project or expense) is billable.

dimension

is_billed

is_billed

Indicates whether the time entry has been marked as invoiced.

dimension

is_closed

is_closed

Indicates if the time entry has been approved via Timesheet Approval (deprecated, use approval_status).

dimension

is_contractor

is_contractor

Indicates whether the user is a contractor or an employee.

dimension

is_fixed_fee

is_fixed_fee

Indicates whether the project is a fixed-fee project.

dimension

is_locked

is_locked

Indicates whether the time entry has been locked.

dimension

is_running

is_running

Indicates whether the time entry timer is currently running.

dimension

last_name

last_name

The last name of the user.

dimension

locked_reason

locked_reason

The reason why the time entry has been locked.

dimension

name

name

The name of the record, such as the project name, client name, task name, or expense category name.

dimension

notes

notes

Any textual notes or description associated with the record.

dimension

notify_when_over_budget

notify_when_over_budget

Indicates whether Project Managers should receive notifications when the project exceeds its budget.

dimension

over_budget_notification_date

over_budget_notification_date

The date of the most recent notification sent when the project exceeded its budget.

dimension

over_budget_notification_percentage

over_budget_notification_percentage

The percentage value used to trigger email alerts when the project goes over budget.

metric

project.code

project.code

The code assigned to the associated project.

metric

project.id

project.id

The unique identifier for the associated project.

metric

project.name

project.name

The name of the associated project.

dimension

roles

roles

Descriptive business roles assigned to the user, used for filtering reports.

dimension

rounded_hours

rounded_hours

The rounded number of hours tracked in a time entry, used in summary reports and invoices based on Time Rounding settings.

metric

show_budget_to_all

show_budget_to_all

Option to display the project budget to all employees.

dimension

spent_date

spent_date

The date on which the time entry was spent or the expense occurred.

dimension

started_time

started_time

The time when the time entry started.

dimension

starts_on

starts_on

The date when the project was started.

dimension

task.id

task.id

The unique identifier for the associated task.

metric

task.name

task.name

The name of the associated task.

dimension

task_assignment.billable

task_assignment.billable

Indicates whether the task assignment is billable.

dimension

task_assignment.budget

task_assignment.budget

The budget allocated for the task assignment when the project’s budgeting method is by task or task fees.

dimension

task_assignment.created_at

task_assignment.created_at

The date and time when the task assignment was created.

dimension

task_assignment.hourly_rate

task_assignment.hourly_rate

The hourly rate used for the task assignment when the project’s billing method is by tasks.

dimension

task_assignment.id

task_assignment.id

The unique identifier for the task assignment.

metric

task_assignment.is_active

task_assignment.is_active

Indicates whether the task assignment is active or archived.

dimension

task_assignment.updated_at

task_assignment.updated_at

The date and time when the task assignment was last updated.

dimension

telephone

telephone

The user’s telephone number.

dimension

timer_started_at

timer_started_at

The date and time when the running timer for a time entry was started.

dimension

timezone

timezone

The user’s timezone.

dimension

updated_at

updated_at

The date and time when the record was last updated.

dimension

user.id

user.id

The unique identifier for the associated user.

metric

user.name

user.name

The name of the associated user.

dimension

user_assignment.budget

user_assignment.budget

The budget allocated for the user assignment when the project’s budgeting method is by person.

dimension

user_assignment.created_at

user_assignment.created_at

The date and time when the user assignment was created.

dimension

user_assignment.hourly_rate

user_assignment.hourly_rate

The custom hourly rate used for the user assignment when the project bills by people and does not use default rates.

dimension

user_assignment.id

user_assignment.id

The unique identifier for the user assignment.

metric

user_assignment.is_active

user_assignment.is_active

Indicates whether the user assignment is active or archived.

dimension

user_assignment.is_project_manager

user_assignment.is_project_manager

Indicates whether the user has Project Manager permissions for the associated project.

dimension

user_assignment.updated_at

user_assignment.updated_at

The date and time when the user assignment was last updated.

dimension

user_assignment.use_default_rates

user_assignment.use_default_rates

Determines if the user’s default billable rates or custom rates from the user assignment are used for a project billed by people.

dimension

weekly_capacity

weekly_capacity

The number of hours per week a user is available to work, expressed in seconds.

metric