Skip to main content
Server path: /harvest-expenses | Type: Application | PCID required: Yes

Tools


harvest_expenses_clients_expenses_report

Clients Expenses Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on expenses with a spent_date on or after the given date.
tostringYesOnly report on expenses with a spent_date on or before the given date.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_clients_time_report

Clients Time Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on time entries with a spent_date on or after the given date.
tostringYesOnly report on time entries with a spent_date on or before the given date.
include_fixed_feebooleanNoWhen true, billable amounts will be calculated and included for fixed fee projects.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_create_expense

Create an expense Parameters:
ParameterTypeRequiredDefaultDescription
billablebooleanNoWhether this expense is billable or not. Defaults to true.
expense_category_idintegerYesThe ID of the expense category this expense is being tracked against.
notesstringNoTextual notes used to describe the expense.
project_idintegerYesThe ID of the project associated with this expense.
receiptstringNoA receipt file to attach to the expense. If including a receipt, you must submit a multipart/form-data request.
spent_datestringYesDate the expense occurred.
total_costnumberNoThe total amount of the expense.
unitsintegerNoThe quantity of units to use in calculating the total_cost of the expense.
user_idintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
is_activebooleanNoWhether the expense category is active or archived. Defaults to true.
namestringYesThe name of the expense category.
unit_namestringNoThe unit name of the expense category.
unit_pricenumberNoThe unit price of the expense category.

harvest_expenses_delete_expense

Delete an expense Parameters:
ParameterTypeRequiredDefaultDescription
expenseIdstringYesExpense Id

harvest_expenses_delete_expense_category

Delete an expense category Parameters:
ParameterTypeRequiredDefaultDescription
expenseCategoryIdstringYesExpense Category Id

harvest_expenses_expense_categories_report

Expense Categories Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on expenses with a spent_date on or after the given date.
tostringYesOnly report on expenses with a spent_date on or before the given date.
pageintegerNoThe 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_pageintegerNoThe 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:
ParameterTypeRequiredDefaultDescription
is_activebooleanNoPass true to only return active expense categories and false to return inactive expense categories.
updated_sincestringNoOnly return expense categories that have been updated since the given date and time.
pageintegerNoDEPRECATED 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)
cursorstringNoPagination cursor
per_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_list_expenses

List all expenses Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerNoOnly return expenses belonging to the user with the given ID.
client_idintegerNoOnly return expenses belonging to the client with the given ID.
project_idintegerNoOnly return expenses belonging to the project with the given ID.
is_billedbooleanNoPass true to only return expenses that have been invoiced and false to return expenses that have not been invoiced.
approval_statusstringNoOnly return expenses with the given approval status. Possible values: “unsubmitted”, “submitted”, or “approved”.
updated_sincestringNoOnly return expenses that have been updated since the given date and time.
fromstringNoOnly return expenses with a spent_date on or after the given date.
tostringNoOnly return expenses with a spent_date on or before the given date.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_project_budget_report

Project Budget Report Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)
is_activebooleanNoPass true to only return active projects and false to return inactive projects.

harvest_expenses_projects_expenses_report

Projects Expenses Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on expenses with a spent_date on or after the given date.
tostringYesOnly report on expenses with a spent_date on or before the given date.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_projects_time_report

Projects Time Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on time entries with a spent_date on or after the given date.
tostringYesOnly report on time entries with a spent_date on or before the given date.
include_fixed_feebooleanNoWhen true, billable amounts will be calculated and included for fixed fee projects.
include_forecastbooleanNoWhen true, scheduled hours from Forecast will be included in the response. Requires the account to be connected to Forecast.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_retrieve_expense

Retrieve an expense Parameters:
ParameterTypeRequiredDefaultDescription
expenseIdstringYesExpense Id

harvest_expenses_retrieve_expense_category

Retrieve an expense category Parameters:
ParameterTypeRequiredDefaultDescription
expenseCategoryIdstringYesExpense Category Id

harvest_expenses_tasks_report

Tasks Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on time entries with a spent_date on or after the given date.
tostringYesOnly report on time entries with a spent_date on or before the given date.
include_fixed_feebooleanNoWhen true, billable amounts will be calculated and included for fixed fee projects.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_team_expenses_report

Team Expenses Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on expenses with a spent_date on or after the given date.
tostringYesOnly report on expenses with a spent_date on or before the given date.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_team_time_report

Team Time Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on time entries with a spent_date on or after the given date.
tostringYesOnly report on time entries with a spent_date on or before the given date.
include_fixed_feebooleanNoWhen true, billable amounts will be calculated and included for fixed fee projects.
include_forecastbooleanNoWhen true, scheduled hours from Forecast will be included in the response. Requires the account to be connected to Forecast.
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_uninvoiced_report

Uninvoiced Report Parameters:
ParameterTypeRequiredDefaultDescription
fromstringYesOnly report on time entries and expenses with a spent_date on or after the given date.
tostringYesOnly report on time entries and expenses with a spent_date on or before the given date.
include_fixed_feebooleanNoWhether 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)
pageintegerNoThe 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_pageintegerNoThe number of records to return per page. Can range between 1 and 2000. (Default: 2000)

harvest_expenses_update_expense

Update an expense Parameters:
ParameterTypeRequiredDefaultDescription
expenseIdstringYesExpense Id
billablebooleanNoWhether this expense is billable or not. Defaults to true.
delete_receiptbooleanNoWhether an attached expense receipt should be deleted. Pass true to delete the expense receipt.
expense_category_idintegerNoThe ID of the expense category this expense is being tracked against.
notesstringNoTextual notes used to describe the expense.
project_idintegerNoThe ID of the project associated with this expense.
receiptstringNoA receipt file to attach to the expense. If including a receipt, you must submit a multipart/form-data request.
spent_datestringNoDate the expense occurred.
total_costnumberNoThe total amount of the expense.
unitsintegerNoThe quantity of units to use in calculating the total_cost of the expense.

harvest_expenses_update_expense_category

Update an expense category Parameters:
ParameterTypeRequiredDefaultDescription
expenseCategoryIdstringYesExpense Category Id
is_activebooleanNoWhether the expense category is active or archived.
namestringNoThe name of the expense category.
unit_namestringNoThe unit name of the expense category.
unit_pricenumberNoThe unit price of the expense category.