Tradify by Cotlet

dev.cotlet由 cotlet.dev 发布官方发布者v1.0.2更新于 Nov 1, 2026

Jobs, quotes, invoices and schedule in Tradify.

发布方自己的服务:Cotlet

已验证Streamable HTTP可网页运行效率与工作流金融商业与电商

概览

AI 生成的概览

将助手连接到 Tradify 行业业务账户,用于查询和创建工单、报价、发票、客户及排程预约。

可以做什么
  • 列出并读取工单、客户、报价和发票,含明细、付款与关联记录的完整详情
  • 创建客户、工单和带明细行的报价草稿,并更改工单状态
  • 从报价生成发票草稿,批准并邮件发送报价或发票,登记已收付款
  • 列出并为员工预约排程,可选向客户发送确认邮件
  • 通过本地 REST 接口或 Python 调用以 JSON 导出列表,并用 next_cursor 分页
适用场景
适合 Tradify 用户让助手查询工单、客户、报价和发票,根据笔记起草报价或发票,催收逾期发票,或安排排程,而无需在网页应用中逐项操作。
运行要求
需要 Python 3.11 或更高版本及 Tradify 账户;可通过 uvx 或 pip 本地运行,也可作为远程端点使用 Authorization bearer API 密钥。需从 Google Chrome(开启远程调试)或手动粘贴的 SessionId cookie 读取 Tradify 会话;send_quote 和 send_invoice 需在 Tradify 中启用两步验证。
安装前请注意
保存的会话文件可让持有者在 Tradify 中冒充用户操作,务必妥善保管。发送报价或发票会向真实客户发邮件且无法撤回,只能作废;排程预约会通知员工。登记付款会改动财务记录。自托管许可仅限非商业用途,且该服务器调用 Tradify 私有网页接口,Tradify 改版时可能失效。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Tradify by Cotlet,将其添加到工作区。
  2. 连接 所需的 凭据。它们会被私密存储,绝不会在公开页面上展示。
  3. 为需要使用其工具的对话启用该服务。

Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。

交给智能体安装

把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。

阅读 https://sourceweft.com/mcp/dev.cotlet%2Ftradify/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。

查看智能体所依据的安装指南

其他 MCP 客户端

把它添加到你客户端的 mcpServers 配置中。 客户端会在首次连接时完成 OAuth 登录。

{
  "mcpServers": {
    "tradify-by-cotlet": {
      "type": "http",
      "url": "https://cotlet.dev/mcp/v1/tradify/connect"
    }
  }
}

README

Tradify API and MCP server, self-hosted

A Tradify API and a Tradify MCP server you run on your own computer, in Python, on the session of your own Google Chrome. All 22 Tradify tools we run in production at Cotlet: jobs, job status and notes, customers, quotes with line items, invoices from quotes, quote and invoice email, payments, the Scheduler, reports and timesheets.

Tradify has no public API, no API keys, no webhooks and no official MCP server. Its accounting connectors (Xero, QuickBooks, Sage) sync invoices and bills, not jobs, quotes or the schedule. This repo gives you:

  • MCP server for Claude Code, Claude Desktop, Cursor, Codex and any MCP client, over stdio or HTTP. Setup
  • REST API on http://127.0.0.1:8787/api/v1/tradify, with OpenAPI docs at /docs. Setup
  • Python: call("list_invoices", {"status": "overdue"}), plus 9 ready scripts in examples/.

It is for technical people who want to run it themselves, for noncommercial use only (license). If you want it running 24/7 on a server, kept working when Tradify changes its web app, for a team or a business, use the hosted version at cotlet.dev.

[Tradify MCP server] [Python 3.11+] [License: PolyForm Noncommercial 1.0.0] [MCP Badge]

bash
uv tool install tradify-api-mcp                  # or: pip install tradify-api-mcptradify-mcp connect                                # reads your Tradify session from Chrometradify-mcp call list_jobsclaude mcp add tradify -- uvx tradify-api-mcp mcp

