Clientary
clientaryA full-suite platform to manage Clients, Invoices, Projects, Proposals, Estimates, Hours, Payments, Contractors and Staff. The perfect solution to win clients and save time.
Acciones disponibles (42)
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 ClientCLIENTARY_CREATE_CLIENTAcciónTool to create a new client record in Clientary. Use when you need to add a new client to the system with company details and contact information.
CLIENTARY_CREATE_CLIENTAcciónTool to create a new client record in Clientary. Use when you need to add a new client to the system with company details and contact information.
Parámetros de entrada
zipstringPostal code or ZIP code
citystringCity name
namestringObligatorioThe client's company or organization name (required)
statestringState or province
numberstringA unique identifier for the client. Must be unique across all clients
addressstringStreet address of the client
countrystringCountry code or country name
websitestringCompany website URL
address_2stringSecondary address line (e.g., suite number, apartment number)
descriptionstringAdditional details or notes about the client
invoice_extra_fieldsobjectCustom invoice fields as key-value pairs
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ContactCLIENTARY_CREATE_CONTACTAcciónTool to create a new contact within a specified client. Use when you need to add a contact to a client account with name and email as required fields.
CLIENTARY_CREATE_CONTACTAcciónTool to create a new contact within a specified client. Use when you need to add a contact to a client account with name and email as required fields.
Parámetros de entrada
client_idintegerObligatorioThe ID of the client to which the contact belongs.
client_userobjectObligatorioClient user data containing contact information.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ExpenseCLIENTARY_CREATE_EXPENSEAcciónTool to create a new expense record in Clientary to track expenditures within your account. Use when you need to record expenses, optionally assigning them to specific clients or projects. Requires an amount field.
CLIENTARY_CREATE_EXPENSEAcciónTool to create a new expense record in Clientary to track expenditures within your account. Use when you need to record expenses, optionally assigning them to specific clients or projects. Requires an amount field.
Parámetros de entrada
amountnumberObligatorioThe expenditure amount. This is a required field.
client_idintegerAssigns the expense to a specific client. Optional field.
project_idintegerAssigns the expense to a particular project. Optional field.
descriptionstringDetails about the expense. Optional field.
incurred_onstringThe date the expense occurred, in YYYY-MM-DD format. Optional field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create LeadCLIENTARY_CREATE_LEADAcciónTool to create a new lead record in Clientary. Use when you need to add a new lead to the system with company details and contact information.
CLIENTARY_CREATE_LEADAcciónTool to create a new lead record in Clientary. Use when you need to add a new lead to the system with company details and contact information.
Parámetros de entrada
zipstringPostal code or ZIP code
citystringCity name
namestringObligatorioThe lead's company or organization name (required)
statestringState or province
numberstringA unique identifier for the lead. Must be unique across all leads
addressstringStreet address of the lead
countrystringCountry code or country name
websitestringCompany website URL
address_2stringSecondary address line (e.g., suite number, apartment number)
descriptionstringAdditional details or notes about the lead
invoice_extra_fieldsobjectCustom invoice fields as key-value pairs
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ProjectCLIENTARY_CREATE_PROJECTAcciónTool to create a new project in Clientary with name and rate. Use when you need to set up a new project for tracking time, expenses, or managing client work.
CLIENTARY_CREATE_PROJECTAcciónTool to create a new project in Clientary with name and rate. Use when you need to set up a new project for tracking time, expenses, or managing client work.
Parámetros de entrada
projectobjectObligatorioProject data containing name, rate, and optional budget/project type fields
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TaskCLIENTARY_CREATE_TASKAcciónTool to create a new task in Clientary. Use when you need to create a task with a title, optionally associating it with a project and assignee.
CLIENTARY_CREATE_TASKAcciónTool to create a new task in Clientary. Use when you need to create a task with a title, optionally associating it with a project and assignee.
Parámetros de entrada
titlestringObligatorioThe task's title/name.
due_datestringTask deadline in date format (e.g., YYYY-MM-DD).
project_idintegerAssociates task with a specific project. Provide the project ID.
assignee_idintegerAssigns task to a staff member. Provide the staff member's ID.
descriptionstringAdditional task details or notes.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ClientCLIENTARY_DELETE_CLIENTAcciónTool to remove a client and all associated projects, invoices, estimates, and contacts. Use when you need to permanently delete a client from Clientary. WARNING: Deletions are permanent and not reversible.
CLIENTARY_DELETE_CLIENTAcciónTool to remove a client and all associated projects, invoices, estimates, and contacts. Use when you need to permanently delete a client from Clientary. WARNING: Deletions are permanent and not reversible.
Parámetros de entrada
idstringObligatorioThe unique identifier of the client to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete LeadCLIENTARY_DELETE_LEADAcciónTool to permanently delete a lead and all associated Estimates and Contacts. Use when you need to remove a lead that is no longer needed. Warning: This action is irreversible.
CLIENTARY_DELETE_LEADAcciónTool to permanently delete a lead and all associated Estimates and Contacts. Use when you need to remove a lead that is no longer needed. Warning: This action is irreversible.
Parámetros de entrada
idstringObligatorioThe unique identifier of the lead to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete PaymentCLIENTARY_DELETE_PAYMENTAcciónTool to remove an existing payment from an invoice. Use when you need to permanently delete a payment record. WARNING: Deletions are permanent and not reversible.
CLIENTARY_DELETE_PAYMENTAcciónTool to remove an existing payment from an invoice. Use when you need to permanently delete a payment record. WARNING: Deletions are permanent and not reversible.
Parámetros de entrada
idstringObligatorioThe unique identifier of the payment record to delete
invoice_idstringObligatorioThe unique identifier of the invoice containing the payment
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Payment ProfileCLIENTARY_DELETE_PAYMENT_PROFILEAcciónTool to remove a specific payment profile from a client's account. Use when you need to delete a payment profile. Note: Client must have an active payment integration with Stripe to manage payment profiles.
CLIENTARY_DELETE_PAYMENT_PROFILEAcciónTool to remove a specific payment profile from a client's account. Use when you need to delete a payment profile. Note: Client must have an active payment integration with Stripe to manage payment profiles.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the payment profile to delete
client_idintegerObligatorioThe unique identifier of the client who owns the payment profile
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Recurring ScheduleCLIENTARY_DELETE_RECURRING_SCHEDULEAcciónTool to remove a recurring schedule by its identifier. Use when you need to permanently delete a recurring schedule from Clientary. Once deleted, the recurring schedule will no longer generate periodic invoices.
CLIENTARY_DELETE_RECURRING_SCHEDULEAcciónTool to remove a recurring schedule by its identifier. Use when you need to permanently delete a recurring schedule from Clientary. Once deleted, the recurring schedule will no longer generate periodic invoices.
Parámetros de entrada
idstringObligatorioThe unique identifier of the recurring schedule to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ClientCLIENTARY_GET_CLIENTAcciónTool to fetch details for a specific client using its ID. Use when you need to retrieve complete information about a client from Clientary.
CLIENTARY_GET_CLIENTAcciónTool to fetch details for a specific client using its ID. Use when you need to retrieve complete information about a client from Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the client to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactCLIENTARY_GET_CONTACTAcciónTool to retrieve a single contact by its ID. Use when you need to fetch detailed information about a specific contact from Clientary.
CLIENTARY_GET_CONTACTAcciónTool to retrieve a single contact by its ID. Use when you need to fetch detailed information about a specific contact from Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the contact to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get EstimateCLIENTARY_GET_ESTIMATEAcciónTool to retrieve details for a single estimate by ID. Use when you need to obtain comprehensive estimate information including line items, tax details, and financial data.
CLIENTARY_GET_ESTIMATEAcciónTool to retrieve details for a single estimate by ID. Use when you need to obtain comprehensive estimate information including line items, tax details, and financial data.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the estimate to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ExpenseCLIENTARY_GET_EXPENSEAcciónTool to retrieve details for a single expense record in Clientary. Use when you need to get specific information about an expense by its unique identifier.
CLIENTARY_GET_EXPENSEAcciónTool to retrieve details for a single expense record in Clientary. Use when you need to get specific information about an expense by its unique identifier.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the expense to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Hour EntryCLIENTARY_GET_HOURAcciónTool to obtain details about a specific time entry in Clientary. Use when you need to retrieve information about a logged hour entry by its unique identifier.
CLIENTARY_GET_HOURAcciónTool to obtain details about a specific time entry in Clientary. Use when you need to retrieve information about a logged hour entry by its unique identifier.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the hours entry to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get InvoiceCLIENTARY_GET_INVOICEAcciónTool to retrieve detailed information for a specific invoice by ID. Use when you need to fetch invoice details including line items, payments, tax information, and current status.
CLIENTARY_GET_INVOICEAcciónTool to retrieve detailed information for a specific invoice by ID. Use when you need to fetch invoice details including line items, payments, tax information, and current status.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the invoice to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get LeadCLIENTARY_GET_LEADAcciónTool to retrieve a single lead by its ID. Use when you need to fetch detailed information about a specific lead from Clientary.
CLIENTARY_GET_LEADAcciónTool to retrieve a single lead by its ID. Use when you need to fetch detailed information about a specific lead from Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the lead to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProjectCLIENTARY_GET_PROJECTAcciónTool to retrieve a single project by its identifier. Use when you need to fetch detailed information about a specific project in Clientary.
CLIENTARY_GET_PROJECTAcciónTool to retrieve a single project by its identifier. Use when you need to fetch detailed information about a specific project in Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the project to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get StaffCLIENTARY_GET_STAFFAcciónTool to retrieve a single staff member by their ID. Use when you need to fetch detailed information about a specific staff member from Clientary.
CLIENTARY_GET_STAFFAcciónTool to retrieve a single staff member by their ID. Use when you need to fetch detailed information about a specific staff member from Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the staff member to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TaskCLIENTARY_GET_TASKAcciónTool to retrieve a specific task by its ID. Use when you need to fetch detailed information about a task from Clientary.
CLIENTARY_GET_TASKAcciónTool to retrieve a specific task by its ID. Use when you need to fetch detailed information about a task from Clientary.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the task to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Client ContactsCLIENTARY_LIST_CLIENT_CONTACTSAcciónTool to retrieve all contacts for a specific client with pagination support. Use when you need to fetch the list of contacts associated with a particular client in Clientary.
CLIENTARY_LIST_CLIENT_CONTACTSAcciónTool to retrieve all contacts for a specific client with pagination support. Use when you need to fetch the list of contacts associated with a particular client in Clientary.
Parámetros de entrada
pageintegerPage number for pagination. Default is 1.
client_idintegerObligatorioThe unique identifier for the client whose contacts you want to retrieve.
page_sizeintegerNumber of results per page. Default is 10, maximum is 100.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Client ExpensesCLIENTARY_LIST_CLIENT_EXPENSESAcciónTool to retrieve all expenses for a specific client within an optional date range. Use when you need to fetch expense records associated with a particular client from Clientary.
CLIENTARY_LIST_CLIENT_EXPENSESAcciónTool to retrieve all expenses for a specific client within an optional date range. Use when you need to fetch expense records associated with a particular client from Clientary.
Parámetros de entrada
to_datestringEnd date for expense range in YYYY-MM-DD format. Defaults to current fiscal year end if omitted
client_idintegerObligatorioThe unique identifier of the client whose expenses to retrieve
from_datestringStart date for expense range in YYYY-MM-DD format. Defaults to current fiscal year start if omitted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Client InvoicesCLIENTARY_LIST_CLIENT_INVOICESAcciónTool to retrieve all invoices for a specific client with pagination support (30 results per page). Use when you need to fetch invoices associated with a particular client from Clientary.
CLIENTARY_LIST_CLIENT_INVOICESAcciónTool to retrieve all invoices for a specific client with pagination support (30 results per page). Use when you need to fetch invoices associated with a particular client from Clientary.
Parámetros de entrada
pageintegerPage number for pagination. Returns 30 results per page
client_idintegerObligatorioThe unique identifier of the client whose invoices to retrieve
updated_sincestringFilter invoices by update timestamp. Format: YYYY-MM-DD
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Client ProjectsCLIENTARY_LIST_CLIENT_PROJECTSAcciónTool to retrieve all projects associated with a specific client with pagination support (10 results per page). Use when you need to fetch projects for a particular client from Clientary.
CLIENTARY_LIST_CLIENT_PROJECTSAcciónTool to retrieve all projects associated with a specific client with pagination support (10 results per page). Use when you need to fetch projects for a particular client from Clientary.
Parámetros de entrada
pageintegerPage number for pagination. Defaults to page 1 with 10 results per page
client_idintegerObligatorioThe unique identifier of the client whose projects you want to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ClientsCLIENTARY_LIST_CLIENTSAcciónTool to retrieve all clients with pagination support (10 results per page). Use when you need to fetch a list of clients from Clientary with optional filtering by modification date or custom sorting.
CLIENTARY_LIST_CLIENTSAcciónTool to retrieve all clients with pagination support (10 results per page). Use when you need to fetch a list of clients from Clientary with optional filtering by modification date or custom sorting.
Parámetros de entrada
pageintegerPage number to retrieve. Default is page 1 with 10 results per page
sortstringSort order for results. Use 'date' to retrieve most recently created clients instead of default alphabetical name-based sorting
updated_sincestringFilter clients modified after this date. Format: YYYY-MM-DD
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ExpensesCLIENTARY_LIST_EXPENSESAcciónTool to retrieve expenses by date range (defaults to current fiscal year). Use when you need to fetch a list of expenses from Clientary with optional filtering by start and end dates.
CLIENTARY_LIST_EXPENSESAcciónTool to retrieve expenses by date range (defaults to current fiscal year). Use when you need to fetch a list of expenses from Clientary with optional filtering by start and end dates.
Parámetros de entrada
to_datestringEnd date for expense range in YYYY-MM-DD format. If not specified, defaults to the end of the current fiscal year
from_datestringStart date for expense range in YYYY-MM-DD format. If not specified, defaults to the beginning of the current fiscal year
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List LeadsCLIENTARY_LIST_LEADSAcciónTool to retrieve all leads with pagination support. Use when you need to fetch a list of leads from Clientary with optional sorting by name or date.
CLIENTARY_LIST_LEADSAcciónTool to retrieve all leads with pagination support. Use when you need to fetch a list of leads from Clientary with optional sorting by name or date.
Parámetros de entrada
pageintegerPage number to retrieve. Pagination through more results, you can use the page parameter
sortstringSort order options: 'name' (alphabetical) or 'oldest' (chronological ascending); default sorts by newest first
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsCLIENTARY_LIST_PAYMENTSAcciónTool to retrieve all payments with pagination support (30 results per page). Use when you need to fetch a list of payments from Clientary with optional pagination and custom sorting.
CLIENTARY_LIST_PAYMENTSAcciónTool to retrieve all payments with pagination support (30 results per page). Use when you need to fetch a list of payments from Clientary with optional pagination and custom sorting.
Parámetros de entrada
pageintegerPage number to retrieve. Default is page 1 with 30 results per page
sortstringSort field. Accepts 'created_at' to sort by creation date. Defaults to reverse chronological order by 'received_on'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Project EstimatesCLIENTARY_LIST_PROJECT_ESTIMATESAcciónTool to retrieve estimates scoped to a particular project with pagination support (30 results per page). Use when you need to fetch all estimates associated with a specific project.
CLIENTARY_LIST_PROJECT_ESTIMATESAcciónTool to retrieve estimates scoped to a particular project with pagination support (30 results per page). Use when you need to fetch all estimates associated with a specific project.
Parámetros de entrada
pageintegerPage number for pagination. Returns 30 results per page. Defaults to page 1
project_idintegerObligatorioThe unique identifier of the project whose estimates you want to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Project ExpensesCLIENTARY_LIST_PROJECT_EXPENSESAcciónTool to retrieve all expenses for a specific project within an optional date range. Use when you need to fetch expense records associated with a particular project from Clientary.
CLIENTARY_LIST_PROJECT_EXPENSESAcciónTool to retrieve all expenses for a specific project within an optional date range. Use when you need to fetch expense records associated with a particular project from Clientary.
Parámetros de entrada
pageintegerPage number for pagination. Use this to retrieve additional pages if the result set is large
to_datestringEnd date for expense range in YYYY-MM-DD format. Defaults to current fiscal year end if omitted
from_datestringStart date for expense range in YYYY-MM-DD format. Defaults to current fiscal year start if omitted
project_idintegerObligatorioThe unique identifier of the project whose expenses to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Project HoursCLIENTARY_LIST_PROJECT_HOURSAcciónTool to retrieve all time tracking entries logged against a specific project. Use when you need to fetch hour entries for a particular project, optionally filtering by billed or unbilled status.
CLIENTARY_LIST_PROJECT_HOURSAcciónTool to retrieve all time tracking entries logged against a specific project. Use when you need to fetch hour entries for a particular project, optionally filtering by billed or unbilled status.
Parámetros de entrada
filterstringNarrows results to either 'billed' or 'unbilled' hours. Note: The user associated with the API token must have appropriate permissions to view billed/unbilled hour information
project_idintegerObligatorioThe unique identifier of the project for which to retrieve hour entries
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Project InvoicesCLIENTARY_LIST_PROJECT_INVOICESAcciónTool to retrieve all invoices linked to a specific project with pagination support (30 results per page). Use when you need to fetch invoices associated with a particular project from Clientary.
CLIENTARY_LIST_PROJECT_INVOICESAcciónTool to retrieve all invoices linked to a specific project with pagination support (30 results per page). Use when you need to fetch invoices associated with a particular project from Clientary.
Parámetros de entrada
pageintegerPage number for pagination. Returns 30 results per page. Defaults to page 1
project_idintegerObligatorioThe unique identifier of the project whose invoices to retrieve
updated_sincestringFilter invoices by update timestamp. Format: YYYY-MM-DD
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProjectsCLIENTARY_LIST_PROJECTSAcciónTool to retrieve all projects with pagination support (10 results per page). Use when you need to fetch a list of projects from Clientary with optional filtering for closed projects.
CLIENTARY_LIST_PROJECTSAcciónTool to retrieve all projects with pagination support (10 results per page). Use when you need to fetch a list of projects from Clientary with optional filtering for closed projects.
Parámetros de entrada
pageintegerPage number to retrieve. Default is page 1 with 10 results per page
filterstringUse 'all' to include closed projects alongside active/billable ones. By default, only active and billable projects are returned
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List StaffCLIENTARY_LIST_STAFFAcciónTool to retrieve all staff members for an account. Use when you need to fetch a complete list of staff members from Clientary.
CLIENTARY_LIST_STAFFAcciónTool to retrieve all staff members for an account. Use when you need to fetch a complete list of staff members from Clientary.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TasksCLIENTARY_LIST_TASKSAcciónTool to retrieve all tasks with pagination support (50 results per page). Use when you need to fetch a list of tasks from Clientary.
CLIENTARY_LIST_TASKSAcciónTool to retrieve all tasks with pagination support (50 results per page). Use when you need to fetch a list of tasks from Clientary.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send Invoice MessageCLIENTARY_SEND_INVOICE_MESSAGEAcciónTool to send an invoice message to recipients via email. Use when you need to email an invoice to clients with customizable subject, message content, and options to send a copy to yourself or attach a PDF.
CLIENTARY_SEND_INVOICE_MESSAGEAcciónTool to send an invoice message to recipients via email. Use when you need to email an invoice to clients with customizable subject, message content, and options to send a copy to yourself or attach a PDF.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the invoice to send
messagestringEmail body content. If not provided, a default message will be used.
subjectstringEmail subject line. If not provided, a default subject will be used.
send_copyintegerSet to 1 to send a copy of the email to the API token user. Set to 0 or omit to not send a copy.
attach_pdfintegerSet to 1 to include a PDF attachment of the invoice with the email. Set to 0 or omit to not attach PDF.
recipientsstring[]ObligatorioAn array of email addresses to receive the invoice. At least one recipient is required.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ClientCLIENTARY_UPDATE_CLIENTAcciónTool to update an existing client record in Clientary with partial or complete field modifications. Use when you need to modify client details such as name, address, description, or custom fields. All fields except ID are optional.
CLIENTARY_UPDATE_CLIENTAcciónTool to update an existing client record in Clientary with partial or complete field modifications. Use when you need to modify client details such as name, address, description, or custom fields. All fields except ID are optional.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the client to update
zipstringPostal code. Include to update the postal code.
citystringCity location. Include to update the city.
namestringClient company or organization name. Include to update the name.
statestringState or province. Include to update the state.
numberstringClient reference number. Must be unique across all clients. Returns HTTP 422 on duplicate.
addressstringPrimary street address. Include to update the address.
countrystringCountry code (e.g., 'US'). Include to update the country.
websitestringClient website URL. Include to update the website.
address_2stringSecondary address line (suite, unit, etc.). Include to update the secondary address.
descriptionstringAdditional client notes or details. Include to update the description.
invoice_extra_fieldsobjectCustom invoice field data as key-value pairs. Include to update custom fields.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ExpenseCLIENTARY_UPDATE_EXPENSEAcciónTool to update an existing expense record in Clientary with partial or complete field modifications. Use when you need to modify expense details such as amount, description, client assignment, project assignment, or incurred date. All fields except ID are optional.
CLIENTARY_UPDATE_EXPENSEAcciónTool to update an existing expense record in Clientary with partial or complete field modifications. Use when you need to modify expense details such as amount, description, client assignment, project assignment, or incurred date. All fields except ID are optional.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the expense to update
amountnumberThe monetary value of the expense. Include to update the amount.
client_idintegerClient assignment identifier. Include to update the associated client.
project_idintegerProject assignment identifier. Include to update the associated project.
descriptionstringExpense description. Include to update the description.
incurred_onstringDate when expense was incurred in YYYY-MM-DD format. Include to update the date.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Hour EntryCLIENTARY_UPDATE_HOURAcciónTool to modify an existing time entry in Clientary with partial or complete field updates. Use when you need to update hours, title, date, description, rate, or billing status of a logged hour entry.
CLIENTARY_UPDATE_HOURAcciónTool to modify an existing time entry in Clientary with partial or complete field updates. Use when you need to update hours, title, date, description, rate, or billing status of a logged hour entry.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the hours entry to update
datestringWork date in YYYY/MM/DD format. Optional for partial updates.
ratenumberBilling rate per hour. Optional for partial updates.
hoursnumberDuration of work logged in hours. Optional for partial updates.
titlestringName or label for the time entry. Optional for partial updates.
billedbooleanBilling status indicator. Optional for partial updates.
descriptionstringDetailed notes about work performed. Optional for partial updates.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProjectCLIENTARY_UPDATE_PROJECTAcciónTool to update an existing project in Clientary with partial or complete field modifications. Use when you need to modify project details such as name, rate, description, budget, status, or other project attributes. All fields except ID are optional - only provided fields will be updated.
CLIENTARY_UPDATE_PROJECTAcciónTool to update an existing project in Clientary with partial or complete field modifications. Use when you need to modify project details such as name, rate, description, budget, status, or other project attributes. All fields except ID are optional - only provided fields will be updated.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the project to update
namestringThe project name. Include to update the project name.
ratenumberProject rate (hourly rate or total cost depending on project type). Include to update the rate.
budgetnumberBudget amount. Include to update the budget.
numberstringUnique project number. Include to update the project number. Note: triggers HTTP 422 if duplicate.
statusintegerProject status code. Include to update the status.
end_datestringProject end date in YYYY-MM-DD format. Include to update the end date.
budget_typeintegerBudget type: 0 = total budgeted hours; 1 = total budgeted amount. Include to update the budget type.
descriptionstringProject description. Include to update the description.
project_typeintegerProject type: 0 = hourly rate project; 2 = fixed amount project. Include to update the project type.
currency_codestringCurrency code (e.g., USD, EUR, GBP). Include to update the currency code.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TaskCLIENTARY_UPDATE_TASKAcciónTool to update an existing task in Clientary with partial or complete field modifications. Use when you need to modify task details such as title, description, completion status, assignee, or due date. All fields except ID are optional.
CLIENTARY_UPDATE_TASKAcciónTool to update an existing task in Clientary with partial or complete field modifications. Use when you need to modify task details such as title, description, completion status, assignee, or due date. All fields except ID are optional.
Parámetros de entrada
idintegerObligatorioThe unique identifier of the task to update
titlestringTask title/name. Include to update the title.
completebooleanTask completion status (true/false). Include to update completion status.
due_datestringTask deadline in date format (e.g., YYYY-MM-DD). Include to update due date.
client_idintegerRelated client ID. Include to update client association.
project_idintegerAssociated project ID. Include to update project association.
assignee_idintegerStaff member ID assigned to task. Include to update assignee.
descriptionstringDetailed task information. Include to update the description.
completed_atstringTimestamp when task was marked complete. Include to update completion timestamp.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not