Skip to main content
Clientary logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 57
  • Triggers: 0
  • Slug: CLIENTARY
  • Version: 20261101_00

Tools

Slug: CLIENTARY_CREATE_CLIENTTool 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.

Input Parameters

string
Postal code or ZIP code
string
City name
string
required
The client’s company or organization name (required)
string
State or province
string
A unique identifier for the client. Must be unique across all clients
string
Street address of the client
string
Country code or country name
string
Company website URL
string
Secondary address line (e.g., suite number, apartment number)
string
Additional details or notes about the client
object
Custom invoice fields as key-value pairs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_CONTACTTool 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.

Input Parameters

integer
required
The ID of the client to which the contact belongs.
object
required
Client user data containing contact information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_EXPENSETool 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.

Input Parameters

number
required
The expenditure amount. This is a required field.
integer
Assigns the expense to a specific client. Optional field.
integer
Assigns the expense to a particular project. Optional field.
string
Details about the expense. Optional field.
string
The date the expense occurred, in YYYY-MM-DD format. Optional field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_INVOICETool to create a new invoice in Clientary. Requires date, due_date, and currency_code. Optionally associate with a client using client_id.

Input Parameters

string
Purchase order reference number
string
required
Invoice date in YYYY-MM-DD format (required)
string
Additional notes or comments for the invoice
string
Invoice title or subject
string
Invoice number. Will be auto-incremented if not provided. Must be unique.
string
required
Payment due date in YYYY-MM-DD format (required)
integer
Client ID to associate with the invoice (optional)
string
required
Three-letter ISO currency code (e.g., USD, EUR, GBP) (required)
array
Array of invoice items to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_LEADTool 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.

Input Parameters

string
Postal code or ZIP code
string
City name
string
required
The lead’s company or organization name (required)
string
State or province
string
A unique identifier for the lead. Must be unique across all leads
string
Street address of the lead
string
Country code or country name
string
Company website URL
string
Secondary address line (e.g., suite number, apartment number)
string
Additional details or notes about the lead
object
Custom invoice fields as key-value pairs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_PROJECTTool 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.

Input Parameters

object
required
Project data containing name, rate, and optional budget/project type fields

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_PROJECT_HOURSTool to create a new time entry for a specific project in Clientary. Use when you need to log hours worked on a project with a title and hours count.

Input Parameters

string
Date the hours were worked in YYYY-MM-DD format. If not provided, current date will be used.
number
required
Number of hours logged for the work performed
string
required
Title or brief description of the work performed
integer
required
The unique identifier of the project to log hours for
string
Detailed description of the work performed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_RECURRING_SCHEDULETool to create a new recurring schedule for automatic invoice generation in Clientary. Use when you need to set up recurring invoices for a client at regular intervals (weekly, monthly, quarterly, etc.). Requires client_id, next_date, time_interval, currency_code, and due_period.

Input Parameters

string
Title or name for the recurring schedule
string ("send" | "draft" | "autobill")
Action to perform when generating recurring invoices.
string
Custom schedule number identifier
integer
required
ID of the client for whom the recurring schedule is created (required)
string
required
Next invoice generation date in YYYY-MM-DD format (required)
integer
required
Payment due period in days from invoice generation date. Required field.
string
required
Currency code for the recurring schedule (e.g., USD, EUR, GBP). Required field.
string ("weekly" | "every_2_weeks" | "semimonthly" | "monthly" | "quarterly" | "annually")
required
Frequency of recurring invoice generation: weekly (1), every_2_weeks (2), semimonthly (3), monthly (5), quarterly (7), or annually (9)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_CREATE_TASK2Tool to create a new task in Clientary using API v2. Use when you need to create a task with a title, optionally associating it with a project, client, or assignee.

Input Parameters

string
required
The task title (required)
string
When the task should be completed (date format: YYYY-MM-DD)
integer
ID of the associated client
integer
ID of the project to assign the task to
integer
ID of the staff member to assign the task to
string
Task details and additional information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_CLIENTTool 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.

Input Parameters

string
required
The unique identifier of the client to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_CLIENTARY_CONTACTTool to permanently delete a contact and all associated comments. Use when you need to remove a contact that is no longer needed. Warning: This action is irreversible.

Input Parameters