Contents

How it works

text
AI agent (MCP) / script (REST, Python) ──▶ tradify-mcp on your computer ──your cookies──▶ go.tradifyhq.com                                                  ▲                        tradify-mcp connect ──────┘ reads them once from your Chrome (DevTools Protocol)
  1. You sign in to Tradify in your own Chrome at go.tradifyhq.com, the way you always do: username, Continue, password. Tick Keep me logged in.
  2. tradify-mcp connect attaches to that Chrome through the Chrome DevTools Protocol, reads the tradifyhq.com cookies and saves them to ~/.config/tradify-api-mcp/session.json, readable by your user only. It never sees or stores your password or a 2-Step code.
  3. Every tool call is a request to the /api the Tradify web app itself calls, with those cookies, sent with curl_cffi, which copies Chrome's TLS fingerprint. Calls that change something carry the app's antiforgery token, read fresh for each tool run. No headless browser runs.

The session lives in one cookie, SessionId. With Keep me logged in Tradify keeps it for about a month. When Tradify signs you out, the server reads the cookies from Chrome again, if Chrome is open with remote debugging on.

Requirements

  • Python 3.11 or newer.
  • Google Chrome 144 or newer, signed in to go.tradifyhq.com. Any Chrome or Chromium works with a debugging port.
  • macOS, Linux or Windows.
  • A Tradify account. We build and test with the company owner. An office user sees and does what Tradify lets that user do. send_quote and send_invoice need 2-Step Security on the login (Settings > Security), because Tradify blocks quote and invoice email without it.

Install

From PyPI:

bash
uv tool install tradify-api-mcp       # or: pipx install tradify-api-mcp, or: pip install tradify-api-mcptradify-mcp --version

MCP clients can also run it with no install: uvx tradify-api-mcp mcp.

From source:

bash
git clone https://github.com/cotletdev/tradify-api-mcp-server.gitcd tradify-api-mcp-serverpython3 -m venv .venv. .venv/bin/activate              # Windows: .venv\Scripts\activatepip install -e .tradify-mcp --version

With uv: uv venv && uv pip install -e ., then uv run tradify-mcp ....

Setting it up with an AI agent (Claude Code, Codex, Cursor)? Open it in this folder and ask it to set up the repo: AGENTS.md tells it every step, and it asks you only for the steps in Chrome.

To update: uv tool upgrade tradify-api-mcp (or pip install -U tradify-api-mcp), from source git pull && pip install -e .. We copy every change of the hosted Tradify tools into this repo.

Connect your Chrome

Option A: your everyday Chrome (recommended)

  1. Open chrome://inspect/#remote-debugging in Chrome and switch remote debugging on. Chrome then accepts DevTools connections from programs on this computer, and asks you before each one.

  2. Make sure you are signed in at go.tradifyhq.com.

  3. Run:

    bash
    tradify-mcp connect
  4. Chrome asks whether to allow the connection. Click Allow.

text
Saved 6 Tradify cookies to /Users/you/.config/tradify-api-mcp/session.jsonSigned in to Tradify as Dan Novak (Northside Plumbing)

You can switch remote debugging off again afterwards. Leave it on if you want the server to pick up a new session by itself after Tradify signs you out.

connect looks for Chrome's DevToolsActivePort file in the default profile folder. For Chrome Beta, Canary or a custom profile folder, pass --profile-dir "<folder>".

Option B: a Chrome with a debugging port

Chrome does not open a debugging port on your default profile, so start a separate one, sign in to Tradify there once, and connect to it:

bash
# macOS"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-tradify"# Linuxgoogle-chrome --remote-debugging-port=9222 --user-data-dir="$HOME/.chrome-tradify"# Windows"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="%USERPROFILE%\.chrome-tradify"
tradify-mcp connect --cdp http://127.0.0.1:9222

