Harvest

harvest

Harvest is a time-tracking and invoicing tool designed for teams and freelancers, helping them log billable hours, manage projects, and streamline payments

Time Tracking Software Proposal & Invoice Management Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (58)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create ClientHARVEST_CREATE_CLIENTAcción

Tool to create a new client. use after gathering client details to register a new client in harvest.

Parámetros de entrada

namestringObligatorio
A textual description of the client.
addressstring
The client's physical address. May include new line characters.
currencystring
ISO currency code for the client. If omitted, the company's default currency is used.
is_activeboolean
Whether the client is active, or archived. Defaults to true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Client ContactHARVEST_CREATE_CLIENT_CONTACTAcción

Tool to create a new client contact. use when you need to add a contact under an existing client. call after you've retrieved or confirmed the client id.

Parámetros de entrada

faxstring
Contact's fax number.
emailanyemail
Contact's email address.
titlestring
Title of the contact (e.g., 'Director of Ops').
client_idintegerObligatorio
ID of the client associated with this contact.
last_namestring
Last name of the contact.
first_namestringObligatorio
First name of the contact.
phone_mobilestring
Contact's mobile phone number.
phone_officestring
Contact's office phone number.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EstimateHARVEST_CREATE_ESTIMATEAcción

Tool to create a new estimate. use after gathering client and line item details.

Parámetros de entrada

taxnumber
First tax percentage applied to subtotal, e.g., 10.0 for 10%.
tax2number
Second tax percentage applied to subtotal, e.g., 5.0 for 5%.
notesstring
Additional notes to include on the estimate.
numberstring
If not set, the estimate number will be auto-generated.
subjectstring
Estimate subject.
currencystring
Currency for the estimate; defaults to client's currency.
discountnumber
Discount percentage subtracted from subtotal, e.g., 15.0 for 15%.
client_idintegerObligatorio
ID of the client this estimate belongs to.
issue_datestring
Date the estimate was issued (YYYY-MM-DD); defaults to today.
line_itemsobject[]
List of line items to include on the estimate.
purchase_orderstring
The purchase order number.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Estimate Item CategoryHARVEST_CREATE_ESTIMATE_ITEM_CATEGORYAcción

Tool to create a new estimate item category in harvest. use after deciding to categorize line items within an estimate.

Parámetros de entrada

namestringObligatorio
The name of the estimate item category.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Estimate MessageHARVEST_CREATE_ESTIMATE_MESSAGEAcción

Tool to create a new message for an estimate. use when you have an estimate id and want to send a message or run an event (send, accept, decline, re-open) on the estimate.

Parámetros de entrada

bodystring
The message body.
subjectstring
The message subject.
event_typestringenum
If provided, runs an event on the estimate. Options: accept, decline, re-open, or send.
acceptdeclinere-opensend
recipientsobject[]
Array of recipient parameters. Required unless performing an event-only call.
estimate_idintegerObligatorio
ID of the estimate to add a message to.
send_me_a_copyboolean
Whether to email a copy of the message to the current user. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ExpenseHARVEST_CREATE_EXPENSEAcción

Tool to create a new expense entry. use when recording costs against projects. ensure either units or total cost is provided.

Parámetros de entrada

notesstring
Textual notes describing the expense.
unitsnumber
Quantity of units to use for calculating total_cost. Required for unit-based categories.
receiptstring
Receipt file to attach. Multipart/form-data upload not supported by this tool.
user_idinteger
ID of the user associated with this expense. Defaults to the authenticated user.
billableboolean
Whether the expense is billable. Defaults to true.
project_idintegerObligatorio
ID of the project associated with this expense.
spent_datestringObligatoriodate
Date the expense occurred (YYYY-MM-DD).
total_costnumber
Total amount of the expense. Required if not using a unit-based category.
expense_category_idintegerObligatorio
ID of the expense category this expense is tracked against.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create InvoiceHARVEST_CREATE_INVOICEAcción

Tool to create a new invoice. use when you have gathered all invoice details and need to bill a client in harvest.

Parámetros de entrada