integer
required
The unique identifier of the contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_CLIENTARY_EXPENSETool to permanently remove an expense record from Clientary. Use when you need to delete an expense entry. WARNING: Deletions are permanent and not reversible.

Input Parameters

integer
required
The unique identifier of the expense to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_CLIENTARY_PROJECTPermanently delete a project from Clientary. Deletion also removes associated tasks, logged hours, comments, and notes and cannot be reversed.

Input Parameters

string
required
The unique identifier of the project to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_HOURTool to permanently delete a time entry (hour) from Clientary. Use when you need to remove a logged hour entry by its unique identifier. Warning: Deletions are permanent and cannot be undone.

Input Parameters

integer
required
The unique identifier of the hour/time entry to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_LEADTool 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.

Input Parameters

string
required
The unique identifier of the lead to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_PAYMENTTool 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.

Input Parameters

string
required
The unique identifier of the payment record to delete
string
required
The unique identifier of the invoice containing the payment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_PAYMENT_PROFILETool 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.

Input Parameters

integer
required
The unique identifier of the payment profile to delete
integer
required
The unique identifier of the client who owns the payment profile

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_DELETE_RECURRING_SCHEDULETool 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.

Input Parameters

string
required
The unique identifier of the recurring schedule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_CLIENTFetch details for a specific Clientary client by ID.

Input Parameters

integer
required
The unique identifier of the client to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_CONTACTTool to retrieve a single contact by its ID. Use when you need to fetch detailed information about a specific contact from Clientary.

Input Parameters

integer
required
The unique identifier of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_ESTIMATETool 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.

Input Parameters

integer
required
The unique identifier of the estimate to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_EXPENSETool 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.

Input Parameters

integer
required
The unique identifier of the expense to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_HOURTool 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.

Input Parameters

integer
required
The unique identifier of the hours entry to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_INVOICETool 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.

Input Parameters

integer
required
The unique identifier of the invoice to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_LEADTool to retrieve a single lead by its ID. Use when you need to fetch detailed information about a specific lead from Clientary.

Input Parameters

integer
required
The unique identifier of the lead to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_PROJECTTool to retrieve a single project by its identifier. Use when you need to fetch detailed information about a specific project in Clientary.

Input Parameters

integer
required
The unique identifier of the project to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_STAFFTool to retrieve a single staff member by their ID. Use when you need to fetch detailed information about a specific staff member from Clientary.

Input Parameters

integer
required
The unique identifier of the staff member to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_GET_TASKTool to retrieve a specific task by its ID. Use when you need to fetch detailed information about a task from Clientary.

Input Parameters

integer
required
The unique identifier of the task to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_CONTACTSTool 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.

Input Parameters

integer
Page number for pagination. Default is 1.
integer
required
The unique identifier for the client whose contacts you want to retrieve.
integer
Number of results per page. Default is 10, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_ESTIMATESTool to retrieve all estimates for a specific client with pagination support (30 results per page). Use when you need to fetch estimates associated with a particular client from Clientary.

Input Parameters

integer
Page number for pagination. Returns 30 results per page. Defaults to page 1
integer
required
The unique identifier of the client whose estimates to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_EXPENSESTool 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.

Input Parameters

string
End date for expense range in YYYY-MM-DD format. Defaults to current fiscal year end if omitted
integer
required
The unique identifier of the client whose expenses to retrieve
string
Start date for expense range in YYYY-MM-DD format. Defaults to current fiscal year start if omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_INVOICESTool 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.

Input Parameters

integer
Page number for pagination. Returns 30 results per page
integer
required
The unique identifier of the client whose invoices to retrieve
string
Filter invoices by update timestamp. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_PAYMENT_PROFILESTool to retrieve payment profiles for a specific client. Payment profiles store credit card information securely via Stripe integration. Use when you need to fetch payment methods associated with a client account.

Input Parameters

integer
required
The unique identifier of the client whose payment profiles to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENT_PROJECTSTool 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.

Input Parameters

integer
Page number for pagination. Defaults to page 1 with 10 results per page
integer
required
The unique identifier of the client whose projects you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_CLIENTSList active Clientary clients with pagination, optional modification-date filtering and sorting. Results default to 10 per page.

Input Parameters