A fresh profile is a new device to Tradify, so with 2-Step Security on it asks for a code at sign-in. --cdp also takes a ws:// DevTools URL, for example of a Chrome on another machine reached over an SSH tunnel.

Option C: paste the cookie by hand

For a server with no Chrome: in Chrome open DevTools on go.tradifyhq.com, Application > Cookies > https://go.tradifyhq.com, copy the value of SessionId, then:

bash
tradify-mcp connect --token          # paste it, input is hidden# or, without a session file:export TRADIFY_AUTH_TOKEN=...

A pasted cookie is not read again from Chrome. Paste a new one when Tradify signs you out.

Check the session at any time:

bash
tradify-mcp status

MCP server

The MCP server lists every tool with its input schema, a description written for agents, and hints. Read tools are marked read-only, and the tools that reach other people (quote and invoice email, Scheduler bookings) are marked so your client asks before running them.

Claude Code

bash
claude mcp add tradify -- uvx tradify-api-mcp mcp# read only:claude mcp add tradify -- uvx tradify-api-mcp mcp --read-only

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

json
{  "mcpServers": {    "tradify": {      "command": "uvx",      "args": ["tradify-api-mcp", "mcp"]    }  }}

Cursor

~/.cursor/mcp.json, the same block as Claude Desktop. A ready copy is in mcp.json.

Codex

~/.codex/config.toml:

toml
[mcp_servers.tradify]command = "uvx"args = ["tradify-api-mcp", "mcp"]

Over HTTP

tradify-mcp serve also serves MCP over streamable HTTP at http://127.0.0.1:8787/mcp, for clients that take a URL:

bash
tradify-mcp serveclaude mcp add --transport http tradify http://127.0.0.1:8787/mcp

Then ask your agent things like:

New job for Sam Lee at 12 Oak St: replace the hot water cylinder. Book Mike Ross for Thursday morning, about four hours, and email Sam the confirmation.

Quote the bathroom rewire at 14 Elm Rd from my notes: 6 hours on the Standard billing rate, 6 LED downlights at $24 each, one extractor fan at $85. Show me the draft before you send it.

For every quote accepted this week, create a 30% deposit invoice, skip anything under $500 or already invoiced, and send them after I check the list.

Record the bank transfers I paste below against their invoices, then list every invoice still overdue, totalled per customer, oldest first.

REST API

bash
tradify-mcp serve                   # http://127.0.0.1:8787, MCP at /mcp, docs at /docs

Each tool has its own route under /api/v1/tradify, the same paths as the hosted API at cotlet.dev, so code written against one works with the other. Path parts and the query string are arguments, and a JSON body adds the rest.

bash
curl 'http://127.0.0.1:8787/api/v1/tradify/jobs?status=to_invoice'curl 'http://127.0.0.1:8787/api/v1/tradify/invoices?status=overdue'curl 'http://127.0.0.1:8787/api/v1/tradify/appointments?from=2026-10-27&to=2026-10-31'curl -X POST http://127.0.0.1:8787/api/v1/tradify/invoices/558f2199-6ca6-489e-bfdf-d4d11cd878e3/payments \  -H 'Content-Type: application/json' \  -d '{"amount": 300, "method": "Bank Deposit", "reference": "TRF 20261023"}'

Any tool by name, body as its arguments:

bash
curl -X POST http://127.0.0.1:8787/api/v1/tradify/tools/list_customers -d '{"search": "lee"}'
  • GET /api/v1/tradify/tools: every tool with its route, input schema and an example answer.
  • GET /docs: interactive OpenAPI docs, GET /openapi.json the schema, for n8n, Postman or a generated client.
  • Answers are JSON. List tools return next_cursor; pass it back as cursor for the next page.

The server listens on 127.0.0.1 only. To reach it from another device of yours, set a token, and every request then needs Authorization: Bearer <token>:

bash
TRADIFY_MCP_TOKEN=$(openssl rand -hex 24) tradify-mcp serve --host 0.0.0.0

Python and the example scripts

Straight from Python, no server needed:

