> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Clientary

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.

**Authentication:** API Token
**Categories:** Accounting & Finance, Project Management
**Tools:** 60: 26 read, 24 write, 10 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CLIENTARY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Clientary connection

   In **AgentKit > Connections**, create a Clientary connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'clientary_client_get',
  toolInput: {
    id: 1234,
  },
  connector: 'clientary',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="clientary_client_get",
    tool_input={
        "id": 1234,
    },
    connection_name="clientary",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `clientary_client_get`

Get Client · Read-only

Get one client by ID. Returns its number, name, address, website, description and app URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the client. Example: 1234.

Example input: `{"id":1234}`

### `clientary_clients_list`

List Clients · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): archived to list archived clients; active clients otherwise. Example: archived. One of: `archived`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `q` (`string`, optional): Search clients by name or number. Example: acme.
- `sort` (`string`, optional): date to sort newest first; name order otherwise. Example: date. One of: `date`.
- `updated_since` (`string`, optional): Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.

Example input: `{}`

### `clientary_comments_list`

List Comments · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `resource` (`string`, required): Type of record the comments are on. Example: invoices. One of: `invoices`, `estimates`, `projects`, `tasks`, `proposals`, `contracts`.
- `resource_id` (`integer`, required): ID of the invoice, estimate, project, task, proposal or contract. Example: 1234.

Example input: `{"resource":"invoices","resource_id":1234}`

### `clientary_contact_get`

Get Contact · Read-only

Get one contact by ID. Returns client_id, name, title, email, phone, extension and mobile.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the contact. Example: 1234.

Example input: `{"id":1234}`

### `clientary_contacts_list`

List Contacts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 50.
- `q` (`string`, optional): Search contacts by name or email. Example: jane.
- `sort` (`string`, optional): date to sort newest first; name order otherwise. Example: date. One of: `date`.
- `updated_since` (`string`, optional): Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.

Example input: `{}`

### `clientary_contract_get`

Get Contract · Read-only

Get one contract by ID. Returns subject, status, date, client, sections, signers and signing state, plus url, client_view_url and pdf_url links.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the contract. Example: 1234.

Example input: `{"id":1234}`

### `clientary_contracts_list`

List Contracts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `project_id` (`integer`, optional): Only contracts of this project ID. Example: 7.
- `q` (`string`, optional): Search by title or client name. Example: lawn.
- `status` (`string`, optional): draft, sent, viewed, signed or voided. Example: sent. One of: `draft`, `sent`, `viewed`, `signed`, `voided`.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.

Example input: `{}`

### `clientary_estimate_get`

Get Estimate · Read-only

Get one estimate by ID. Returns number, client, project, date, status, taxes, totals and items, plus url, client_view_url and pdf_url links.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the estimate. Example: 1234.

Example input: `{"id":1234}`

### `clientary_estimates_list`

List Estimates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): draft, open (sent, viewed or revised), accepted, declined, archived or expired. Example: open. One of: `draft`, `open`, `accepted`, `declined`, `archived`, `expired`.
- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `q` (`string`, optional): Search by number, title or client name. Example: 1042.
- `sort` (`string`, optional): number (default), date or created_at. Example: date. One of: `number`, `date`, `created_at`.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.

Example input: `{}`

### `clientary_expense_get`

Get Expense · Read-only

Get one expense by ID. Returns amount, date, description, client, project, user and invoice.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the expense. Example: 1234.

Example input: `{"id":1234}`

### `clientary_expenses_list`

List Expenses · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `q` (`string`, optional): Only expenses tagged with this term. Example: travel.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.

Example input: `{}`

### `clientary_hours_get`

Get Time Entry · Read-only

Get one time entry by ID. Returns hours, title, date, project, user, rate, cost, description and billed flag.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the time entry. Example: 1234.

Example input: `{"id":1234}`

### `clientary_invoice_get`

Get Invoice · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the invoice. Example: 1234.

Example input: `{"id":1234}`

### `clientary_invoices_list`