integer
Page number to retrieve. Default is page 1 with 10 results per page
string
Sort order for results. Use ‘date’ to retrieve most recently created clients instead of default alphabetical name-based sorting
string
Filter clients modified after this date. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_ESTIMATESTool to retrieve all estimates with pagination support (30 results per page). Use when you need to fetch a list of estimates from Clientary, which serve as proposals or quotes to be sent to clients.

Input Parameters

integer
Page number for pagination. Returns 30 results per page. Defaults to page 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_EXPENSESTool 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.

Input Parameters

string
End date for expense range in YYYY-MM-DD format. If not specified, defaults to the end of the current fiscal year
string
Start date for expense range in YYYY-MM-DD format. If not specified, defaults to the beginning of the current fiscal year

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_LEADSTool 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.

Input Parameters

integer
Page number to retrieve. Pagination through more results, you can use the page parameter
string
Sort order options: ‘name’ (alphabetical) or ‘oldest’ (chronological ascending); default sorts by newest first

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PAYMENTSTool 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.

Input Parameters

integer
Page number to retrieve. Default is page 1 with 30 results per page
string
Sort field. Accepts ‘created_at’ to sort by creation date. Defaults to reverse chronological order by ‘received_on’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECT_ESTIMATESTool 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.

Input Parameters

integer
Page number for pagination. Returns 30 results per page. Defaults to page 1
integer
required
The unique identifier of the project whose estimates you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECT_EXPENSESTool 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.

Input Parameters

integer
Page number for pagination. Use this to retrieve additional pages if the result set is large
string
End date for expense range in YYYY-MM-DD format. Defaults to current fiscal year end if omitted
string
Start date for expense range in YYYY-MM-DD format. Defaults to current fiscal year start if omitted
integer
required
The unique identifier of the project whose expenses to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECT_HOURSTool 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.

Input Parameters

string
Narrows 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
integer
required
The unique identifier of the project for which to retrieve hour entries

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECT_INVOICESTool 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.

Input Parameters

integer
Page number for pagination. Returns 30 results per page. Defaults to page 1
integer
required
The unique identifier of the project whose invoices to retrieve
string
Filter invoices by update timestamp. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECTSRetrieve projects from Clientary with pagination and optional filtering for closed projects. By default, the API returns active and billable projects, with 20 results per page.

Input Parameters

integer
Page number to retrieve. Default is page 1 with 10 results per page
string
Use ‘all’ to include closed projects alongside active/billable ones. By default, only active and billable projects are returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_PROJECT_TASKSTool to retrieve all tasks for a specific project. Use when you need to fetch a list of tasks associated with a particular project in Clientary.

Input Parameters

integer
required
The ID of the project to get tasks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_RECURRING_SCHEDULE_INVOICESTool to retrieve all invoices generated by a specific recurring schedule with pagination support (30 results per page). Use when you need to fetch invoices associated with a particular recurring schedule from Clientary.

Input Parameters

integer
required
The unique identifier of the recurring schedule whose invoices to retrieve
integer
Page number for pagination. Returns 30 results per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_STAFFTool to retrieve all staff members for an account. Use when you need to fetch a complete list of staff members from Clientary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_LIST_TASKSTool to retrieve all tasks with pagination support (50 results per page). Use when you need to fetch a list of tasks from Clientary.

Input Parameters

integer
Page number to retrieve. Default is page 1 with 50 results per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_SEND_INVOICE_MESSAGETool 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.

Input Parameters

integer
required
The unique identifier of the invoice to send
string
Email body content. If not provided, a default message will be used.
string
Email subject line. If not provided, a default subject will be used.
integer
Set to 1 to send a copy of the email to the API token user. Set to 0 or omit to not send a copy.
integer
Set to 1 to include a PDF attachment of the invoice with the email. Set to 0 or omit to not attach PDF.
array
required
An array of email addresses to receive the invoice. At least one recipient is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_CLIENTTool 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.

Input Parameters

integer
required
The unique identifier of the client to update
string
Postal code. Include to update the postal code.
string
City location. Include to update the city.
string
Client company or organization name. Include to update the name.
string
State or province. Include to update the state.
string
Client reference number. Must be unique across all clients. Returns HTTP 422 on duplicate.
string
Primary street address. Include to update the address.
string
Country code (e.g., ‘US’). Include to update the country.
string
Client website URL. Include to update the website.
string
Secondary address line (suite, unit, etc.). Include to update the secondary address.
string
Additional client notes or details. Include to update the description.
object
Custom invoice field data as key-value pairs. Include to update custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_CLIENTARY_CONTACTTool to update an existing contact in Clientary with partial or complete field modifications. Use when you need to modify contact details such as name, email, title, or phone numbers. Supports partial updates via the client_user wrapper object.