python
from tradify_api_mcp import callfrom tradify_api_mcp.scripting import paginate, write_rows
overdue = call("list_invoices", {"status": "overdue"})["invoices"]week = call("list_appointments", {"from": "2026-10-27", "to": "2026-10-31"})["appointments"]jobs = list(paginate("list_jobs", {"status": "all"}, "jobs"))write_rows(jobs, "jobs.csv")call("update_job_status", job_id="d3bd2e39-af25-4cda-9daf-d9f758f8f0e5", status="complete")

Or one tool from the shell: tradify-mcp call list_quotes status=accepted since=2026-10-01, or with a JSON object.

Times are wall clock in your company's time zone (Settings > Company). 2026-10-29T08:00 means 8:00 there. A time with an offset is converted to it, and answers carry the company's offset.

Ready scripts in examples/. Each prints a short list or JSON, takes --out file.csv or --out file.json where it makes sense, and --help. The ones that change Tradify only show their plan until you pass --apply or --send:

ScriptWhat it does
overdue_invoices.pyEvery overdue invoice, totalled per customer, oldest first, with the ones past your last reminder marked. A call list.
record_payments.pyRecords the payments of a CSV bank export against invoices by number. Skips an unknown or closed invoice and a payment above the amount due. --apply.
pay_and_close.pyRecords a payment on one invoice and sets its jobs to complete once nothing is due.
job_from_call.pyFinds or adds the caller, creates the job, and with --start books staff after checking their day for overlaps.
quote_from_notes.pyA draft quote from a text file of time and misc lines; --send emails it.
deposit_invoices.pyA percentage deposit invoice for every quote accepted lately whose job has no invoice yet. --apply, --send.
tomorrows_schedule.pyTomorrow's Scheduler grouped by staff member, with job, customer and crew notes.
export_jobs.pyJobs to CSV or JSON. --status, --search.
export_customers.pyEvery customer to CSV or JSON, with sites. --archived.
bash
python examples/overdue_invoices.pypython examples/deposit_invoices.py --percent 30 --minimum 500python examples/export_jobs.py --status to_invoice --out to_invoice.csv

On a schedule, cron on your own computer works while it is on: 0 18 * * * cd ~/tradify-api-mcp-server && .venv/bin/python examples/tomorrows_schedule.py.

All 22 tools

IDs come from the list tools: job_id from list_jobs, customer_id from list_customers, quote_id from list_quotes, invoice_id from list_invoices. Staff are named by full name, as on the Scheduler. tradify-mcp tools prints this list, tradify-mcp tools --json adds the input schemas.

Jobs

ToolAccessREST routeWhat it does
list_jobsreadGET /jobsJobs with number, customer, site address, status and assigned staff.
get_jobreadGET /jobs/{job_id}Full job: description, site, tasks, notes, appointments, costs, linked quotes and invoices.
create_jobwritePOST /customers/{customer_id}/jobsNew job for a customer. It starts as Unassigned.
update_job_statuswritePATCH /jobs/{job_id}/statusSet a status on a job, built-in or one of your custom statuses.
add_job_notewritePOST /jobs/{job_id}/notesAdd a text note to a job's Notes tab. It notifies no one.

Customers

ToolAccessREST routeWhat it does
list_customersreadGET /customersCustomer profiles with contact details and sites.
get_customerreadGET /customers/{customer_id}Customer profile with sites, notes, latest jobs, quotes and invoices, and the balance due.
create_customerwritePOST /customersNew customer profile, optionally with contact details and a physical address.

Quotes

ToolAccessREST routeWhat it does
list_quotesreadGET /quotesQuotes with customer, total, quote date, expiry date and status.
get_quotereadGET /quotes/{quote_id}Full quote: lines with price and cost, tax, totals, gross profit, dates and invoices made from it.
create_quotewritePOST /customers/{customer_id}/quotesDraft quote with line items. Nothing is sent until you call send_quote.
send_quotewritePOST /quotes/{quote_id}/sendApprove the quote and email it to the customer with a link to accept or decline online.