taxnumber
First tax rate applied to the invoice (0-100).
tax2number
Second tax rate applied to the invoice (0-100).
notesstring
Additional notes on the invoice.
statestringenum
State of the invoice. Options: 'draft', 'open', 'paid', 'closed'.
draftopenpaidclosed
numberstring
Custom invoice number (e.g., 'INV-1001').
subjectstring
Subject of the invoice.
currencystring
Currency code (e.g., 'USD').
discountnumber
Percentage discount applied to the invoice (0-100).
due_datestring
Date the invoice is due (YYYY-MM-DD).
client_idintegerObligatorio
ID of the client to associate with the invoice.
issue_datestring
Date the invoice was issued (YYYY-MM-DD).
line_itemsobject[]Obligatorio
Array of line item objects to include in the invoice.
purchase_orderstring
Purchase order number.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Invoice Item CategoryHARVEST_CREATE_INVOICE_ITEM_CATEGORYAcción

Tool to create a new invoice item category. use after you have decided on the category name to register it in harvest.

Parámetros de entrada

namestringObligatorio
The name of the invoice item category.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Invoice MessageHARVEST_CREATE_INVOICE_MESSAGEAcción

Tool to create a new message for an invoice. use after confirming the invoice id when you need to notify a client with invoice details.

Parámetros de entrada

bodystring
The message body
subjectstring
The message subject
thank_youboolean
If true, send a thank you message email
attach_pdfboolean
If true, attach a PDF of the invoice to the message email
event_typestringenum
Invoice event type: omit or 'send' to send the message; 'close','draft','re-open' for state changes without emailing
closedraftre-opensend
invoice_idintegerObligatorio
ID of the invoice to message
recipientsobject[]
List of message recipients; at least one email is required
send_me_a_copyboolean
If true, send a copy of the message email to the current user
include_link_to_client_invoiceboolean
Deprecated. Ignored if true; if false, clears payment options on the invoice.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Invoice PaymentHARVEST_CREATE_INVOICE_PAYMENTAcción

Tool to create a new payment on an invoice. use when recording a payment against an existing invoice.

Parámetros de entrada

notesstring
Any notes to be associated with the payment.
amountnumberObligatorio
The amount of the payment.
paid_atstring
Date and time the payment was made (ISO 8601). Pass either paid_at or paid_date, but not both.
paid_datestring
Date the payment was made (YYYY-MM-DD). Pass either paid_date or paid_at, but not both.
invoice_idintegerObligatorio
ID of the invoice to add a payment to.
send_thank_youboolean
Whether to send a thank you email (if enabled). Only sends if invoice fully paid. Defaults to true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ProjectHARVEST_CREATE_PROJECTAcción

Tool to create a new project. use after confirming the client exists.

Parámetros de entrada

feenumber
The fee for the project when billing by project.
codestring
The project code.
namestringObligatorio
Name of the project.
notesstring
Any additional notes about the project.
budgetnumber
The monetary budget for the project.
bill_bystringenum
The method by which the project is invoiced.
ProjectTasksPeopleNone
ends_onstringdate
Date the project ends (YYYY-MM-DD).
budget_bystringenum
The method by which the project is budgeted.
projectproject_costtaskpersonnone
client_idintegerObligatorio
ID of the client to associate this project with.
is_activeboolean
Whether the project is active (true) or archived (false). Defaults to true.
starts_onstringdate
Date the project starts (YYYY-MM-DD).
cost_budgetnumber
The monetary cost budget for the project.
hourly_ratenumber
The default hourly rate to use for this project when billing by project.
is_billableboolean
Whether the project is billable. Defaults to true.
is_fixed_feeboolean
Whether the project is a fixed-fee project.
budget_is_monthlyboolean
Whether the budget resets every month.
show_budget_to_allboolean
Whether the budget is visible to all project members.
notify_when_over_budgetboolean
Whether to send a notification when the project exceeds its budget.
cost_budget_include_expensesboolean
Whether expenses are included in the cost budget.
over_budget_notification_percentagenumber
Percentage at which the over budget notification is triggered.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TaskHARVEST_CREATE_TASKAcción

