Ignition

Create a new form for a client using a form template

Create a safe internal invoice draft for review in the Ignition invoice editor. This does not create, issue, send, deploy, number, or collect payment for a real invoice. The user must open the returned app_path and click Create in Ignition.

Create an intro or next steps message template. Content is HTML with optional Liquid placeholders using the same message placeholders as the UI.

Create a new draft proposal from a full proposal document (options, projects, service groups, billing schedules, proposed services, deposits, recipients, and signable documents). Prefer create_proposal_using_template when an existing template covers the requested proposal; reach for this tool when the agent needs full control over the proposal structure. Document shape mirrors the proposal template encoder format with slug-only identifiers.

Create a new draft proposal from a proposal template. The template defines services, options, billing, and default settings. You can override top-level settings via optional arguments. For personalised_message and next_steps_message, first check list_message_templates for an appropriate existing template to use as content. If none is suitable, craft a custom HTML message.

Create a new service in the practice's service library

Create a new terms template. Content is HTML that may include Liquid placeholders (e.g. {{ client.name }}, {{ practice.name }}). Use list_terms_placeholders to discover available placeholders.

Get full billing item detail by slug, including client embed, service, billable service, billing group, payment method, tax, and the invoice it was billed onto when applicable.

Get full client detail including contacts, services summary, and invoices summary

Get full detail for a single form including questions, responses, client, and form template

Get full invoice detail by identifier, including line items, money totals, client embed, issued_by user, latest payment (with collection and disbursal), latest ledger deployment, latest reconciliation, and days_overdue. Accepts an invoice slug (inv_*), Ignition reference number (INV-####), or the ledger invoice number from Xero/QuickBooks (stored as deployment.external_number).

Get full payment detail by slug, including client, linked invoices, payment method, and the latest collection, disbursal, refund, and dispute where present.

Get practice info including name, country, currency, timezone, and active client count

Get top-level proposal metadata and settings by identifier. Accepts a proposal slug (prop_*) or user-facing reference number (PROP-####). Use get_proposal_document for service lines and pricing.

Get a proposal's full document tree, including options, projects, service groups, schedules, services, and pricing.

Get full detail for a single service including price, tax rate, and billing mode

Get full detail for a single tax rate

Get full detail for a single terms template including its raw content with Liquid placeholders

Get a single active user in the practice by slug. Useful for resolving a client's partner or manager (both are users)

Apply a single bulk percentage increase across every proposed service in a draft proposal, with an optional round-up to the nearest $1, $5, or $10. A price increase can be applied AT MOST ONCE per proposal and ONLY while the proposal is editable (draft). Subsequent calls on the same proposal return { error: "already_applied" }. Set preview: true to see the resulting minimum-contract-value deltas without committing; preview does not count toward the one-shot limit.

List agreed services (engagements) for the practice, with optional filters by state or client. Agreed services are the canonical representation of what the UI calls a client's "services". When a user asks for "active" or "current" services they mean services in state "enabled" — the agreed service state machine has no "active" value. Pass state="enabled" to match the UI's default "Services" view on a client record.

List billing items for the practice with rich filters by date range, status, billing strategy, client, service, billable service, billing group, payment method, and a due_only shortcut for unbilled items due today or earlier. Archived billing items are always excluded; pass `status: "unbilled"` or `"billed"` to narrow further.

List clients for the practice, with optional filters by state, tag, partner, manager, or name (case-insensitive partial match)

List email templates for the practice (new proposal, proposal accepted, and payment-related emails). Optionally filter by template type. Omit type to return all supported email template kinds.

List form templates for the practice with cursor pagination

List forms for the practice, with optional filters by state, client, or form template

List invoices for the practice, with optional filters by payment state, state, client, partner, issued-by user, tag, date ranges (issued/due/paid/created/updated), overdue status, amount range, Ignition reference number (INV-####), ledger invoice number (Xero/QuickBooks), billing reference, source, payment source, and ledger deployment state. Archived, voided, and deleted invoices are excluded by default; pass `state: "archived"` or `state: "voided"` to include them.

List message templates for the practice. These are the intro and next steps messages shown to clients during the proposal flow. Optionally filter by type.

List payments for the practice with rich filtering on client, invoice, state, date ranges, payment method type, and amount. Cancelled payments are excluded by default; pass state explicitly to include them.

List the practice's proposal templates with cursor pagination

List proposals for the practice, with optional filters by state, client, or reference number (PROP-####)

List services in the practice's service library

List tax rates available in the practice

List available Liquid placeholders for use in terms template content and service terms fields. Returns placeholder paths (e.g. client.name), descriptions, and sample values. Use {{ path }} syntax in content.

List terms templates for the practice. These are reusable engagement letter / terms of service documents applied to proposals.

List active users in the practice, with optional filters by email (exact match) or name (case-insensitive partial match). Use this to resolve a user slug from an email so clients can be filtered by their partner or manager

Remove an option from a draft proposal. A proposal must keep at least one option, so removing the last option is rejected. Not gated on the proposalOptions feature, so a downgraded plan can still reduce a multi-option proposal back to a single option.

Remove a project from a draft proposal. An option must keep at least one project, so removing the last project in an option is rejected.

Remove a billing rule (service group) and its proposed services from a draft proposal.

Remove a proposed service line item from a draft proposal.