List Invoices · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `q` (`string`, optional): Search by number, title, client name or PO. Example: 1042.
- `sort` (`string`, optional): date (default), created_at or due_date, newest first. Example: due_date. One of: `date`, `created_at`, `due_date`.
- `status` (`string`, optional): draft, open (sent or viewed), overdue, paid, pending or cancelled. Example: open. One of: `draft`, `open`, `overdue`, `paid`, `pending`, `cancelled`.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.
- `updated_since` (`string`, optional): Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.

Example input: `{}`

### `clientary_lead_get`

Get Lead · Read-only

Get one lead by ID. Returns its number, name, address, website, description and app URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the lead. Example: 1234.

Example input: `{"id":1234}`

### `clientary_leads_list`

List Leads · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): closed (won), lost or all; open leads otherwise. Example: all. One of: `closed`, `lost`, `all`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `q` (`string`, optional): Search leads by name. Example: acme.
- `sort` (`string`, optional): name for name order, oldest for oldest first; newest first otherwise. Example: name. One of: `name`, `oldest`.

Example input: `{}`

### `clientary_payments_list`

List Payments · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `sort` (`string`, optional): created_at to sort by record creation; received date otherwise. Example: created_at. One of: `created_at`.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.
- `updated_since` (`string`, optional): Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.

Example input: `{}`

### `clientary_project_get`

Get Project · Read-only

Get one project by ID. Returns its client, type, rate, budget, worked and unbilled hours, cost, status, currency and end date.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the project. Example: 1234.

Example input: `{"id":1234}`

### `clientary_project_hours_list`

List Project Hours · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`integer`, required): ID of the project. Example: 1234.
- `filter` (`string`, optional): billed or unbilled. Example: unbilled. One of: `billed`, `unbilled`.

Example input: `{"project_id":1234}`

### `clientary_projects_list`

List Projects · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): all, closed, billable, unbilled (with unbilled time) or overbudget; active projects otherwise. Example: all. One of: `all`, `closed`, `billable`, `unbilled`, `overbudget`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 50.
- `q` (`string`, optional): Search projects by name. Example: lawn.
- `sort` (`string`, optional): number (default), date (last updated), created, name or client. Example: name. One of: `number`, `date`, `created`, `name`, `client`.

Example input: `{}`

### `clientary_proposal_get`

Get Proposal · Read-only

Get one proposal by ID. Returns subject, status, date, client, sections, signers and signing state, plus url, client_view_url and pdf_url links.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the proposal. Example: 1234.

Example input: `{"id":1234}`

### `clientary_proposals_list`

List Proposals · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `from_date` (`string`, optional): Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `project_id` (`integer`, optional): Only proposals of this project ID. Example: 7.
- `q` (`string`, optional): Search by title or client name. Example: lawn.
- `status` (`string`, optional): draft, sent, viewed, signed or voided. Example: sent. One of: `draft`, `sent`, `viewed`, `signed`, `voided`.
- `to_date` (`string`, optional): End of the date range (YYYY-MM-DD). Example: 2026-03-31.

Example input: `{}`

### `clientary_report_summary_get`

Get Summary Report · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `client_id` (`integer`, optional): Limit every figure to one client ID. Example: 4.
- `from_date` (`string`, optional): Start date (YYYY-MM-DD); defaults to the first of the current month. Example: 2026-01-01.
- `to_date` (`string`, optional): End date (YYYY-MM-DD); defaults to today. Example: 2026-03-31.

Example input: `{}`

### `clientary_staff_list`

List Staff · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `clientary_task_get`

Get Task · Read-only

Get one task by ID. Returns title, description, project, client, assignee, due date and completion.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the task. Example: 1234.

Example input: `{"id":1234}`

### `clientary_tasks_list`

List Tasks · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `sort` (`string`, optional): created_at for newest first; priority order otherwise. Example: created_at. One of: `created_at`.
- `status` (`string`, optional): open or done. Example: open. One of: `open`, `done`.
- `user_id` (`integer`, optional): Only tasks assigned to this staff user ID. Example: 3.

Example input: `{}`

### `clientary_client_create`

Create Client · Write