Tool to create a new task. use after identifying task details to register it in harvest.

Parámetros de entrada

namestringObligatorio
The name of the task to create.
is_activeboolean
Specifies if the task is active (true) or archived (false).
is_defaultboolean
Indicates if this task should be automatically added to future projects.
billable_by_defaultboolean
Determines if the task is billable by default when added to a project.
default_hourly_ratenumber
The default hourly rate for this task when added to a project.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Time EntryHARVEST_CREATE_TIME_ENTRYAcción

Tool to create a new time entry. use when logging hours for a project by specifying start/end times or duration.

Parámetros de entrada

hoursnumber
Total hours to log; required when not using start/end times
notesstring
Notes or description of the work performed
task_idintegerObligatorio
ID of the task to associate with the time entry
user_idinteger
ID of the user; defaults to the authenticated user
ended_timestring
Time the entry ended (e.g., '5:00pm'); if omitted, timer remains running
project_idintegerObligatorio
ID of the project to associate with the time entry
spent_datestringObligatorio
Date the time entry was spent (YYYY-MM-DD)
started_timestring
Time the entry started (e.g., '9:00am'); omit ended_time for running timer
external_referenceobject
Links this entry to an external system (task, project, etc.).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create UserHARVEST_CREATE_USERAcción

Tool to create a new user. use after gathering user details to invite them to harvest.

Parámetros de entrada

emailstringObligatorio
The email address of the user.
rolesstring[]
Descriptive names of the business roles assigned to this person. Used for filtering reports, with no impact on permissions.
timezonestring
The user’s timezone. Defaults to the company’s timezone. See supported time zones in the Harvest docs.
cost_ratenumber
The cost rate to use for this user when calculating project costs. Defaults to 0.0.
is_activeboolean
Whether the user is active or archived. Defaults to true.
last_namestringObligatorio
The last name of the user.
first_namestringObligatorio
The first name of the user.
access_rolesstring[]
Access role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager, member, and additional manager roles.
is_contractorboolean
Whether the user is a contractor or an employee. Defaults to false.
weekly_capacityinteger
The number of hours per week this person is available to work in seconds. Defaults to 126000 (35 hours).
default_hourly_ratenumber
The billable rate to use for this user when added to a project. Defaults to 0.0.
has_access_to_all_future_projectsboolean
Whether the user should be automatically added to future projects. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ClientHARVEST_DELETE_CLIENTAcción

Tool to delete a client. use when you need to remove a client that has no associated projects, invoices, or estimates. call after confirming the client id exists and has no dependent resources.

Parámetros de entrada

client_idintegerObligatorio
The ID of the client to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Client ContactHARVEST_DELETE_CLIENT_CONTACTAcción

Tool to delete a client contact. use when you need to remove a contact that is no longer relevant. call after confirming the contact id exists.

Parámetros de entrada

contact_idintegerObligatorio
The ID of the contact to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete EstimateHARVEST_DELETE_ESTIMATEAcción

Tool to delete an estimate. use when you need to remove an estimate that is no longer needed. call after confirming the estimate id exists and has no dependent resources.

Parámetros de entrada

estimate_idintegerObligatorio
The ID of the estimate to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Estimate MessageHARVEST_DELETE_ESTIMATE_MESSAGEAcción

Tool to delete an estimate message. use when you need to remove a message from an estimate. call after confirming estimate id and message id are correct.

Parámetros de entrada

message_idintegerObligatorio
The ID of the message to delete from the estimate.
estimate_idintegerObligatorio
The ID of the estimate.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete InvoiceHARVEST_DELETE_INVOICEAcción

Tool to delete an invoice. use when you need to remove an invoice that has no associated payments. call after confirming the invoice id exists.

Parámetros de entrada

invoice_idintegerObligatorio
The ID of the invoice to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Invoice Item CategoryHARVEST_DELETE_INVOICE_ITEM_CATEGORYAcción

Tool to delete an invoice item category. use when you need to remove an obsolete or incorrect invoice item category. call after confirming the invoice item category id exists.