Invoices and payments

ToolAccessREST routeWhat it does
list_invoicesreadGET /invoicesInvoices with customer, job, due date, total, amount paid and amount due.
get_invoicereadGET /invoices/{invoice_id}Full invoice: lines, tax, totals, every payment with date and method, amount due, jobs and quote.
create_invoice_from_quotewritePOST /quotes/{quote_id}/invoicesDraft invoice from an approved or accepted quote, for all of it or part of it.
send_invoicewritePOST /invoices/{invoice_id}/sendApprove the invoice and email it to the customer, with payment reminders if enabled.
record_paymentwritePOST /invoices/{invoice_id}/paymentsRecord a payment received against an invoice and reduce the amount due.

Scheduler

ToolAccessREST routeWhat it does
list_appointmentsreadGET /appointmentsScheduler appointments in a date range, with staff, job, times and notes.
schedule_appointmentwritePOST /jobs/{job_id}/appointmentsBook a job appointment on the Scheduler for staff, optionally emailing the customer a confirmation.

Reports and timesheets

ToolAccessREST routeWhat it does
get_reportreadGET /reports/{report}Job profitability, job sheet, staff productivity or timesheet report for a period, as rows.
list_timesheetsreadGET /timesheetsTimesheet entries in a date range: staff, job, customer, billing rate, hours, notes, invoiced.
log_timewritePOST /timesheetsAdd a timesheet entry for a staff member, optionally on a job, with billing rate and notes.

send_quote and send_invoice email the customer. schedule_appointment sends each staff member Tradify's "You've been scheduled" notice, and emails the customer only with email_customer. The other write tools stay inside Tradify. Drafts from create_quote and create_invoice_from_quote reach nobody. record_payment refuses more than the amount due and a draft invoice. Part invoices from a quote (percentage, fixed_amount, line_items) need a plan with progress invoicing, which Tradify sells as Pro.

Not in this version: price list items, kits and quote options (quotes take misc and time lines), editing or deleting a quote, invoice or customer, editing or deleting a time entry, moving or cancelling an appointment, report PDFs, job tasks and attachments, bills, purchase orders, enquiries, recurring jobs and forms.

Never built, on purpose: your Tradify sign-in, password and 2-Step Security, and your Tradify plan and billing. Every request passes a guard that refuses any change to the sign-in and account paths of the web app.

Configuration

VariableDefaultWhat it does
TRADIFY_MCP_HOME~/.config/tradify-api-mcpFolder of session.json.
TRADIFY_AUTH_TOKENThe SessionId cookie value, used instead of session.json.
TRADIFY_PROXYProxy for every request to Tradify, e.g. http://user:pass@host:port.
TRADIFY_MCP_READ_ONLY1 hides and refuses every tool that changes Tradify (same as --read-only).
TRADIFY_MCP_TOKENBearer token required by serve; needed to listen beyond 127.0.0.1.
TRADIFY_MCP_HOST, TRADIFY_MCP_PORT127.0.0.1, 8787Address of serve.

Security and your Tradify account

  • Your password never reaches this code. Only the cookies Chrome already holds are read, and only those of tradifyhq.com.
  • The session file is yours. session.json is created with mode 0600. Anyone who has it can act as you in Tradify, so keep it out of git and shared folders.
  • Local by default. serve binds to 127.0.0.1 and refuses another address without TRADIFY_MCP_TOKEN.
  • tradifyhq.com only. Requests and redirects outside tradifyhq.com are refused.
  • Read-only mode. --read-only or TRADIFY_MCP_READ_ONLY=1 exposes the 6 read tools only.
  • Some actions reach real people. A sent quote or invoice lands in your customer's inbox and cannot be deleted in Tradify afterwards, only cancelled. MCP clients ask before running those tools; a script does not, so try it on a customer with your own email address first.

Errors