Create a client. Returns the new client with its id. Use clientary_contact_create to add people to it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the company or organization. Example: ACME Corp.
- `address` (`string`, optional): Street address. Example: 123 Main St.
- `address_2` (`string`, optional): Street address, line 2. Example: Suite 101.
- `city` (`string`, optional): City. Example: New York.
- `country` (`string`, optional): Country code. Example: US.
- `description` (`string`, optional): Description or notes. Example: Key account.
- `number` (`string`, optional): Unique reference number. Example: 102.
- `state` (`string`, optional): State or region. Example: NY.
- `website` (`string`, optional): Website URL. Example: http://www.example.com.
- `zip` (`string`, optional): ZIP or postal code. Example: 12345.

Example input: `{"name":"<name>"}`

### `clientary_client_update`

Update Client · Write

Update the fields you pass on a client. Returns the updated client.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the client. Example: 1234.
- `address` (`string`, optional): Street address. Example: 123 Main St.
- `address_2` (`string`, optional): Street address, line 2. Example: Suite 101.
- `city` (`string`, optional): City. Example: New York.
- `country` (`string`, optional): Country code. Example: US.
- `description` (`string`, optional): Description or notes. Example: Key account.
- `name` (`string`, optional): Name of the company or organization. Example: ACME Corp.
- `number` (`string`, optional): Unique reference number. Example: 102.
- `state` (`string`, optional): State or region. Example: NY.
- `website` (`string`, optional): Website URL. Example: http://www.example.com.
- `zip` (`string`, optional): ZIP or postal code. Example: 12345.

Example input: `{"id":1234}`

### `clientary_comment_create`

Add Comment · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Comment text. Example: Please review the revised total.
- `resource` (`string`, required): Type of record the comments are on. Example: invoices. One of: `invoices`, `estimates`, `projects`, `tasks`, `proposals`, `contracts`.
- `resource_id` (`integer`, required): ID of the invoice, estimate, project, task, proposal or contract. Example: 1234.
- `staff_only` (`boolean`, optional): true to hide the comment from client contacts. Example: false.

Example input: `{"body":"<body>","resource":"invoices","resource_id":1234}`

### `clientary_contact_create`

Create Contact · Write

Create a contact (a person) under a client. Returns the new contact with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `client_id` (`integer`, required): ID of the client the contact belongs to. Example: 1234.
- `email` (`string`, required): Email address. Example: john@example.com.
- `name` (`string`, required): Full name of the contact. Example: John Doe.
- `ext` (`string`, optional): Phone extension. Example: 204.
- `mobile` (`string`, optional): Mobile phone number. Example: +1 555 0199.
- `phone` (`string`, optional): Phone number. Example: +1 555 0100.
- `title` (`string`, optional): Job title. Example: Software Developer.

Example input: `{"client_id":1234,"email":"<email>","name":"<name>"}`

### `clientary_contact_update`

Update Contact · Write

Update the fields you pass on a contact. Returns the updated contact.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the contact. Example: 1234.
- `email` (`string`, optional): Email address. Example: john@example.com.
- `ext` (`string`, optional): Phone extension. Example: 204.
- `mobile` (`string`, optional): Mobile phone number. Example: +1 555 0199.
- `name` (`string`, optional): Full name of the contact. Example: John Doe.
- `phone` (`string`, optional): Phone number. Example: +1 555 0100.
- `title` (`string`, optional): Job title. Example: Software Developer.

Example input: `{"id":1234}`

### `clientary_contract_send`

Send Contract · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): ID of the contract. Example: 1234.
- `recipients` (`array`, required): Email addresses to send the contract to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
- `attach_pdf` (`integer`, optional): 1 to attach the contract as a PDF. Example: 1.
- `message` (`string`, optional): Email body. Example: Please find your contract attached.
- `send_copy` (`integer`, optional): 1 to send a copy to the API token's user. Example: 1.
- `subject` (`string`, optional): Email subject. Example: Your contract from ACME.

Example input: `{"id":1234,"recipients":["jane@example.com"]}`

### `clientary_estimate_create`

Create Estimate · Write