Parámetros de entrada

invoice_item_category_idintegerObligatorio
The ID of the invoice item category to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Invoice MessageHARVEST_DELETE_INVOICE_MESSAGEAcción

Tool to delete a message from an invoice. use when you need to remove a specific message that is no longer relevant. call after confirming the invoice id and message id.

Parámetros de entrada

invoice_idintegerObligatorio
The ID of the invoice to delete a message from.
message_idintegerObligatorio
The ID of the message to be deleted.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Invoice PaymentHARVEST_DELETE_INVOICE_PAYMENTAcción

Tool to delete an invoice payment. use when you need to remove a payment from an invoice after confirming payment details.

Parámetros de entrada

invoice_idintegerObligatorio
The ID of the invoice containing the payment to delete.
payment_idintegerObligatorio
The ID of the invoice payment to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProjectHARVEST_DELETE_PROJECTAcción

Tool to delete a project. use when you need to remove a project and all its associated time entries and expenses; invoices remain intact. call after confirming the project id exists.

Parámetros de entrada

project_idintegerObligatorio
The ID of the project to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TaskHARVEST_DELETE_TASKAcción

Tool to delete a task. use when you need to remove a task that has no associated time entries. call after confirming the task id exists and has no dependent time entries.

Parámetros de entrada

task_idintegerObligatorio
The ID of the task to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Time EntryHARVEST_DELETE_TIME_ENTRYAcción

Tool to delete a time entry. use when removing an existing time entry that is deletable (not closed or on archived projects/tasks). call after confirming the time entry id exists.

Parámetros de entrada

time_entry_idintegerObligatorio
The ID of the time entry to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete UserHARVEST_DELETE_USERAcción

Tool to delete a user. use when you need to remove a user that has no associated time entries or expenses. call after confirming the user id exists and has no dependent time entries or expenses.

Parámetros de entrada

user_idintegerObligatorio
The ID of the user to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ClientHARVEST_GET_CLIENTAcción

Tool to retrieve a specific client by id. use when you need details of a client before invoicing or reporting.

Parámetros de entrada

client_idintegerObligatorio
The ID of the client to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Client ContactHARVEST_GET_CLIENT_CONTACTAcción

Tool to retrieve a specific client contact. use when you have client id and contact id to fetch and verify contact details.

Parámetros de entrada

client_idintegerObligatorio
ID of the client the contact belongs to.
contact_idintegerObligatorio
ID of the contact to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company InfoHARVEST_GET_COMPANY_INFOAcción

Tool to retrieve information about the authenticated user's company. use after authentication to fetch company settings for display or configuration.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get EstimateHARVEST_GET_ESTIMATEAcción

Tool to retrieve a specific estimate by id. use after confirming the estimate id. example: "get estimate with id 123456".

Parámetros de entrada

estimate_idintegerObligatorio
ID of the estimate to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get InvoiceHARVEST_GET_INVOICEAcción

Tool to retrieve a specific invoice by id. use when you need the full details of an invoice after selecting or creating it. example: 'get invoice with id 13150378.'

Parámetros de entrada

invoice_idintegerObligatorio
Unique ID of the invoice to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectHARVEST_GET_PROJECTAcción

Tool to retrieve a specific harvest project by id. use when you have a project id and need its details.

Parámetros de entrada

project_idintegerObligatorio
The ID of the Harvest project to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TaskHARVEST_GET_TASKAcción

Tool to retrieve a specific task by id. use when you have a task id and need its detailed information.

Parámetros de entrada

task_idintegerObligatorio
Unique ID of the task to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Time EntryHARVEST_GET_TIME_ENTRYAcción

Tool to retrieve a single time entry by id. use when you have a specific time entry id and need its full details.

Parámetros de entrada

time_entry_idintegerObligatorio
The ID of the time entry to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UserHARVEST_GET_USERAcción

Tool to retrieve a specific user by id. use after obtaining a valid user id (for example via list users). example: "get details of user 3230547".

Parámetros de entrada