Input Parameters

integer
required
The unique identifier of the contact to update.
object
required
Client user data containing contact fields to update. All fields are optional for partial updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_CLIENTARY_LEADTool to update an existing lead record in Clientary with partial or complete field modifications. Use when you need to modify lead details such as name, address, website, description, or custom fields. All fields except ID are optional.

Input Parameters

integer
required
The unique identifier of the lead to update
string
Postal code. Include to update the postal code.
string
City location. Include to update the city.
string
Lead company or organization name. Include to update the name.
string
State or province. Include to update the state.
string
Lead reference number. Must be unique across all leads. Returns HTTP 422 on duplicate.
string
Primary street address. Include to update the address.
string
Country code (e.g., ‘US’). Include to update the country.
string
Lead website URL. Include to update the website.
string
Secondary address line (suite, unit, etc.). Include to update the secondary address.
string
Additional lead notes or details. Include to update the description.
object
Custom invoice field data as key-value pairs. Include to update custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_EXPENSETool 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.

Input Parameters

integer
required
The unique identifier of the expense to update
number
The monetary value of the expense. Include to update the amount.
integer
Client assignment identifier. Include to update the associated client.
integer
Project assignment identifier. Include to update the associated project.
string
Expense description. Include to update the description.
string
Date when expense was incurred in YYYY-MM-DD format. Include to update the date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_HOURTool 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.

Input Parameters

integer
required
The unique identifier of the hours entry to update
string
Work date in YYYY/MM/DD format. Optional for partial updates.
number
Billing rate per hour. Optional for partial updates.
number
Duration of work logged in hours. Optional for partial updates.
string
Name or label for the time entry. Optional for partial updates.
boolean
Billing status indicator. Optional for partial updates.
string
Detailed notes about work performed. Optional for partial updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_INVOICETool to update an existing invoice in Clientary with partial or complete field modifications. Use when you need to modify invoice details such as number, dates, currency, or line items. For invoice_items_attributes: include item ID to edit existing items, omit ID to create new items, or set destroy=true with ID to delete items.

Input Parameters

integer
required
The unique identifier of the invoice to update
string
Purchase order reference number
string
Invoice date in YYYY-MM-DD format
string
Additional notes or comments for the invoice
string
Invoice title or subject
string
Invoice number. Must be unique across all invoices. Returns HTTP 422 on duplicate.
string
Payment due date in YYYY-MM-DD format
string
Three-letter ISO currency code (e.g., USD, EUR, GBP)
array
Array of invoice items to create, update, or delete. Include item ID to edit or delete existing items, omit ID to create new items, or set destroy=true with ID to delete items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_PROJECTTool 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.

Input Parameters

integer
required
The unique identifier of the project to update
string
The project name. Include to update the project name.
number
Project rate (hourly rate or total cost depending on project type). Include to update the rate.
number
Budget amount. Include to update the budget.
string
Unique project number. Include to update the project number. Note: triggers HTTP 422 if duplicate.
integer
Project status code. Include to update the status.
string
Project end date in YYYY-MM-DD format. Include to update the end date.
integer
Budget type: 0 = total budgeted hours; 1 = total budgeted amount. Include to update the budget type.
string
Project description. Include to update the description.
integer
Project type: 0 = hourly rate project; 2 = fixed amount project. Include to update the project type.
string
Currency code (e.g., USD, EUR, GBP). Include to update the currency code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLIENTARY_UPDATE_TASKTool 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.

Input Parameters

integer
required
The unique identifier of the task to update
string
Task title/name. Include to update the title.
boolean
Task completion status (true/false). Include to update completion status.
string
Task deadline in date format (e.g., YYYY-MM-DD). Include to update due date.
integer
Related client ID. Include to update client association.
integer
Associated project ID. Include to update project association.
integer
Staff member ID assigned to task. Include to update assignee.
string
Detailed task information. Include to update the description.
string
Timestamp when task was marked complete. Include to update completion timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not