Create an estimate (quote) with line items, as a draft. Returns the new estimate with its id. Use clientary_estimate_send to email it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `currency_code` (`string`, required): Three-letter currency code. Example: USD.
- `date` (`string`, required): Document date (YYYY-MM-DD). Example: 2026-03-01.
- `client_id` (`integer`, optional): ID of the client. Example: 4.
- `estimate_items_attributes` (`array`, optional): 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}].
- `note` (`string`, optional): Note shown to the client. Example: Thank you for your business.
- `number` (`string`, optional): Document number; auto-incremented when left empty. Example: 185.
- `summary` (`string`, optional): Summary shown on the document. Example: Design work for March.
- `tax` (`number`, optional): Primary tax rate in percent. Example: 5.
- `tax_label` (`string`, optional): Label of the primary tax. Example: Sales Tax.
- `title` (`string`, optional): Title shown on the document. Example: March retainer.

Example input: `{"currency_code":"<currency_code>","date":"<date>"}`

### `clientary_estimate_send`

Send Estimate · Write

Email an estimate to recipients and mark it sent. Returns the result of the send.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): ID of the estimate. Example: 1234.
- `recipients` (`array`, required): Email addresses to send the estimate to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
- `attach_pdf` (`integer`, optional): 1 to attach the estimate as a PDF. Example: 1.
- `message` (`string`, optional): Email body. Example: Please find your estimate attached.
- `send_copy` (`integer`, optional): 1 to send a copy to the API token's user. Example: 1.
- `subject` (`string`, optional): Email subject. Example: Your estimate from ACME.

Example input: `{"id":1234,"recipients":["jane@example.com"]}`

### `clientary_estimate_update`

Update Estimate · Write

Update the fields you pass on an estimate, and add, change or remove line items. Returns the updated estimate.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the estimate. Example: 1234.
- `client_id` (`integer`, optional): ID of the client. Example: 4.
- `currency_code` (`string`, optional): Three-letter currency code. Example: USD.
- `date` (`string`, optional): Document date (YYYY-MM-DD). Example: 2026-03-01.
- `estimate_items_attributes` (`array`, optional): 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}].
- `note` (`string`, optional): Note shown to the client. Example: Thank you for your business.
- `number` (`string`, optional): Document number; auto-incremented when left empty. Example: 185.
- `summary` (`string`, optional): Summary shown on the document. Example: Design work for March.
- `tax` (`number`, optional): Primary tax rate in percent. Example: 5.
- `tax_label` (`string`, optional): Label of the primary tax. Example: Sales Tax.
- `title` (`string`, optional): Title shown on the document. Example: March retainer.

Example input: `{"id":1234}`

### `clientary_expense_create`

Create Expense · Write

Record an expense, optionally for a client or project. Returns the new expense with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`number`, required): Expense amount. Example: 500.
- `client_id` (`integer`, optional): ID of the client to assign it to. Example: 4.
- `description` (`string`, optional): What the expense was for. Example: Flight to client site.
- `incurred_on` (`string`, optional): Date of the expense (YYYY-MM-DD). Example: 2026-03-02.
- `project_id` (`integer`, optional): ID of the project to assign it to. Example: 7.

Example input: `{"amount":500}`

### `clientary_expense_update`

Update Expense · Write

Update the fields you pass on an expense. Returns the updated expense.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the expense. Example: 1234.
- `amount` (`number`, optional): Expense amount. Example: 500.
- `client_id` (`integer`, optional): ID of the client to assign it to. Example: 4.
- `description` (`string`, optional): What the expense was for. Example: Flight to client site.
- `incurred_on` (`string`, optional): Date of the expense (YYYY-MM-DD). Example: 2026-03-02.
- `project_id` (`integer`, optional): ID of the project to assign it to. Example: 7.

Example input: `{"id":1234}`

### `clientary_hours_create`

Log Time · Write

Log a time entry on a project as the API token's user. Returns the new entry with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `hours` (`number`, required): Hours worked, e.g. 1.5. Example: 5.5.
- `project_id` (`integer`, required): ID of the project. Example: 1234.
- `title` (`string`, required): What the time was spent on. Example: Setup and Documentation.
- `date` (`string`, optional): Date worked (YYYY-MM-DD); defaults to today. Example: 2026-03-10.
- `description` (`string`, optional): Longer description of the work. Example: Configured CI and wrote the README.