user_idintegerObligatorio
The unique ID of the user to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Client ContactsHARVEST_LIST_CLIENT_CONTACTSAcción

Tool to list client contacts. use when you need to retrieve contacts with optional filtering and pagination.

Parámetros de entrada

pageinteger
Page number to use in pagination.
per_pageinteger
Number of records to return per page.
client_idinteger
Only return contacts belonging to the client with this ID.
updated_sincestring
Only return contacts updated since this date/time (ISO 8601).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ClientsHARVEST_LIST_CLIENTSAcción

Tool to list clients. use when you need to retrieve a paginated list of clients from harvest. ensure you have a valid access token in metadata before calling.

Parámetros de entrada

pageinteger
DEPRECATED. Page number for pagination. Defaults to 1.
per_pageinteger
The number of records to return per page. Min 1, max 2000. Defaults to 2000.
is_activeboolean
Pass true to only return active clients and false to return inactive clients.
updated_sincestringdate-time
Only return clients that have been updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Estimate MessagesHARVEST_LIST_ESTIMATE_MESSAGESAcción

Tool to list messages for an estimate. use after obtaining an estimate id to retrieve associated messages, supports pagination and filtering by update time.

Parámetros de entrada

pageinteger
DEPRECATED. Page number for pagination. Defaults to 1.
per_pageinteger
Number of records per page, between 1 and 2000. Defaults to 2000.
estimate_idintegerObligatorio
ID of the estimate to retrieve messages for.
updated_sincestringdate-time
Only return estimate messages updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Expense CategoriesHARVEST_LIST_EXPENSE_CATEGORIESAcción

Tool to list expense categories. use when you need to retrieve a paginated list of expense categories, optionally filtering by active status or last update timestamp.

Parámetros de entrada

pageinteger
Page number for pagination.
per_pageinteger
Number of records to return per page (1–2000).
is_activeboolean
Pass true to return only active expense categories; false to return only inactive categories.
updated_sincestringdate-time
Only return expense categories updated since the given date and time (ISO 8601).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Invoice Item CategoriesHARVEST_LIST_INVOICE_ITEM_CATEGORIESAcción

Tool to retrieve invoice item categories. use when you need to fetch a paginated list of invoice item categories in harvest.

Parámetros de entrada

pageinteger
DEPRECATED. Page number for pagination. Defaults to 1.
per_pageinteger
The number of records to return per page. Min 1, max 2000. Defaults to 2000.
updated_sincestringdate-time
Only return invoice item categories that have been updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Invoice MessagesHARVEST_LIST_INVOICE_MESSAGESAcción

Tool to list messages associated with a given invoice. use when you need to retrieve invoice messages with optional filtering by update time and pagination.

Parámetros de entrada

pageinteger
Page number to use in pagination (deprecated, defaults to 1).
per_pageinteger
Number of records to return per page (1-2000, defaults to 2000).
invoice_idintegerObligatorio
ID of the invoice to retrieve messages for.
updated_sincestring
Only return messages updated since this date/time (ISO 8601).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Invoice PaymentsHARVEST_LIST_INVOICE_PAYMENTSAcción

Tool to retrieve payments for a specific invoice. use when you need to list all payments applied to an invoice after confirming the invoice exists.

Parámetros de entrada

pageinteger
DEPRECATED. Page number for pagination (defaults to 1).
per_pageinteger
Number of records per page (1–2000; defaults to 2000).
invoice_idintegerObligatorio
Unique ID of the invoice to retrieve payments for.
updated_sincestringdate-time
Only return invoice payments updated since this date and time (ISO 8601).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List InvoicesHARVEST_LIST_INVOICESAcción

Tool to list invoices. use when you need to retrieve invoices filtered by client, project, date range, or state. example: 'list invoices for client 5735776 from 2023-01-01 to 2023-01-31.'

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1.
statestringenum
Only return invoices with a state matching this value.
draftopenpaidclosed
to_datestringdate
Only return invoices with an issue_date on or before the given date (YYYY-MM-DD).
per_pageinteger
Number of records to return per page. 1–2000. Defaults to 100.
client_idinteger
Only return invoices belonging to the client with the given ID.
from_datestringdate
Only return invoices with an issue_date on or after the given date (YYYY-MM-DD).
project_idinteger
Only return invoices associated with the project with the given ID.
updated_sincestringdate-time
Only return invoices that have been updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List projectsHARVEST_LIST_PROJECTSAcción

