/harvest-expenses | Type: Application | PCID required: Yes
Tools
harvest_expenses_clients_expenses_report
Clients Expenses Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on expenses with a spent_date on or after the given date. |
to | string | Yes | — | Only report on expenses with a spent_date on or before the given date. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_clients_time_report
Clients Time Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on time entries with a spent_date on or after the given date. |
to | string | Yes | — | Only report on time entries with a spent_date on or before the given date. |
include_fixed_fee | boolean | No | — | When true, billable amounts will be calculated and included for fixed fee projects. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_create_expense
Create an expense Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
billable | boolean | No | — | Whether this expense is billable or not. Defaults to true. |
expense_category_id | integer | Yes | — | The ID of the expense category this expense is being tracked against. |
notes | string | No | — | Textual notes used to describe the expense. |
project_id | integer | Yes | — | The ID of the project associated with this expense. |
receipt | string | No | — | A receipt file to attach to the expense. If including a receipt, you must submit a multipart/form-data request. |
spent_date | string | Yes | — | Date the expense occurred. |
total_cost | number | No | — | The total amount of the expense. |
units | integer | No | — | The quantity of units to use in calculating the total_cost of the expense. |
user_id | integer | No | — | The ID of the user associated with this expense. Defaults to the ID of the currently authenticated user. |
harvest_expenses_create_expense_category
Create an expense category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
is_active | boolean | No | — | Whether the expense category is active or archived. Defaults to true. |
name | string | Yes | — | The name of the expense category. |
unit_name | string | No | — | The unit name of the expense category. |
unit_price | number | No | — | The unit price of the expense category. |
harvest_expenses_delete_expense
Delete an expense Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseId | string | Yes | — | Expense Id |
harvest_expenses_delete_expense_category
Delete an expense category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseCategoryId | string | Yes | — | Expense Category Id |
harvest_expenses_expense_categories_report
Expense Categories Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on expenses with a spent_date on or after the given date. |
to | string | Yes | — | Only report on expenses with a spent_date on or before the given date. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_list_expense_categories
List all expense categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
is_active | boolean | No | — | Pass true to only return active expense categories and false to return inactive expense categories. |
updated_since | string | No | — | Only return expense categories that have been updated since the given date and time. |
page | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
cursor | string | No | — | Pagination cursor |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_list_expenses
List all expenses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | No | — | Only return expenses belonging to the user with the given ID. |
client_id | integer | No | — | Only return expenses belonging to the client with the given ID. |
project_id | integer | No | — | Only return expenses belonging to the project with the given ID. |
is_billed | boolean | No | — | Pass true to only return expenses that have been invoiced and false to return expenses that have not been invoiced. |
approval_status | string | No | — | Only return expenses with the given approval status. Possible values: “unsubmitted”, “submitted”, or “approved”. |
updated_since | string | No | — | Only return expenses that have been updated since the given date and time. |
from | string | No | — | Only return expenses with a spent_date on or after the given date. |
to | string | No | — | Only return expenses with a spent_date on or before the given date. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_project_budget_report
Project Budget Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
is_active | boolean | No | — | Pass true to only return active projects and false to return inactive projects. |
harvest_expenses_projects_expenses_report
Projects Expenses Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on expenses with a spent_date on or after the given date. |
to | string | Yes | — | Only report on expenses with a spent_date on or before the given date. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_projects_time_report
Projects Time Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on time entries with a spent_date on or after the given date. |
to | string | Yes | — | Only report on time entries with a spent_date on or before the given date. |
include_fixed_fee | boolean | No | — | When true, billable amounts will be calculated and included for fixed fee projects. |
include_forecast | boolean | No | — | When true, scheduled hours from Forecast will be included in the response. Requires the account to be connected to Forecast. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_retrieve_expense
Retrieve an expense Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseId | string | Yes | — | Expense Id |
harvest_expenses_retrieve_expense_category
Retrieve an expense category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseCategoryId | string | Yes | — | Expense Category Id |
harvest_expenses_tasks_report
Tasks Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on time entries with a spent_date on or after the given date. |
to | string | Yes | — | Only report on time entries with a spent_date on or before the given date. |
include_fixed_fee | boolean | No | — | When true, billable amounts will be calculated and included for fixed fee projects. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_team_expenses_report
Team Expenses Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on expenses with a spent_date on or after the given date. |
to | string | Yes | — | Only report on expenses with a spent_date on or before the given date. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_team_time_report
Team Time Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on time entries with a spent_date on or after the given date. |
to | string | Yes | — | Only report on time entries with a spent_date on or before the given date. |
include_fixed_fee | boolean | No | — | When true, billable amounts will be calculated and included for fixed fee projects. |
include_forecast | boolean | No | — | When true, scheduled hours from Forecast will be included in the response. Requires the account to be connected to Forecast. |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_uninvoiced_report
Uninvoiced Report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | Yes | — | Only report on time entries and expenses with a spent_date on or after the given date. |
to | string | Yes | — | Only report on time entries and expenses with a spent_date on or before the given date. |
include_fixed_fee | boolean | No | — | Whether or not to include fixed-fee projects in the response. Fixed-fee uninvoiced fee amount will show as long as the selected date range is on or after the project start date (If project start date is not specified, it is project creation date). Otherwise, it will be 0. (Default: true) |
page | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
per_page | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
harvest_expenses_update_expense
Update an expense Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseId | string | Yes | — | Expense Id |
billable | boolean | No | — | Whether this expense is billable or not. Defaults to true. |
delete_receipt | boolean | No | — | Whether an attached expense receipt should be deleted. Pass true to delete the expense receipt. |
expense_category_id | integer | No | — | The ID of the expense category this expense is being tracked against. |
notes | string | No | — | Textual notes used to describe the expense. |
project_id | integer | No | — | The ID of the project associated with this expense. |
receipt | string | No | — | A receipt file to attach to the expense. If including a receipt, you must submit a multipart/form-data request. |
spent_date | string | No | — | Date the expense occurred. |
total_cost | number | No | — | The total amount of the expense. |
units | integer | No | — | The quantity of units to use in calculating the total_cost of the expense. |
harvest_expenses_update_expense_category
Update an expense category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expenseCategoryId | string | Yes | — | Expense Category Id |
is_active | boolean | No | — | Whether the expense category is active or archived. |
name | string | No | — | The name of the expense category. |
unit_name | string | No | — | The unit name of the expense category. |
unit_price | number | No | — | The unit price of the expense category. |