Example input: `{"hours":1.5,"project_id":1234,"title":"<title>"}`

### `clientary_hours_update`

Update Time Entry · Write

Update the fields you pass on a time entry. Returns the updated entry.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the time entry. Example: 1234.
- `date` (`string`, optional): Date worked (YYYY-MM-DD); defaults to today. Example: 2026-03-10.
- `description` (`string`, optional): Longer description of the work. Example: Configured CI and wrote the README.
- `hours` (`number`, optional): Hours worked, e.g. 1.5. Example: 5.5.
- `title` (`string`, optional): What the time was spent on. Example: Setup and Documentation.

Example input: `{"id":1234}`

### `clientary_invoice_create`

Create Invoice · Write

Create an invoice with line items, as a draft. Returns the new invoice with its id. Use clientary_invoice_send to email it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `currency_code` (`string`, required): Three-letter currency code. Example: USD.
- `date` (`string`, required): Document date (YYYY-MM-DD). Example: 2026-03-01.
- `due_date` (`string`, required): Due date (YYYY-MM-DD). Example: 2026-03-31.
- `client_id` (`integer`, optional): ID of the client. Example: 4.
- `invoice_items_attributes` (`array`, optional): 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}].
- `note` (`string`, optional): Note shown to the client. Example: Thank you for your business.
- `number` (`string`, optional): Document number; auto-incremented when left empty. Example: 185.
- `po` (`string`, optional): Purchase order number. Example: PO-2026-001.
- `summary` (`string`, optional): Summary shown on the document. Example: Design work for March.
- `tax` (`number`, optional): Primary tax rate in percent. Example: 5.
- `tax_label` (`string`, optional): Label of the primary tax. Example: Sales Tax.
- `title` (`string`, optional): Title shown on the document. Example: March retainer.

Example input: `{"currency_code":"<currency_code>","date":"<date>","due_date":"<due_date>"}`

### `clientary_invoice_send`

Send Invoice · Write

Email an invoice to recipients and mark it sent. Returns the result of the send.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): ID of the invoice. Example: 1234.
- `recipients` (`array`, required): Email addresses to send the invoice to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
- `attach_pdf` (`integer`, optional): 1 to attach the invoice as a PDF. Example: 1.
- `message` (`string`, optional): Email body. Example: Please find your invoice attached.
- `send_copy` (`integer`, optional): 1 to send a copy to the API token's user. Example: 1.
- `subject` (`string`, optional): Email subject. Example: Your invoice from ACME.

Example input: `{"id":1234,"recipients":["jane@example.com"]}`

### `clientary_invoice_update`

Update Invoice · Write

Update the fields you pass on an invoice, and add, change or remove line items. Returns the updated invoice.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the invoice. Example: 1234.
- `client_id` (`integer`, optional): ID of the client. Example: 4.
- `currency_code` (`string`, optional): Three-letter currency code. Example: USD.
- `date` (`string`, optional): Document date (YYYY-MM-DD). Example: 2026-03-01.
- `due_date` (`string`, optional): Due date (YYYY-MM-DD). Example: 2026-03-31.
- `invoice_items_attributes` (`array`, optional): 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}].
- `note` (`string`, optional): Note shown to the client. Example: Thank you for your business.
- `number` (`string`, optional): Document number; auto-incremented when left empty. Example: 185.
- `po` (`string`, optional): Purchase order number. Example: PO-2026-001.
- `summary` (`string`, optional): Summary shown on the document. Example: Design work for March.
- `tax` (`number`, optional): Primary tax rate in percent. Example: 5.
- `tax_label` (`string`, optional): Label of the primary tax. Example: Sales Tax.
- `title` (`string`, optional): Title shown on the document. Example: March retainer.

Example input: `{"id":1234}`

### `clientary_lead_create`

Create Lead · Write