Tool to list projects. use when you need to retrieve a paginated list of projects from harvest. ensure a valid access token is present in metadata before calling.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1.
clientinteger
Filter projects by the client ID.
per_pageinteger
Number of records per page. Min 1, max 100. Defaults to 100.
updated_sincestringdate-time
Only return projects updated since the given date/time (ISO 8601).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TasksHARVEST_LIST_TASKSAcción

Tool to list tasks. use when you need to retrieve a paginated list of tasks from harvest. ensure you have a valid access token in metadata before calling.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1.
per_pageinteger
The number of records to return per page. Min 1, max 100. Defaults to 100.
is_activeboolean
Pass true to only return active tasks and false to return archived tasks.
is_defaultboolean
Pass true to only return default tasks.
updated_sincestringdate-time
Only return tasks that have been updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Time EntriesHARVEST_LIST_TIME_ENTRIESAcción

Tool to retrieve a list of time entries. use when you need to fetch tracked hours with filters or date ranges for reporting or invoicing. example: "list time entries for project 123 between 2023-01-01 and 2023-01-31".

Parámetros de entrada

tostringdate
Only return time entries with a spent_date on or before this date (YYYY-MM-DD).
pageinteger
Page number for pagination.
task_idinteger
Only return time entries belonging to the task with the given ID.
user_idinteger
Only return time entries belonging to the user with the given ID.
per_pageinteger
Number of records to return per page (1–2000).
client_idinteger
Only return time entries belonging to the client with the given ID.
from_datestringdate
Only return time entries with a spent_date on or after this date (YYYY-MM-DD).
is_billedboolean
Pass true to return invoiced entries, false for unbilled entries.
is_runningboolean
Pass true to return running timers, false for stopped entries.
project_idinteger
Only return time entries belonging to the project with the given ID.
updated_sincestringdate-time
Only return time entries updated since this date and time (ISO 8601).
external_reference_idstring
Only return time entries with the given external reference ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersHARVEST_LIST_USERSAcción

Tool to list users. use when you need to retrieve a paginated list of users from harvest.

Parámetros de entrada

pageinteger
DEPRECATED. Page number for pagination. Defaults to 1.
per_pageinteger
The number of records to return per page. Min 1, max 2000. Defaults to 2000.
is_activeboolean
Pass true to only return active users and false to return inactive users.
updated_sincestringdate-time
Only return users that have been updated since the given date and time, in ISO 8601 format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ClientHARVEST_UPDATE_CLIENTAcción

Tool to update an existing client. use after retrieving client details to modify its properties. supports partial updates; omit fields to leave them unchanged.

Parámetros de entrada

namestring
A textual description of the client.
addressstring
The client's physical address. May include new line characters.
currencystring
ISO currency code for the client.
client_idintegerObligatorio
Unique ID of the client to update
is_activeboolean
Whether the client is active or archived.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Client ContactHARVEST_UPDATE_CLIENT_CONTACTAcción

Tool to update a client contact. use when you have a contact id and need to modify its details.

Parámetros de entrada

emailanyemail
Contact's email address.
titlestring
Title of the contact (e.g., 'Director of Ops').
last_namestring
Last name of the contact.
contact_idintegerObligatorio
ID of the contact to update.
first_namestring
First name of the contact.
phone_mobilestring
Contact's mobile phone number.
phone_officestring
Contact's office phone number.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Company InfoHARVEST_UPDATE_COMPANY_INFOAcción

Tool to update information about the company. use to modify company settings such as name, timezone, or formatting options. use after obtaining current settings to apply changes.

Parámetros de entrada