The REST API answers {"error": "<code>", "message": "..."}. The MCP server returns the same code and message as a tool error.

StatusCodeWhat to do
401auth_required, auth_expiredNo session, or Tradify signed you out. Sign in at go.tradifyhq.com in Chrome and run tradify-mcp connect.
403app_permission_deniedTradify does not let this login do it. For send_quote and send_invoice: set up 2-Step Security first.
403scope_deniedThe server runs read-only, or the request would change your Tradify sign-in.
403target_blockedTradify refused the request or showed a bot check. Open the web app in Chrome once, then retry.
409captcha_requiredTradify asks for a CAPTCHA. Solve it in Chrome.
422invalid_inputAn argument is missing or wrong; the message names it.
429rate_limitedTradify is limiting the account. Wait a few minutes.
502target_errorTradify answered with an error (its own message is in message when it gives one), or changed its web app. git pull for the latest tools, or open an issue.

Self-hosted or hosted

This repoCotlet, hosted
Toolsthe same 15the same 15
Runson your computer, while it is onin the cloud, 24/7
Tradify sessionyour Chrome, saved in a local fileyour own Cloud Browser in the EU, profile encrypted with AES-256-GCM
When Tradify changes its web appgit pull once we have fixed itfixed for you, every tool tested daily
Approvalsyour MCP client asks per callquote and invoice email and Scheduler bookings wait for your OK, switchable per tool
Works withMCP clients on your machine, local scriptsClaude.ai and ChatGPT connectors, n8n, Make, Zapier, any HTTP client
Who may use ityou, for noncommercial useteams, businesses, agencies
Pricefreefree 7-day trial with 2,000 credits, no card; then one-time packs from $29 for 5,000 credits

On the hosted version a successful call uses 10 credits, failed calls are free, and the Cloud Browser uses 50 credits a day while it has an app enabled for agents. Full pricing.

FAQ

Does Tradify have an official API? No. Tradify publishes no API, developer docs or webhooks (checked 11 Oct 2026). It connects to other tools through built-in integrations: QuickBooks, Xero, Sage, Stripe and Google Calendar. Details: cotlet.dev/integrations/tradify-api-mcp-server.

Is there a Tradify MCP server for Claude, ChatGPT or Cursor? Yes, this one runs on your machine: tradify-mcp mcp for Claude Code, Claude Desktop, Cursor and Codex. ChatGPT and Claude.ai connectors need a public HTTPS URL, which the hosted Tradify MCP server gives you.

Can it get my Tradify jobs and invoices into another tool? Yes. python examples/export_jobs.py --status all --out jobs.csv and python examples/overdue_invoices.py --out overdue.csv write CSV, and the REST API serves the same lists as JSON to n8n or any HTTP client.

Why does send_quote stop with app_permission_denied? Tradify blocks quote and invoice email until the login has 2-Step Security. Set it up in Tradify under Settings > Security with a mobile number, then call again. The tool stops before it approves anything, so the quote or invoice stays a draft.

Which Tradify plan do I need? The tools do what your plan lets you do in Tradify. Part invoices from a quote need progress invoicing, which Tradify sells as Pro. On the free Tradify Connect plan only the Scheduler works.

Does it work outside the US? Yes. Tradify runs one web app for every country, and the tools read your company's time zone and tax rates from it.

Why does it need my Chrome? To read your Tradify session without your password and without a 2-Step code. Chrome is used once per sign-in, not for each call.

What happens when Tradify signs me out? Calls fail with auth_expired. With Chrome remote debugging on, the server reads the new session on the next call (click Allow when Chrome asks). Otherwise run tradify-mcp connect again.

Can it run on a VPS or in Docker? Technically yes, with a pasted cookie or a session.json copied from your computer. Tradify then sees your session from a datacenter IP, which looks less like you. For an always-on setup the hosted version keeps your session in your own Cloud Browser on a fixed IP.