Create a lead (a prospective client). Returns the new lead with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the company or organization. Example: ACME Corp.
- `address` (`string`, optional): Street address. Example: 123 Main St.
- `address_2` (`string`, optional): Street address, line 2. Example: Suite 101.
- `city` (`string`, optional): City. Example: New York.
- `country` (`string`, optional): Country code. Example: US.
- `description` (`string`, optional): Description or notes. Example: Key account.
- `number` (`string`, optional): Unique reference number. Example: 102.
- `state` (`string`, optional): State or region. Example: NY.
- `website` (`string`, optional): Website URL. Example: http://www.example.com.
- `zip` (`string`, optional): ZIP or postal code. Example: 12345.

Example input: `{"name":"<name>"}`

### `clientary_lead_update`

Update Lead · Write

Update the fields you pass on a lead. Returns the updated lead.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the lead. Example: 1234.
- `address` (`string`, optional): Street address. Example: 123 Main St.
- `address_2` (`string`, optional): Street address, line 2. Example: Suite 101.
- `city` (`string`, optional): City. Example: New York.
- `country` (`string`, optional): Country code. Example: US.
- `description` (`string`, optional): Description or notes. Example: Key account.
- `name` (`string`, optional): Name of the company or organization. Example: ACME Corp.
- `number` (`string`, optional): Unique reference number. Example: 102.
- `state` (`string`, optional): State or region. Example: NY.
- `website` (`string`, optional): Website URL. Example: http://www.example.com.
- `zip` (`string`, optional): ZIP or postal code. Example: 12345.

Example input: `{"id":1234}`

### `clientary_payment_create`

Record Invoice Payment · Write

Record a payment against an invoice, or charge the client's saved payment profile for the whole outstanding balance. Returns the new payment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `invoice_id` (`integer`, required): ID of the invoice. Example: 1234.
- `amount` (`number`, optional): Amount received. Required unless payment_profile_id is given. Example: 500.
- `note` (`string`, optional): Note about the payment, e.g. how it was paid. Example: Paid by check.
- `payment_profile_id` (`integer`, optional): ID of the client's saved payment profile to charge for the whole outstanding balance; amount and note are then ignored. Example: 123.

Example input: `{"invoice_id":1234}`

### `clientary_project_create`

Create Project · Write

Create a project for time tracking and billing. Returns the new project with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Project name. Example: ACME website redesign.
- `rate` (`number`, required): Hourly rate for an hourly project, or the total price for a fixed amount project. Example: 150.
- `budget` (`number`, optional): Budget in hours or currency, depending on budget_type. Example: 100.
- `budget_type` (`integer`, optional): 0 to budget total hours, 1 to budget a total amount. Example: 0.
- `client_id` (`integer`, optional): ID of the client the project is for. Example: 2123.
- `currency_code` (`string`, optional): Three-letter currency code. Example: USD.
- `description` (`string`, optional): Project description. Example: Redesign of the marketing site.
- `end_date` (`string`, optional): Project end date (YYYY-MM-DD). Example: 2026-12-31.
- `number` (`string`, optional): Unique project number. Example: P-104.
- `project_type` (`integer`, optional): 0 for an hourly rate project, 2 for a fixed amount project. Example: 0.

Example input: `{"name":"<name>","rate":150}`

### `clientary_project_update`

Update Project · Write

Update the fields you pass on a project. Returns the updated project.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the project. Example: 1234.
- `budget` (`number`, optional): Budget in hours or currency, depending on budget_type. Example: 100.
- `budget_type` (`integer`, optional): 0 to budget total hours, 1 to budget a total amount. Example: 0.
- `client_id` (`integer`, optional): ID of the client the project is for. Example: 2123.
- `currency_code` (`string`, optional): Three-letter currency code. Example: USD.
- `description` (`string`, optional): Project description. Example: Redesign of the marketing site.
- `end_date` (`string`, optional): Project end date (YYYY-MM-DD). Example: 2026-12-31.
- `name` (`string`, optional): Project name. Example: ACME website redesign.
- `number` (`string`, optional): Unique project number. Example: P-104.
- `project_type` (`integer`, optional): 0 for an hourly rate project, 2 for a fixed amount project. Example: 0.
- `rate` (`number`, optional): Hourly rate for an hourly project, or the total price for a fixed amount project. Example: 150.
- `status` (`integer`, optional): 1 active, 2 completed, 4 billable. Example: 2.

Example input: `{"id":1234}`