namestring
The name of the company.
currencystring
The ISO currency code for the company.
timezonestring
The timezone for the company, in IANA format.
color_schemestring
Color scheme for the Harvest UI (e.g., 'green', 'blue').
decimal_symbolstring
Character used as a decimal separator in amounts.
week_start_daystringenum
The day the week begins in the company settings.
SaturdaySundayMonday
thousands_separatorstring
Character used to separate thousands in amounts.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update EstimateHARVEST_UPDATE_ESTIMATEAcción

Tool to update an existing estimate. use when you need to modify specific fields of an estimate; omit parameters to leave other fields unchanged.

Parámetros de entrada

taxnumber
First tax percentage applied to the subtotal, e.g., 10.0 for 10%.
tax2number
Second tax percentage applied to the subtotal, e.g., 5.0 for 5%.
notesstring
Additional notes for the estimate.
numberstring
Custom estimate number. Auto-generated if omitted.
subjectstring
Estimate subject line.
currencystring
Currency code for the estimate; defaults to client's currency.
discountnumber
Discount percentage subtracted from the subtotal, e.g., 15.0 for 15%.
client_idinteger
The ID of the client this estimate belongs to.
issue_datestring
Date the estimate was issued (YYYY-MM-DD).
line_itemsobject[]
List of line items to update or add. Omit unchanged items.
estimate_idintegerObligatorio
Unique ID of the estimate to update.
purchase_orderstring
The purchase order number.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Estimate Item CategoryHARVEST_UPDATE_ESTIMATE_ITEM_CATEGORYAcción

Tool to update an estimate item category. use after retrieving the category to change its name.

Parámetros de entrada

namestring
The new name for the estimate item category.
estimate_item_category_idintegerObligatorio
Unique ID of the estimate item category to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ExpenseHARVEST_UPDATE_EXPENSEAcción

Tool to update an existing expense. use after retrieving an expense to modify project, category, date, cost, or delete a receipt; omit fields to leave unchanged.

Parámetros de entrada

notesstring
Notes or description for the expense.
unitsnumber
Quantity of units used to calculate the expense total.
billableboolean
Whether the expense is billable.
expense_idintegerObligatorio
Unique ID of the expense to update
project_idinteger
ID of the project associated with this expense.
spent_datestring
Date the expense occurred (YYYY-MM-DD)
total_costnumber
Total amount of the expense.
delete_receiptboolean
Pass true to delete the attached receipt.
expense_category_idinteger
ID of the expense category for this expense.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update InvoiceHARVEST_UPDATE_INVOICEAcción

Tool to update an existing invoice. use after retrieving invoice details to modify its fields. supports partial updates; omit fields to leave unchanged.

Parámetros de entrada

taxnumber
Tax percentage applied to the invoice.
tax2number
Additional tax percentage applied.
notesstring
Additional notes to include on the invoice.
numberstring
Custom invoice number.
subjectstring
The invoice subject.
currencystring
Currency code (e.g., USD).
discountnumber
Discount percentage applied to the invoice.
due_datestringdate
Date the invoice is due (YYYY-MM-DD).
client_idinteger
ID of the client this invoice belongs to.
invoice_idintegerObligatorio
Unique ID of the invoice to update.
issue_datestringdate
Date the invoice was issued (YYYY-MM-DD).
line_itemsobject[]
Array of line item objects to update or add.
estimate_idinteger
ID of the estimate associated with this invoice.
retainer_idinteger
ID of the retainer associated with this invoice.
payment_termstringenum
Payment timeframe: 'upon receipt', 'net 15', 'net 30', 'net 45', or 'net 60'.
upon receiptnet 15net 30net 45net 60
purchase_orderstring
The purchase order number.
payment_optionsstring[]
Payment options available: 'ach', 'credit_card', or 'paypal'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ProjectHARVEST_UPDATE_PROJECTAcción

Tool to update an existing project. use when you need to modify one or more fields of a project by its id. invoke after confirming the project id and desired changes.

Parámetros de entrada