Will my Tradify account get banned? Requests carry Chrome's fingerprint and go out one at a time, as you would click. Nobody can promise a platform never acts. Keep to your normal use.

Can I use it for my trade business or for my clients? No. The license allows noncommercial use only, and running your own business counts as business use. For a trade business, a team or client work, use Cotlet or write to [email protected].

Can I use the code for anything I like? No. The source is public, but the license allows noncommercial use only: no business use.

A tool broke or I need another one. Open an issue with the tool name and the error message.

License

PolyForm Noncommercial License 1.0.0. In short:

  • Allowed: noncommercial use: you, for your own personal purposes with your own Tradify account, or a charity, school, public research or government body. Changing the code, and sharing it under the same license.
  • Not allowed: any commercial use, your own business included; client work; selling or offering it, or a service built on it.

[Cotlet]

Maintained by Cotlet (@cotletdev). Tradify is a trademark of its owner. This project is unofficial and not affiliated with, endorsed or sponsored by Tradify.

来源:README.md,提交 4264317

工具

15

create_customer

Create customer

New customer profile, optionally with contact details and a physical address. Creates an active customer with the company's default price group, document theme and tax settings, as the New Customer form does. email may hold several addresses separated by commas; quotes and invoices go there. It reaches no one and stays inside Tradify.

输入参数cityname必填emailphonestatemobileaddresscontactpostal_code

create_invoice_from_quote

Create invoice from quote

Draft invoice from an approved or accepted quote, for all of it or part of it. Creates a draft invoice from a quote, as Create Invoice > From Quote does, linked to the quote and its job. mode entire copies every line; line_items copies the lines at the positions in lines; percentage invoices amount percent of the quote total; fixed_amount invoices amount (with tax); remaining invoices what the quote's earlier invoices did not. A part is one line at the quote's tax rate. Due date follows the customer's or your payment terms. The invoice stays a draft until send_invoice. Needs a plan with progress invoicing (Pro) for the part modes.

输入参数mode必填linesamountquote_id必填

create_job

Create job

New job for a customer. It starts as Unassigned. Creates a job for a customer, as New Job does, and Tradify gives it the next job number. It starts Unassigned; schedule_appointment books staff on it. Contact, phone and site address default to the customer's. It reaches no one and stays inside Tradify.

输入参数contactreferencecustomer_id必填description必填site_addresscontact_phone

create_quote

Create quote