### `clientary_proposal_send`

Send Proposal · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`integer`, required): ID of the proposal. Example: 1234.
- `recipients` (`array`, required): Email addresses to send the proposal to; addresses that are not contacts of the client become contacts. Example: ["jane@example.com"]
- `attach_pdf` (`integer`, optional): 1 to attach the proposal as a PDF. Example: 1.
- `message` (`string`, optional): Email body. Example: Please find your proposal attached.
- `send_copy` (`integer`, optional): 1 to send a copy to the API token's user. Example: 1.
- `subject` (`string`, optional): Email subject. Example: Your proposal from ACME.

Example input: `{"id":1234,"recipients":["jane@example.com"]}`

### `clientary_task_create`

Create Task · Write

Create a task, optionally on a project and assigned to a staff user. Returns the new task with its id.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `title` (`string`, required): Task title. Example: Send kickoff agenda.
- `assignee_id` (`integer`, optional): ID of the staff user to assign. Example: 3.
- `description` (`string`, optional): Task details. Example: Share the agenda with the client a day before.
- `due_date` (`string`, optional): Due date (YYYY-MM-DD). Example: 2026-03-20.
- `project_id` (`integer`, optional): ID of the project the task belongs to. Example: 7.

Example input: `{"title":"<title>"}`

### `clientary_task_update`

Update Task · Write

Update the fields you pass on a task, including marking it completed. Returns the updated task.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the task. Example: 1234.
- `assignee_id` (`integer`, optional): ID of the staff user to assign. Example: 3.
- `completed` (`boolean`, optional): true to mark the task done, false to reopen it. Example: true.
- `description` (`string`, optional): Task details. Example: Share the agenda with the client a day before.
- `due_date` (`string`, optional): Due date (YYYY-MM-DD). Example: 2026-03-20.
- `project_id` (`integer`, optional): ID of the project the task belongs to. Example: 7.
- `title` (`string`, optional): Task title. Example: Send kickoff agenda.

Example input: `{"id":1234}`

### `clientary_client_delete`

Delete Client · Destructive

Delete a client together with all its projects, invoices, estimates and contacts. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the client. Example: 1234.

Example input: `{"id":1234}`

### `clientary_contact_delete`

Delete Contact · Destructive

Delete a contact and its comments. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the contact. Example: 1234.

Example input: `{"id":1234}`

### `clientary_estimate_delete`

Delete Estimate · Destructive

Delete an estimate with its items. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the estimate. Example: 1234.

Example input: `{"id":1234}`

### `clientary_expense_delete`

Delete Expense · Destructive

Delete an expense. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the expense. Example: 1234.

Example input: `{"id":1234}`

### `clientary_hours_delete`

Delete Time Entry · Destructive

Delete a time entry. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the time entry. Example: 1234.

Example input: `{"id":1234}`

### `clientary_invoice_delete`

Delete Invoice · Destructive

Delete an invoice with its items and payments. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the invoice. Example: 1234.

Example input: `{"id":1234}`

### `clientary_lead_delete`

Delete Lead · Destructive

Delete a lead together with its estimates and contacts. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the lead. Example: 1234.

Example input: `{"id":1234}`

### `clientary_payment_delete`

Delete Invoice Payment · Destructive

Delete a payment from an invoice. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the payment. Example: 2053932801.
- `invoice_id` (`integer`, required): ID of the invoice. Example: 1234.

Example input: `{"id":2053932801,"invoice_id":1234}`

### `clientary_project_delete`

Delete Project · Destructive

Delete a project with its tasks, logged hours, comments and notes. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the project. Example: 1234.

Example input: `{"id":1234}`

### `clientary_task_delete`

Delete Task · Destructive

Delete a task. Deletions are permanent.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`integer`, required): ID of the task. Example: 1234.

Example input: `{"id":1234}`

## Related

Other Accounting & Finance connectors ([all 82](/agentkit/connectors/?category=accounting-finance)):

- [QuickBooks](/agentkit/connectors/quickbooks/): Scalekit connector, OAuth, 117 tools
- [Xero](/agentkit/connectors/xero/): Scalekit connector, OAuth, 94 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