feenumber
Fixed-fee amount to invoice for fixed-fee projects
codestring
Project code identifier
namestring
Name of the project
notesstring
Project notes or description
budgetnumber
Time budget in hours when budgeting by hours
bill_bystringenum
Billing method: 'Project', 'Tasks', 'People', or 'none'
ProjectTasksPeoplenone
ends_onstringdate
Project end date (YYYY-MM-DD)
budget_bystringenum
Budgeting method: 'project' (hours per project), 'project_cost' (total fees), 'task' (hours per task), 'task_fees' (fees per task), 'person' (hours per person), or 'none'
projectproject_costtasktask_feespersonnone
client_idinteger
ID of the client to associate this project with
is_activeboolean
Whether the project is active (true) or archived (false)
starts_onstringdate
Project start date (YYYY-MM-DD)
project_idintegerObligatorio
Unique ID of the project to update
cost_budgetnumber
Monetary budget when budgeting by money
hourly_ratenumber
Hourly rate when billed by project hourly rate
is_billableboolean
Whether time on this project is billable
is_fixed_feeboolean
Whether this is a fixed-fee project
budget_is_monthlyboolean
If true, reset budget each month; defaults to false
show_budget_to_allboolean
Show budget to all employees; defaults to false
notify_when_over_budgetboolean
Email managers when over budget; defaults to false
cost_budget_include_expensesboolean
Include tracked expenses in 'project_cost' budgets; defaults to false
over_budget_notification_percentagenumber
Threshold percent to trigger over-budget alerts (e.g., 80.0)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TaskHARVEST_UPDATE_TASKAcción

Tool to update an existing task. use after retrieving task details to modify its attributes such as name, billing defaults, or status. supports partial updates; omit fields to leave them unchanged.

Parámetros de entrada

namestring
New name for the task.
task_idintegerObligatorio
Unique ID of the task to update
is_activeboolean
Whether this task is active (true) or archived (false).
is_defaultboolean
Whether this task should be automatically added to future projects.
billable_by_defaultboolean
Whether new projects with this task are billable by default.
default_hourly_ratenumber
Default hourly rate when this task is added to a project.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Time EntryHARVEST_UPDATE_TIME_ENTRYAcción

Tool to update an existing time entry. use after retrieving the entry to adjust hours, notes, project, or task details. supports partial updates; omit fields to leave unchanged.

Parámetros de entrada

hoursnumber
The updated number of hours for the time entry.
notesstring
The updated notes for the time entry.
task_idinteger
ID of the task associated with the time entry.
ended_timestring
The time the entry ended (e.g., '5:00pm'); if omitted, timer remains running
project_idinteger
ID of the project associated with the time entry.
spent_datestring
The date the time entry was spent (YYYY-MM-DD)
started_timestring
The time the entry started (e.g., '9:00am'); omit ended_time for running timer
time_entry_idintegerObligatorio
Unique ID of the time entry to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update UserHARVEST_UPDATE_USERAcción

Tool to update an existing user. use when you need to modify a user's profile or settings after confirming the user id.

Parámetros de entrada

emailstring
The email address of the user. Cannot be updated if the user is inactive.
rolesstring[]
Descriptive names of the business roles assigned to this person. Used for filtering reports, with no impact on permissions.
user_idintegerObligatorio
Unique ID of the user to update
timezonestring
The user’s timezone. Defaults to the company’s timezone. See supported time zones in the Harvest docs.
is_activeboolean
Whether the user is active or archived.
last_namestring
The last name of the user. Cannot be updated if the user is inactive.
first_namestring
The first name of the user. Cannot be updated if the user is inactive.
access_rolesstring[]
Access roles that determine the user’s permissions in Harvest. Possible values: administrator, manager, member, project_creator, billable_rates_manager, managed_projects_invoice_drafter, managed_projects_invoice_manager, client_and_task_manager, time_and_expenses_manager, estimates_manager.
is_contractorboolean
Whether the user is a contractor or an employee. Defaults to false.
weekly_capacityinteger
The number of hours per week this person is available to work, in seconds. Must be non-negative.
has_access_to_all_future_projectsboolean
Whether the user should be automatically added to future projects. Defaults to false.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not