Draft quote with line items. Nothing is sent until you call send_quote. Creates a draft quote for a customer, as New Quote does. Each line is misc (description, quantity, unit_price) or time (hours at a billing rate; the price comes from the customer's price group unless unit_price is given). Tax uses the default rate, or tax_rate by name; amounts, tax and totals are worked out as Tradify does. job_id links it to a job of the same customer. Expiry defaults to your expiry days setting. Price list items and kits are not supported yet. The quote stays a draft until send_quote.

输入参数job_idreferenceline_items必填customer_id必填descriptionexpiry_datetax_inclusive

get_job

Get job

Full job: description, site, tasks, notes, appointments, costs, linked quotes and invoices. Returns one job: customer, contact, site address, status, reference and description, the staff on it, its tasks and notes, the Scheduler appointments (times with the company's UTC offset), the costs logged on it (products and misc costs) and the quotes and invoices linked to it. Read it before changing a job.

输入参数job_id必填

list_appointments

List appointments

Scheduler appointments in a date range, with staff, job, times and notes. Returns the Scheduler's job appointments that fall between from and to (both days included, at most 31 days), each with its job, customer, staff member, start and end (ISO 8601 with the company's UTC offset), notes and status (accepted, unconfirmed, declined, cancelled). staff keeps only those people, by full name.

输入参数to必填from必填staff

list_customers

List customers

Customer profiles with contact details and sites. Lists customers by name with contact, email (may be a comma list), phone, mobile, physical address and sites. search matches name, contact, email or phone, so use it to find the customer_id before creating a job or quote. archived lists archived customers instead. Pass next_cursor back as cursor.

输入参数limitcursorsearcharchived

list_invoices

List invoices

Invoices with customer, job, due date, total, amount paid and amount due. Lists invoices, newest first, with customer, jobs, invoice and due dates, total, paid and due (total minus payments and credits). status approved (default) is every approved invoice not fully paid; overdue is the ones past their due date; paid, draft, cancelled and all as named. customer_id lists that customer's invoices, and status then filters the page you get. Pass next_cursor back as cursor.

输入参数limitcursorsearchstatuscustomer_id

list_jobs

List jobs

Jobs with number, customer, site address, status and assigned staff. Lists jobs, newest number first. By default only active jobs (every status marked active, built-in or custom); status all, a built-in status or the name of a custom status narrows it. customer_id lists that customer's jobs, and status then filters the page you get. Pass next_cursor back as cursor.

输入参数limitcursorsearchstatuscustomer_id

list_quotes

List quotes

Quotes with customer, total, quote date, expiry date and status. Lists quotes, newest quote date first, with customer, linked job, total (with tax), quote, expiry and accepted dates and status. By default the quotes awaiting acceptance; expired is the ones awaiting acceptance past their expiry date. since keeps quotes dated on or after that day, so use status accepted with since to find what was won in a period. Pass next_cursor back as cursor.

输入参数limitsincecursorsearchstatus

record_payment

Record payment

Record a payment received against an invoice and reduce the amount due. Adds a payment you already received to an approved invoice, as Add Payment does: amount, date, method (by name, from Settings > Payment Methods) and a reference. It charges nobody and emails nobody. The amount cannot exceed what is due; paying it all marks the invoice paid. If an accounting app is connected, Tradify syncs the payment to it.

输入参数dateamount必填methodreferenceinvoice_id必填

schedule_appointment

Schedule appointment

Book a job appointment on the Scheduler for staff, optionally emailing the customer a confirmation. Books the job on the Scheduler from start to end for each staff member named (by full name; default the signed-in user), as the Scheduler does. Each staff member gets Tradify's "You've been scheduled" notice, and an Unassigned or Assigned job becomes Scheduled. email_customer also sends the customer the appointment confirmation email, with customer_message in it.

输入参数end必填notesstaffstart必填job_id必填email_customercustomer_message

send_invoice

Send invoice

Approve the invoice and email it to the customer, with payment reminders if enabled. Approves a draft invoice (Tradify gives it its number) and emails it from Tradify with the link to view and pay it; payment reminders follow if you enabled them. Without to it goes to the customer's email. Subject and text default to your invoice email template. An approved invoice can be sent again. Tradify sends this mail only when the login has 2-Step Security set up; otherwise the call stops before approving.

输入参数tomessagesubjectinvoice_id必填send_me_a_copy

send_quote

Send quote

Approve the quote and email it to the customer with a link to accept or decline online. Approves a draft quote (it becomes awaiting acceptance) and emails it from Tradify with the link where the customer accepts or declines it online. Without to it goes to the customer's email. Subject and text default to your quote email template. An approved quote can be sent again. Tradify sends this mail only when the login has 2-Step Security set up; otherwise the call stops before approving.

输入参数tomessagesubjectquote_id必填send_me_a_copy

update_job_status

Update job status

Set a status on a job, built-in or one of your custom statuses. Sets a job's status, as Change Status on the Jobs list does: to_invoice, on_hold, complete, cancelled, the others of the built-in list, or the name of a custom status from Settings > Jobs > Job Statuses (spaces as underscores). It reaches no one, and one more call sets it back.

输入参数job_id必填status必填

版本历史

3
  1. v1.0.2最新Oct 25, 2026
  2. v1.0.1Oct 24, 2026
  3. v1.0.0Oct 23, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通必需25 分
  • 已声明认证方式必需10 分
  • 已列出工具15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分

    请在仓库或注册中心条目中声明许可证。

其他 Cotlet 集成