The Clientary connector lets your AI agent work with Clientary. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 26 · 24 · 1026 read24 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Clientary connection
In AgentKit > Connections, create a Clientary connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolclientary_client_getGet one client by ID.Read-onlyGet Client
Get one client by ID. Returns its number, name, address, website, description and app URL.
Inputs
idintegerrequired- ID of the client. Example: 1234.
clientary_clients_listList clients (companies or organizations you bill), 10 per page, sorted by name or by newest.Read-onlyList Clients
List clients (companies or organizations you bill), 10 per page, sorted by name or by newest. Returns page_count, total_count and per client its id, number, name, address, website and description. Use clientary_client_get for one client.
Inputs
filterstring- archived to list archived clients; active clients otherwise. Example: archived.one of
archived pageinteger- Page number, starting at 1. Example: 2.
qstring- Search clients by name or number. Example: acme.
sortstring- date to sort newest first; name order otherwise. Example: date.one of
date updated_sincestring- Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
clientary_comments_listList the comments on an invoice, estimate, project, task, proposal or contract, newest first.Read-onlyList Comments
List the comments on an invoice, estimate, project, task, proposal or contract, newest first. Returns per comment its id, body, staff_only flag, author and dates.
Inputs
resourcestringrequired- Type of record the comments are on. Example: invoices.one of
invoicesestimatesprojectstasksproposalscontracts resource_idintegerrequired- ID of the invoice, estimate, project, task, proposal or contract. Example: 1234.
clientary_contact_getGet one contact by ID.Read-onlyGet Contact
Get one contact by ID. Returns client_id, name, title, email, phone, extension and mobile.
Inputs
idintegerrequired- ID of the contact. Example: 1234.
clientary_contacts_listList contacts (people at clients and leads) across the account, in name order or newest first.Read-onlyList Contacts
List contacts (people at clients and leads) across the account, in name order or newest first. Returns page_count, total_count and per contact its id, client_id, name, title, email and phones. Use clientary_contact_get for one contact.
Inputs
pageinteger- Page number, starting at 1. Example: 2.
page_sizeinteger- Results per page, up to 100. Example: 50.
qstring- Search contacts by name or email. Example: jane.
sortstring- date to sort newest first; name order otherwise. Example: date.one of
date updated_sincestring- Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
clientary_contract_getGet one contract by ID.Read-onlyGet Contract
Get one contract by ID. Returns subject, status, date, client, sections, signers and signing state, plus url, client_view_url and pdf_url links.
Inputs
idintegerrequired- ID of the contract. Example: 1234.
clientary_contracts_listList contracts (documents the client reads and signs), optionally for one project, status or date range, or by search text.Read-onlyList Contracts
List contracts (documents the client reads and signs), optionally for one project, status or date range, or by search text. Returns page_count, total_count and per contract its id, subject, status, date, client, project and sections.
Inputs
from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
pageinteger- Page number, starting at 1. Example: 2.
project_idinteger- Only contracts of this project ID. Example: 7.
qstring- Search by title or client name. Example: lawn.
statusstring- draft, sent, viewed, signed or voided. Example: sent.one of
draftsentviewedsignedvoided to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
clientary_estimate_getGet one estimate by ID.Read-onlyGet Estimate
Get one estimate by ID. Returns number, client, project, date, status, taxes, totals and items, plus url, client_view_url and pdf_url links.
Inputs
idintegerrequired- ID of the estimate. Example: 1234.
clientary_estimates_listList estimates (quotes), 30 per page, filtered by state, search text or date range and sorted by number, date or created_at.Read-onlyList Estimates
List estimates (quotes), 30 per page, filtered by state, search text or date range and sorted by number, date or created_at. Returns page_count, total_count and per estimate its id, number, client, project, date, status, totals and items.
Inputs
filterstring- draft, open (sent, viewed or revised), accepted, declined, archived or expired. Example: open.one of
draftopenaccepteddeclinedarchivedexpired from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
pageinteger- Page number, starting at 1. Example: 2.
qstring- Search by number, title or client name. Example: 1042.
sortstring- number (default), date or created_at. Example: date.one of
numberdatecreated_at to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
clientary_expense_getGet one expense by ID.Read-onlyGet Expense
Get one expense by ID. Returns amount, date, description, client, project, user and invoice.
Inputs
idintegerrequired- ID of the expense. Example: 1234.
clientary_expenses_listList expenses in a date range (the current fiscal year by default), optionally tagged with a term.Read-onlyList Expenses
List expenses in a date range (the current fiscal year by default), optionally tagged with a term. Returns from_date, to_date, total_count and per expense its id, amount, date, description, client, project and invoice.
Inputs
from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
qstring- Only expenses tagged with this term. Example: travel.
to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
clientary_hours_getGet one time entry by ID.Read-onlyGet Time Entry
Get one time entry by ID. Returns hours, title, date, project, user, rate, cost, description and billed flag.
Inputs
idintegerrequired- ID of the time entry. Example: 1234.
clientary_invoice_getGet one invoice by ID.Read-onlyGet Invoice
Get one invoice by ID. Returns number, client, dates, status, taxes, totals, balance, items and payments, plus url, client_view_url and pdf_url links that can be shared.
Inputs
idintegerrequired- ID of the invoice. Example: 1234.
clientary_invoices_listList invoices, 30 per page, filtered by status, search text, date range or update date and sorted by date, created_at or due_date.Read-onlyList Invoices
List invoices, 30 per page, filtered by status, search text, date range or update date and sorted by date, created_at or due_date. Returns page_count, total_count and per invoice its id, number, client, dates, status, totals, balance, items and payments. Use clientary_invoice_get for links to one invoice.
Inputs
from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
pageinteger- Page number, starting at 1. Example: 2.
qstring- Search by number, title, client name or PO. Example: 1042.
sortstring- date (default), created_at or due_date, newest first. Example: due_date.one of
datecreated_atdue_date statusstring- draft, open (sent or viewed), overdue, paid, pending or cancelled. Example: open.one of
draftopenoverduepaidpendingcancelled to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
updated_sincestring- Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
clientary_lead_getGet one lead by ID.Read-onlyGet Lead
Get one lead by ID. Returns its number, name, address, website, description and app URL.
Inputs
idintegerrequired- ID of the lead. Example: 1234.
clientary_leads_listList leads (prospective clients), 20 per page, newest first by default.Read-onlyList Leads
List leads (prospective clients), 20 per page, newest first by default. Returns page_count, total_count and per lead its id, number, name, address, website and description.
Inputs
filterstring- closed (won), lost or all; open leads otherwise. Example: all.one of
closedlostall pageinteger- Page number, starting at 1. Example: 2.
qstring- Search leads by name. Example: acme.
sortstring- name for name order, oldest for oldest first; newest first otherwise. Example: name.one of
nameoldest
clientary_payments_listList invoice payments, 30 per page, newest received first, optionally in a date range or changed since a date.Read-onlyList Payments
List invoice payments, 30 per page, newest received first, optionally in a date range or changed since a date. Returns per payment its id, invoice, amount, note, received date, fee and gateway transaction ID.
Inputs
from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
pageinteger- Page number, starting at 1. Example: 2.
sortstring- created_at to sort by record creation; received date otherwise. Example: created_at.one of
created_at to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
updated_sincestring- Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
clientary_project_getGet one project by ID.Read-onlyGet Project
Get one project by ID. Returns its client, type, rate, budget, worked and unbilled hours, cost, status, currency and end date.
Inputs
idintegerrequired- ID of the project. Example: 1234.
clientary_project_hours_listList the time entries logged on a project, optionally only billed or unbilled ones.Read-onlyList Project Hours
List the time entries logged on a project, optionally only billed or unbilled ones. Returns per entry its id, hours, title, date, user, rate, cost and billed flag.
Inputs
project_idintegerrequired- ID of the project. Example: 1234.
filterstring- billed or unbilled. Example: unbilled.one of
billedunbilled
clientary_projects_listList projects, active and billable ones by default.Read-onlyList Projects
List projects, active and billable ones by default. Returns page_count, total_count and per project its id, number, name, client, type, rate, budget, worked and unbilled hours, cost, status and end date. Use clientary_project_get for one project.
Inputs
filterstring- all, closed, billable, unbilled (with unbilled time) or overbudget; active projects otherwise. Example: all.one of
allclosedbillableunbilledoverbudget pageinteger- Page number, starting at 1. Example: 2.
page_sizeinteger- Results per page, up to 100. Example: 50.
qstring- Search projects by name. Example: lawn.
sortstring- number (default), date (last updated), created, name or client. Example: name.one of
numberdatecreatednameclient
clientary_proposal_getGet one proposal by ID.Read-onlyGet Proposal
Get one proposal by ID. Returns subject, status, date, client, sections, signers and signing state, plus url, client_view_url and pdf_url links.
Inputs
idintegerrequired- ID of the proposal. Example: 1234.
clientary_proposals_listList proposals (documents that pitch work with fee packages), optionally for one project, status or date range, or by search text.Read-onlyList Proposals
List proposals (documents that pitch work with fee packages), optionally for one project, status or date range, or by search text. Returns page_count, total_count and per proposal its id, subject, status, date, client, project and sections.
Inputs
from_datestring- Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
pageinteger- Page number, starting at 1. Example: 2.
project_idinteger- Only proposals of this project ID. Example: 7.
qstring- Search by title or client name. Example: lawn.
statusstring- draft, sent, viewed, signed or voided. Example: sent.one of
draftsentviewedsignedvoided to_datestring- End of the date range (YYYY-MM-DD). Example: 2026-03-31.
clientary_report_summary_getGet account totals for a date range: invoiced, paid, outstanding (current and overdue), estimates, proposals, retainers and hours, each money figure by currency.Read-onlyGet Summary Report
Get account totals for a date range: invoiced, paid, outstanding (current and overdue), estimates, proposals, retainers and hours, each money figure by currency. Use this for a financial overview.
Inputs
client_idinteger- Limit every figure to one client ID. Example: 4.
from_datestring- Start date (YYYY-MM-DD); defaults to the first of the current month. Example: 2026-01-01.
to_datestring- End date (YYYY-MM-DD); defaults to today. Example: 2026-03-31.
clientary_staff_listList the account's staff users.Read-onlyList Staff
List the account's staff users. Returns per user their id, name, title, email and phones. Use this to find an assignee_id or user_id.
Inputs
This tool takes no inputs.
clientary_task_getGet one task by ID.Read-onlyGet Task
Get one task by ID. Returns title, description, project, client, assignee, due date and completion.
Inputs
idintegerrequired- ID of the task. Example: 1234.
clientary_tasks_listList tasks (to-dos), optionally open or done, or assigned to one staff user, in priority order or newest first.Read-onlyList Tasks
List tasks (to-dos), optionally open or done, or assigned to one staff user, in priority order or newest first. Returns per task its id, title, description, project, client, assignee, due date and completion.
Inputs
pageinteger- Page number, starting at 1. Example: 2.
sortstring- created_at for newest first; priority order otherwise. Example: created_at.one of
created_at statusstring- open or done. Example: open.one of
opendone user_idinteger- Only tasks assigned to this staff user ID. Example: 3.
clientary_client_createCreate a client.WriteCreate Client
Create a client. Returns the new client with its id. Use clientary_contact_create to add people to it.
Inputs
namestringrequired- Name of the company or organization. Example: ACME Corp.
addressstring- Street address. Example: 123 Main St.
address_2string- Street address, line 2. Example: Suite 101.
citystring- City. Example: New York.
countrystring- Country code. Example: US.
descriptionstring- Description or notes. Example: Key account.
numberstring- Unique reference number. Example: 102.
statestring- State or region. Example: NY.
websitestring- Website URL. Example: http://www.example.com.
zipstring- ZIP or postal code. Example: 12345.
clientary_client_updateUpdate the fields you pass on a client.WriteUpdate Client
Update the fields you pass on a client. Returns the updated client.
- Idempotent
Inputs
idintegerrequired- ID of the client. Example: 1234.
addressstring- Street address. Example: 123 Main St.
address_2string- Street address, line 2. Example: Suite 101.
citystring- City. Example: New York.
countrystring- Country code. Example: US.
descriptionstring- Description or notes. Example: Key account.
namestring- Name of the company or organization. Example: ACME Corp.
numberstring- Unique reference number. Example: 102.
statestring- State or region. Example: NY.
websitestring- Website URL. Example: http://www.example.com.
zipstring- ZIP or postal code. Example: 12345.
clientary_comment_createAdd a comment to an invoice, estimate, project, task, proposal or contract.WriteAdd Comment
Add a comment to an invoice, estimate, project, task, proposal or contract. Posting notifies the people involved, as in the app. Returns the new comment.
Inputs
bodystringrequired- Comment text. Example: Please review the revised total.
resourcestringrequired- Type of record the comments are on. Example: invoices.one of
invoicesestimatesprojectstasksproposalscontracts resource_idintegerrequired- ID of the invoice, estimate, project, task, proposal or contract. Example: 1234.
staff_onlyboolean- true to hide the comment from client contacts. Example: false.
clientary_contact_createCreate a contact (a person) under a client.WriteCreate Contact
Create a contact (a person) under a client. Returns the new contact with its id.
Inputs
client_idintegerrequired- ID of the client the contact belongs to. Example: 1234.
emailstringrequired- Email address. Example: john@example.com.
namestringrequired- Full name of the contact. Example: John Doe.
extstring- Phone extension. Example: 204.
mobilestring- Mobile phone number. Example: +1 555 0199.
phonestring- Phone number. Example: +1 555 0100.
titlestring- Job title. Example: Software Developer.
clientary_contact_updateUpdate the fields you pass on a contact.WriteUpdate Contact
Update the fields you pass on a contact. Returns the updated contact.
- Idempotent
Inputs
idintegerrequired- ID of the contact. Example: 1234.
emailstring- Email address. Example: john@example.com.
extstring- Phone extension. Example: 204.
mobilestring- Mobile phone number. Example: +1 555 0199.
namestring- Full name of the contact. Example: John Doe.
phonestring- Phone number. Example: +1 555 0100.
titlestring- Job title. Example: Software Developer.
clientary_contract_sendEmail a contract to recipients, each with their own link to view and sign it, and mark it sent.WriteSend Contract
Email a contract to recipients, each with their own link to view and sign it, and mark it sent. Returns the result of the send.
Inputs
idintegerrequired- ID of the contract. Example: 1234.
recipientsarrayrequired- Email addresses to send the contract to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
attach_pdfinteger- 1 to attach the contract as a PDF. Example: 1.
messagestring- Email body. Example: Please find your contract attached.
send_copyinteger- 1 to send a copy to the API token's user. Example: 1.
subjectstring- Email subject. Example: Your contract from ACME.
clientary_estimate_createCreate an estimate (quote) with line items, as a draft.WriteCreate Estimate
Create an estimate (quote) with line items, as a draft. Returns the new estimate with its id. Use clientary_estimate_send to email it.
Inputs
currency_codestringrequired- Three-letter currency code. Example: USD.
datestringrequired- Document date (YYYY-MM-DD). Example: 2026-03-01.
client_idinteger- ID of the client. Example: 4.
estimate_items_attributesarray- Line items, each with title, quantity and price (and optionally taxable). On update, include id to change an existing item, omit it to add one, or pass id with _destroy true to remove one. Example: [{"title": "Design", "quantity": 10, "price": 120}].
notestring- Note shown to the client. Example: Thank you for your business.
numberstring- Document number; auto-incremented when left empty. Example: 185.
summarystring- Summary shown on the document. Example: Design work for March.
taxnumber- Primary tax rate in percent. Example: 5.
tax_labelstring- Label of the primary tax. Example: Sales Tax.
titlestring- Title shown on the document. Example: March retainer.
clientary_estimate_sendEmail an estimate to recipients and mark it sent.WriteSend Estimate
Email an estimate to recipients and mark it sent. Returns the result of the send.
Inputs
idintegerrequired- ID of the estimate. Example: 1234.
recipientsarrayrequired- Email addresses to send the estimate to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
attach_pdfinteger- 1 to attach the estimate as a PDF. Example: 1.
messagestring- Email body. Example: Please find your estimate attached.
send_copyinteger- 1 to send a copy to the API token's user. Example: 1.
subjectstring- Email subject. Example: Your estimate from ACME.
clientary_estimate_updateUpdate the fields you pass on an estimate, and add, change or remove line items.WriteUpdate Estimate
Update the fields you pass on an estimate, and add, change or remove line items. Returns the updated estimate.
- Idempotent
Inputs
idintegerrequired- ID of the estimate. Example: 1234.
client_idinteger- ID of the client. Example: 4.
currency_codestring- Three-letter currency code. Example: USD.
datestring- Document date (YYYY-MM-DD). Example: 2026-03-01.
estimate_items_attributesarray- Line items, each with title, quantity and price (and optionally taxable). On update, include id to change an existing item, omit it to add one, or pass id with _destroy true to remove one. Example: [{"title": "Design", "quantity": 10, "price": 120}].
notestring- Note shown to the client. Example: Thank you for your business.
numberstring- Document number; auto-incremented when left empty. Example: 185.
summarystring- Summary shown on the document. Example: Design work for March.
taxnumber- Primary tax rate in percent. Example: 5.
tax_labelstring- Label of the primary tax. Example: Sales Tax.
titlestring- Title shown on the document. Example: March retainer.
clientary_expense_createRecord an expense, optionally for a client or project.WriteCreate Expense
Record an expense, optionally for a client or project. Returns the new expense with its id.
Inputs
amountnumberrequired- Expense amount. Example: 500.
client_idinteger- ID of the client to assign it to. Example: 4.
descriptionstring- What the expense was for. Example: Flight to client site.
incurred_onstring- Date of the expense (YYYY-MM-DD). Example: 2026-03-02.
project_idinteger- ID of the project to assign it to. Example: 7.
clientary_expense_updateUpdate the fields you pass on an expense.WriteUpdate Expense
Update the fields you pass on an expense. Returns the updated expense.
- Idempotent
Inputs
idintegerrequired- ID of the expense. Example: 1234.
amountnumber- Expense amount. Example: 500.
client_idinteger- ID of the client to assign it to. Example: 4.
descriptionstring- What the expense was for. Example: Flight to client site.
incurred_onstring- Date of the expense (YYYY-MM-DD). Example: 2026-03-02.
project_idinteger- ID of the project to assign it to. Example: 7.
clientary_hours_createLog a time entry on a project as the API token's user.WriteLog Time
Log a time entry on a project as the API token's user. Returns the new entry with its id.
Inputs
hoursnumberrequired- Hours worked, e.g. 1.5. Example: 5.5.
project_idintegerrequired- ID of the project. Example: 1234.
titlestringrequired- What the time was spent on. Example: Setup and Documentation.
datestring- Date worked (YYYY-MM-DD); defaults to today. Example: 2026-03-10.
descriptionstring- Longer description of the work. Example: Configured CI and wrote the README.
clientary_hours_updateUpdate the fields you pass on a time entry.WriteUpdate Time Entry
Update the fields you pass on a time entry. Returns the updated entry.
- Idempotent
Inputs
idintegerrequired- ID of the time entry. Example: 1234.
datestring- Date worked (YYYY-MM-DD); defaults to today. Example: 2026-03-10.
descriptionstring- Longer description of the work. Example: Configured CI and wrote the README.
hoursnumber- Hours worked, e.g. 1.5. Example: 5.5.
titlestring- What the time was spent on. Example: Setup and Documentation.
clientary_invoice_createCreate an invoice with line items, as a draft.WriteCreate Invoice
Create an invoice with line items, as a draft. Returns the new invoice with its id. Use clientary_invoice_send to email it.
Inputs
currency_codestringrequired- Three-letter currency code. Example: USD.
datestringrequired- Document date (YYYY-MM-DD). Example: 2026-03-01.
due_datestringrequired- Due date (YYYY-MM-DD). Example: 2026-03-31.
client_idinteger- ID of the client. Example: 4.
invoice_items_attributesarray- Line items, each with title, quantity and price (and optionally taxable). On update, include id to change an existing item, omit it to add one, or pass id with _destroy true to remove one. Example: [{"title": "Design", "quantity": 10, "price": 120}].
notestring- Note shown to the client. Example: Thank you for your business.
numberstring- Document number; auto-incremented when left empty. Example: 185.
postring- Purchase order number. Example: PO-2026-001.
summarystring- Summary shown on the document. Example: Design work for March.
taxnumber- Primary tax rate in percent. Example: 5.
tax_labelstring- Label of the primary tax. Example: Sales Tax.
titlestring- Title shown on the document. Example: March retainer.
clientary_invoice_sendEmail an invoice to recipients and mark it sent.WriteSend Invoice
Email an invoice to recipients and mark it sent. Returns the result of the send.
Inputs
idintegerrequired- ID of the invoice. Example: 1234.
recipientsarrayrequired- Email addresses to send the invoice to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
attach_pdfinteger- 1 to attach the invoice as a PDF. Example: 1.
messagestring- Email body. Example: Please find your invoice attached.
send_copyinteger- 1 to send a copy to the API token's user. Example: 1.
subjectstring- Email subject. Example: Your invoice from ACME.
clientary_invoice_updateUpdate the fields you pass on an invoice, and add, change or remove line items.WriteUpdate Invoice
Update the fields you pass on an invoice, and add, change or remove line items. Returns the updated invoice.
- Idempotent
Inputs
idintegerrequired- ID of the invoice. Example: 1234.
client_idinteger- ID of the client. Example: 4.
currency_codestring- Three-letter currency code. Example: USD.
datestring- Document date (YYYY-MM-DD). Example: 2026-03-01.
due_datestring- Due date (YYYY-MM-DD). Example: 2026-03-31.
invoice_items_attributesarray- Line items, each with title, quantity and price (and optionally taxable). On update, include id to change an existing item, omit it to add one, or pass id with _destroy true to remove one. Example: [{"title": "Design", "quantity": 10, "price": 120}].
notestring- Note shown to the client. Example: Thank you for your business.
numberstring- Document number; auto-incremented when left empty. Example: 185.
postring- Purchase order number. Example: PO-2026-001.
summarystring- Summary shown on the document. Example: Design work for March.
taxnumber- Primary tax rate in percent. Example: 5.
tax_labelstring- Label of the primary tax. Example: Sales Tax.
titlestring- Title shown on the document. Example: March retainer.
clientary_lead_createCreate a lead (a prospective client).WriteCreate Lead
Create a lead (a prospective client). Returns the new lead with its id.
Inputs
namestringrequired- Name of the company or organization. Example: ACME Corp.
addressstring- Street address. Example: 123 Main St.
address_2string- Street address, line 2. Example: Suite 101.
citystring- City. Example: New York.
countrystring- Country code. Example: US.
descriptionstring- Description or notes. Example: Key account.
numberstring- Unique reference number. Example: 102.
statestring- State or region. Example: NY.
websitestring- Website URL. Example: http://www.example.com.
zipstring- ZIP or postal code. Example: 12345.
clientary_lead_updateUpdate the fields you pass on a lead.WriteUpdate Lead
Update the fields you pass on a lead. Returns the updated lead.
- Idempotent
Inputs
idintegerrequired- ID of the lead. Example: 1234.
addressstring- Street address. Example: 123 Main St.
address_2string- Street address, line 2. Example: Suite 101.
citystring- City. Example: New York.
countrystring- Country code. Example: US.
descriptionstring- Description or notes. Example: Key account.
namestring- Name of the company or organization. Example: ACME Corp.
numberstring- Unique reference number. Example: 102.
statestring- State or region. Example: NY.
websitestring- Website URL. Example: http://www.example.com.
zipstring- ZIP or postal code. Example: 12345.
clientary_payment_createRecord a payment against an invoice, or charge the client's saved payment profile for the whole outstanding balance.WriteRecord Invoice Payment
Record a payment against an invoice, or charge the client's saved payment profile for the whole outstanding balance. Returns the new payment.
Inputs
invoice_idintegerrequired- ID of the invoice. Example: 1234.
amountnumber- Amount received. Required unless payment_profile_id is given. Example: 500.
notestring- Note about the payment, e.g. how it was paid. Example: Paid by check.
payment_profile_idinteger- ID of the client's saved payment profile to charge for the whole outstanding balance; amount and note are then ignored. Example: 123.
clientary_project_createCreate a project for time tracking and billing.WriteCreate Project
Create a project for time tracking and billing. Returns the new project with its id.
Inputs
namestringrequired- Project name. Example: ACME website redesign.
ratenumberrequired- Hourly rate for an hourly project, or the total price for a fixed amount project. Example: 150.
budgetnumber- Budget in hours or currency, depending on budget_type. Example: 100.
budget_typeinteger- 0 to budget total hours, 1 to budget a total amount. Example: 0.
client_idinteger- ID of the client the project is for. Example: 2123.
currency_codestring- Three-letter currency code. Example: USD.
descriptionstring- Project description. Example: Redesign of the marketing site.
end_datestring- Project end date (YYYY-MM-DD). Example: 2026-12-31.
numberstring- Unique project number. Example: P-104.
project_typeinteger- 0 for an hourly rate project, 2 for a fixed amount project. Example: 0.
clientary_project_updateUpdate the fields you pass on a project.WriteUpdate Project
Update the fields you pass on a project. Returns the updated project.
- Idempotent
Inputs
idintegerrequired- ID of the project. Example: 1234.
budgetnumber- Budget in hours or currency, depending on budget_type. Example: 100.
budget_typeinteger- 0 to budget total hours, 1 to budget a total amount. Example: 0.
client_idinteger- ID of the client the project is for. Example: 2123.
currency_codestring- Three-letter currency code. Example: USD.
descriptionstring- Project description. Example: Redesign of the marketing site.
end_datestring- Project end date (YYYY-MM-DD). Example: 2026-12-31.
namestring- Project name. Example: ACME website redesign.
numberstring- Unique project number. Example: P-104.
project_typeinteger- 0 for an hourly rate project, 2 for a fixed amount project. Example: 0.
ratenumber- Hourly rate for an hourly project, or the total price for a fixed amount project. Example: 150.
statusinteger- 1 active, 2 completed, 4 billable. Example: 2.
clientary_proposal_sendEmail a proposal to recipients, each with their own link to view and sign it, and mark it sent.WriteSend Proposal
Email a proposal to recipients, each with their own link to view and sign it, and mark it sent. Returns the result of the send.
Inputs
idintegerrequired- ID of the proposal. Example: 1234.
recipientsarrayrequired- Email addresses to send the proposal to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
attach_pdfinteger- 1 to attach the proposal as a PDF. Example: 1.
messagestring- Email body. Example: Please find your proposal attached.
send_copyinteger- 1 to send a copy to the API token's user. Example: 1.
subjectstring- Email subject. Example: Your proposal from ACME.
clientary_task_createCreate a task, optionally on a project and assigned to a staff user.WriteCreate Task
Create a task, optionally on a project and assigned to a staff user. Returns the new task with its id.
Inputs
titlestringrequired- Task title. Example: Send kickoff agenda.
assignee_idinteger- ID of the staff user to assign. Example: 3.
descriptionstring- Task details. Example: Share the agenda with the client a day before.
due_datestring- Due date (YYYY-MM-DD). Example: 2026-03-20.
project_idinteger- ID of the project the task belongs to. Example: 7.
clientary_task_updateUpdate the fields you pass on a task, including marking it completed.WriteUpdate Task
Update the fields you pass on a task, including marking it completed. Returns the updated task.
- Idempotent
Inputs
idintegerrequired- ID of the task. Example: 1234.
assignee_idinteger- ID of the staff user to assign. Example: 3.
completedboolean- true to mark the task done, false to reopen it. Example: true.
descriptionstring- Task details. Example: Share the agenda with the client a day before.
due_datestring- Due date (YYYY-MM-DD). Example: 2026-03-20.
project_idinteger- ID of the project the task belongs to. Example: 7.
titlestring- Task title. Example: Send kickoff agenda.
clientary_client_deleteDelete a client together with all its projects, invoices, estimates and contacts.DestructiveDelete Client
Delete a client together with all its projects, invoices, estimates and contacts. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the client. Example: 1234.
clientary_contact_deleteDelete a contact and its comments.DestructiveDelete Contact
Delete a contact and its comments. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the contact. Example: 1234.
clientary_estimate_deleteDelete an estimate with its items.DestructiveDelete Estimate
Delete an estimate with its items. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the estimate. Example: 1234.
clientary_expense_deleteDelete an expense.DestructiveDelete Expense
Delete an expense. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the expense. Example: 1234.
clientary_hours_deleteDelete a time entry.DestructiveDelete Time Entry
Delete a time entry. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the time entry. Example: 1234.
clientary_invoice_deleteDelete an invoice with its items and payments.DestructiveDelete Invoice
Delete an invoice with its items and payments. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the invoice. Example: 1234.
clientary_lead_deleteDelete a lead together with its estimates and contacts.DestructiveDelete Lead
Delete a lead together with its estimates and contacts. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the lead. Example: 1234.
clientary_payment_deleteDelete a payment from an invoice.DestructiveDelete Invoice Payment
Delete a payment from an invoice. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the payment. Example: 2053932801.
invoice_idintegerrequired- ID of the invoice. Example: 1234.
clientary_project_deleteDelete a project with its tasks, logged hours, comments and notes.DestructiveDelete Project
Delete a project with its tasks, logged hours, comments and notes. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the project. Example: 1234.
clientary_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Deletions are permanent.
- Idempotent
Inputs
idintegerrequired- ID of the task. Example: 1234.
No tools match.