add_client_group_member
ChatGPTAdd an existing client to a client group. A client can belong to only one group, so adding one that already belongs to another group MOVES it — the source group loses the member, and loses its Primary Client too if the moved client held that role. Moving therefore needs client_group.remove_member as well as client_group.add_member. Check get_client for a client_group before calling if that matters.
add_contact
ChatGPTAdd a new contact to an existing client
add_proposal_option
ChatGPTAdd a new option to a draft proposal so the client can choose between alternatives. The new option starts with one empty project; add service groups and proposed services to it afterwards. Requires the proposalOptions plan feature.
add_proposal_project
ChatGPTAdd a project to an option on a draft proposal. Projects group service groups under a heading. The new project is appended after existing projects in the option.
add_proposal_service_group
ChatGPTAdd a billing rule (service group) to a project on a draft proposal. Describe how it bills with billing_mode plus one or more billing_schedules, using the same vocabulary as create_proposal (bill_type, start_type, start_delay, bill_recurring_rule). The group starts with no services; pass the returned created.slug to add_proposed_service. For deposit or milestone billing use create_proposal.
add_proposal_workflow
ChatGPTAdd a workflow to an editable proposal, so accepting it creates a job from the given workflow templates in the connected workflow app, such as XPM or Karbon. An unknown template slug is refused with available_templates, the app's templates as slug and name, so an agent that does not know the slugs can make one call to get the list and choose from it. The workflow is named after its first template unless name is given, and takes its partner and manager from the client. On a proposal that bills more than one client, pass bill_to_client_slug; a call without it is refused with the clients to choose from. By default the job starts on acceptance and runs 12 months; pass end_date with a fixed start_date to end it on a set date such as the client's financial year end, or duration otherwise. Use get_proposal_workflows to see the workflows already on the proposal.
add_proposed_service
ChatGPTAdd an existing service-library service to a service group on a draft proposal with default pricing.
archive_client
ChatGPTArchive a client that has no active engagements or agreed services
archive_invoice
ChatGPTArchive (delete) an invoice so it no longer appears in standard lists. Only voided invoices can be archived — an issued invoice must be voided first to preserve the audit trail. Invoices with any payment (paid, or a non-cancelled payment in progress) cannot be archived.
archive_proposal
ChatGPTArchive a proposal. Only draft and lost proposals can be archived. Proposals in other states (awaiting_acceptance, accepted, completed) cannot be archived.
assign_service_category
ChatGPTSet or clear the category of a service in the practice's service library. Provide exactly one of category_slug or category_name. Assigning a category to a new (draft) service also makes it active
check_client_group_member_removal
ChatGPTCheck whether a client can be removed from its group before calling remove_client_group_member. Reports what blocks the removal outright (the Primary Client, or a draft group proposal that routes services to this member), what only warns (sent proposals referencing the member, which force can override), and whether the member still has active services or unarchived invoices. Read-only — it changes nothing.
create_client
ChatGPTCreate a new client with contacts, optional addresses, and optional tags
create_client_group
ChatGPTCreate a client group from existing clients, so a group proposal can be built against it. Supply the Primary Client — it is the group's billing anchor and default signatory source, and a group that has members must have one. The Primary must already have a default contact, so create its clients with a contact first. Every member client must already exist; this tool does not create clients.
create_email_template
ChatGPTCreate a new email template. Only type new_proposal is supported (additional templates for new proposal notifications). Content is HTML that may include Liquid placeholders (e.g. {{ client.name }}, {{ practice.name }}). Use list_terms_placeholders to discover available placeholders.
create_form_using_template
ChatGPTCreate a new form for a client using a form template
create_invoice_draft
ChatGPTCreate 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_invoice_draft_from_wip
ChatGPTCreate a safe internal invoice draft that bills work in progress entries, for review in the Ignition invoice editor. Each line bills its entries at their open work in progress amount, one line per service. When a service's work is covered by a scheduled billing item, the draft links it, so issuing the invoice marks that item billed instead of billing it twice. It refuses work whose scheduled billing isn't due yet, which that billing will invoice. If several billing items match a service, pass the one to use in billing_item_slugs. Draft covered and uncovered services separately. This does not create, issue, send, number, or collect payment for a real invoice. The user must open the returned app_path and click Create in Ignition.
create_message_template
ChatGPTCreate an intro or next steps message template. Content is HTML with optional Liquid placeholders using the same message placeholders as the UI.
create_proposal
ChatGPTCreate 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_proposal_using_template
ChatGPTCreate 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_service
ChatGPTCreate a new service in the practice's service library
create_terms_template
ChatGPTCreate 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.
end_agreed_service
ChatGPTEnd an agreed service on a client. An enabled service is ended now and stops billing; an upcoming service that has not started yet is cancelled. If a renewal or change order has already queued an upcoming service to replace this one, that second service is cancelled too unless you pass cancel_upcoming_replacement false. A service that is already disabled or cancelled is rejected rather than ended again. The service is recorded as "ended", never as "replaced by" another proposal — MCP cannot link a replacement after the fact, so consolidating engagements onto a new proposal leaves the old services ended. Find candidates with list_agreed_services filtered to state enabled for services that have started, or state upcoming for ones that have not.
get_billing_item
ChatGPTGet 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_change_order
ChatGPTGet a change order by slug (co_*) with its line-level changes to the accepted proposal: changes.added_services, changes.cancelled_services, and changes.updated_services whose fields map each changed field (including price_rule, quantity_rule and discount_rule) to its before and after value. Also returns added projects, service group billing changes, signatory changes and the added, edited and cancelled service counts. Price rules are the stored rules with integer cents in the proposal currency, not computed totals. app_path opens the parent proposal.
get_client
ChatGPTGet full client detail including contacts, services summary, and invoices summary
get_client_group
ChatGPTGet full client group detail including members, the Primary Client, tags, and whether the group can be the subject of a multi-entity proposal. Archived groups are returned.
get_client_nps_summary
ChatGPTRoll-up Client NPS metrics for the practice: average score (0-10), traditional NPS (-100 to 100, % promoters minus % detractors), and the number of submitted responses.
get_form
ChatGPTGet full detail for a single form including questions, responses, client, and form template
get_invoice
ChatGPTGet 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_payment
ChatGPTGet full payment detail by slug, including client, linked invoices, payment method, and the latest collection, disbursal, refund, and dispute where present.
get_practice_info
ChatGPTGet practice info including name, country, currency, timezone, and active client count
get_proposal
ChatGPTGet 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_proposal_document
ChatGPTGet a proposal's full document tree, including options, projects, service groups, schedules, services, and pricing.
get_proposal_summary
ChatGPTCount and total proposal value in one call, over the same filter as list_proposals (e.g. accepted_at on_or_after a date with state accepted or completed). Returns one row per currency and group with proposal_count, valued_count, total_cents, mean_cents and median_cents of minimum_contract_value_cents (tax-exclusive; accepted option once accepted or completed, otherwise cheapest option). Mean and median cover valued proposals only. group_by partner (the client's assigned partner; null when unassigned, inactive or support), sender_user, accepted_month or created_month (practice-local months); omit it for a single total per currency. Reads at most 20000 matching proposals; narrow the filter (e.g. by accepted_at) beyond that.
get_proposal_workflows
ChatGPTGet the workflow (job deployment) configuration for a proposal. Returns the per-app workflow_settings — deploy_strategy is automatic or manual — and the workflows that become jobs in the connected workflow app when the proposal is accepted. A proposal with no workflows creates no jobs at all. Accepts a proposal slug (prop_*) or reference number (PROP-####). Use update_proposal_workflow_settings to stop jobs deploying automatically, or remove_proposal_workflow to drop a workflow entirely.
get_service
ChatGPTGet full detail for a single service including price, tax rate, and billing mode
get_tax_rate
ChatGPTGet full detail for a single tax rate
get_terms_template
ChatGPTGet full detail for a single terms template including its raw content with Liquid placeholders
get_user
ChatGPTGet a single active user in the practice by slug. Useful for resolving a client's partner or manager (both are users)
get_wip_performance
ChatGPTWhat happened to work in progress during a reporting period: opening balance, source movements, work cleared onto Ignition invoices, releases, holds and closing balance, for the whole period and per calendar month. Period dates are the movement history's own dates, unrelated to the work-date filters the other WIP tools apply, and ownership is the Manager and Partner captured on each movement rather than the client's current ones. The period is inclusive and can span at most 12 months. Time-based basis only: figures cover work that bills through WIP in the practice billing currency, and exclude work a fixed fee covers, work whose commercial evidence is ambiguous, and work the source sent in another currency. clearance_percentage is null rather than zero whenever coverage.complete is false or no WIP was available to clear — an unknown is never reported as a zero.
get_wip_summary
ChatGPTHow much work in progress the practice currently holds, and where it sits. Reports open and held totals, ageing, top contributors and data-quality exceptions from the practice's elected WIP source. Populations differ on purpose and do not reconcile: open_totals and ageing_buckets cover the client/service/month groups whose commercial treatment is actionable now (billable through WIP), while every breakdowns entry is the whole review scope narrowed to the practice billing currency. Breakdowns are the top 10 rows by open value, not an export: read total_available_count for how many rows exist. Work-date filters narrow today's balance; they never produce an "as at" historical balance — use get_wip_performance for what moved during a period. Ownership is the client's current Manager and Partner. Ageing buckets are calendar buckets (current month, one to two months, three months or more), not 30/60/90-day buckets. Omitting both work-date filters applies a rolling one-year window, which list_wip_entries does not. Work dated before the practice's WIP start date is never included, and work_date_on_or_after reports that date when it is the later bound. exception_counts always reports stale_source with a null count: staleness needs a threshold no tool here accepts, so it is unavailable rather than zero. A breakdown row whose id is null is work with no client, no service or no owner of that kind; it cannot be sent back as a filter.
increase_proposal_prices
ChatGPTApply 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
ChatGPTList 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_ai_changes
ChatGPTList service and template edits AI assistants made through this server in the last 90 days, newest first, with each edited field's value before and after. Filter undone_at is_empty for changes that can still be undone. Pass a change slug to undo_ai_changes to put the before values back.
list_billing_items
ChatGPTList 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_change_orders
ChatGPTList change orders to accepted proposals using structured filters and optional total counts. Returns issued change orders (sent, accepted, declined, expired, or voided after sending); unsent drafts and change orders voided before they were sent are excluded unless include_drafts is true. Use accepted_at or sent_at date filters to find change orders accepted or issued since a point in time. Each row counts the services added, edited and cancelled; use get_change_order for the line-level changes. Use list_proposals with accepted_at and is_renewal for newly accepted proposals and renewals. app_path opens the parent proposal.
list_client_group_members
ChatGPTList the clients that belong to a client group, cursor-paginated and ordered by default by name. get_client_group embeds only a bounded preview of members and sets members_truncated when there are more — use this tool for the rest, and for any group large enough that the whole membership should not arrive in one response. Archived members are included; is_primary marks the group's Primary Client.
list_client_groups
ChatGPTList client groups using structured filters. Archived groups require include_archived: true. Filter multi_entity_eligible to true to exclude legacy import buckets.
list_client_nps_responses
ChatGPTList submitted Client NPS responses using structured date, score, bucket, client and comment filters. Archived or removed clients are excluded, so totals may differ from get_client_nps_summary.
list_clients
ChatGPTList clients for the practice, with optional filters by state, tag, partner, or name (case-insensitive partial match)
list_custom_field_definitions
ChatGPTList the practice's client custom fields. Use each field's id as definition_id in update_client custom_fields; a select field takes one of its non-archived option ids as the value, a boolean field takes "true" or "false".
list_email_templates
ChatGPTList 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
ChatGPTList form templates for the practice with cursor pagination
list_forms
ChatGPTList forms for the practice, with optional filters by state, client, or form template
list_invoices
ChatGPTList 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
ChatGPTList 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
ChatGPTList 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_proposal_templates
ChatGPTList the practice's proposal templates with cursor pagination
list_proposals
ChatGPTList proposals for the practice, with optional filters by state, client, or reference number (PROP-####)
list_service_categories
ChatGPTList service library category names and slugs for the practice, including categories with no services. Use a category slug with the category_slug filter on list_services. Uncategorized services have no category.
list_services
ChatGPTList services in the practice's service library
list_tax_rates
ChatGPTList tax rates available in the practice
list_terms_placeholders
ChatGPTList 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
ChatGPTList terms templates for the practice. These are reusable engagement letter / terms of service documents applied to proposals.
list_users
ChatGPTList 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
list_wip_entries
ChatGPTThe individual work in progress entries behind the practice's current Billing Review balance, newest work date first. Each row is open, unbilled work from the elected WIP source that is not already on a live Ignition invoice. This is the current review population, not all historical time and not a guaranteed decomposition of get_wip_summary's headline: the summary's headline totals cover only the groups whose commercial treatment is actionable, while these rows include work a fixed fee covers or whose evidence needs review — read billing_treatment per row. Ownership filters use the client's current Manager and Partner. A deleted client's work is still reviewable, so its rows remain but resolve no client_name. Work dated before the practice's WIP start date, when one is set in WIP settings, is never listed. Beyond that, omitting both work-date filters bounds the work date not at all, where get_wip_summary would default to a rolling one-year window.
list_xero_tracking_categories
ChatGPTList the Xero tracking categories Ignition uses for the connected Xero organisation (at most two), each with its options. Category and option ids match the xero_tracking entries on clients, services and agreed services, and the xero_tracking_category_id filter on list_clients. Returns connected: false and no categories when Xero is disconnected. On invoices each category takes the first option set on the agreed service, then the library service, then the client.
move_proposal_to_draft
ChatGPTMove a proposal back to draft so it can be edited. Only awaiting acceptance and lost proposals can be moved to draft; accepted, completed and archived proposals cannot. The client's link is revoked, so the client can no longer accept the proposal until it is sent again. After editing, use send_proposal_to_client to return it to awaiting acceptance.
remove_client_group_member
ChatGPTRemove a client from a client group. The client itself is not archived or deleted — it just stops being a member. Two things block removal outright and force does not override either: the group's Primary Client, and a member a draft group proposal routes services to. A member referenced by an already-sent proposal only warns, and force: true proceeds past that. Call check_client_group_member_removal first to see which case applies.
remove_proposal_option
ChatGPTRemove 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_proposal_project
ChatGPTRemove 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_proposal_service_group
ChatGPTRemove a billing rule (service group) and its proposed services from a draft proposal.
remove_proposal_workflow
ChatGPTRemove one workflow from an editable proposal, so accepting it no longer creates that job in the connected workflow app. This is how a renewal is set up to keep the job the original proposal already created instead of deploying a new one; a renewal copies the source proposal's workflows, so remove each one returned by get_proposal_workflows. Removal cannot be undone through MCP — the workflows have to be rebuilt in the proposal editor. Use update_proposal_workflow_settings instead to keep the workflows but stop them deploying automatically.
remove_proposed_service
ChatGPTRemove a proposed service line item from a draft proposal.
renew_proposal
ChatGPTCreate a new draft proposal by renewing an accepted or completed proposal. Copies all services from the accepted option at their current agreed service prices, sets the start date to the day after the source contract ends, and preserves signatories. The result is a draft proposal that can be reviewed with get_proposal, adjusted with update_proposal, and sent with send_proposal_to_client.
restore_client
ChatGPTRestore (unarchive) a previously archived client
send_client_nps_survey
ChatGPTSend a Client NPS feedback survey email to a client's default contact. The client must be active (not archived) and have a default contact email. Each call sends a fresh request, so an agent should confirm intent with the user before calling it.
send_client_nps_survey_bulk
ChatGPTRequest Client NPS feedback from several clients at once, sending each email in the background. Provide the explicit client slugs to contact (max 100); archived or email-less clients are skipped per client. Returns an async job group summarising how many requests were queued. Confirm intent with the user before calling — this emails multiple clients.
send_form_to_client
ChatGPTSend an awaiting form to its client via email
send_invoice_to_client
ChatGPTSend an invoice email to the client. Only issued invoices can be sent. When to is omitted, the invoice is sent to the client's usual invoice recipients. Each call triggers a fresh delivery.
send_proposal_to_client
ChatGPTSend a draft proposal to the client. Moves the proposal to awaiting acceptance and sends the notification email. Only draft proposals can be sent.
undo_ai_changes
ChatGPTPut back the values a service or template had before an AI assistant edited it. Pass change_slug (from list_ai_changes) to undo one change, or since_minutes to undo every edit your own assistant made in that many recent minutes (at most 1440, and at most 100 changes at once). Undo changes nothing and returns error conflict when a field was edited again since; the conflicts name each change and field.
update_client
ChatGPTUpdate an existing client's details or add/remove tags (partial update — only provided fields are changed)
update_client_group
ChatGPTUpdate a client group's name, notes, Primary Client, or membership. PATCH semantics: omitted fields are left alone. Reassigning the Primary is how a different member becomes the group's billing anchor and default signatory source — the outgoing Primary stays a member if the incoming one was already in the group, and is removed from the group if it was not. Changing the Primary or the member list needs client_group.add_member and client_group.remove_member as well as client_group.edit.
update_contact
ChatGPTUpdate an existing contact on a client (partial update — only provided fields are changed)
update_email_template
ChatGPTUpdate an existing email template. Uses PATCH semantics — only provided fields are changed. The template kind is inferred from the slug (practice-scoped PracticeTemplate row). Slugs share the practempl_ prefix across all template kinds. Content is HTML that may include Liquid placeholders. Use list_terms_placeholders to discover available placeholders.
update_message_template
ChatGPTUpdate an existing message template. Uses PATCH semantics — only provided fields are changed. Content is HTML with optional Liquid placeholders. Use list_terms_placeholders to discover available placeholders.
update_proposal
ChatGPTUpdate top-level settings on a draft proposal. Only provided fields are changed (PATCH semantics). For personalised_message and next_steps_message, check list_message_templates for existing content first. Payment settings are atomic: provide payment_method_required, credit_card_accepted, and direct_debit_accepted together or omit all three. Send brochure_slug: null to remove an attached brochure.
update_proposal_project
ChatGPTUpdate a project's name and/or description on a draft proposal (PATCH semantics; only provided fields change).
update_proposal_workflow_settings
ChatGPTSet whether an editable proposal's workflows deploy jobs to the connected workflow app automatically on acceptance. automatic (the default for a new proposal, and what a renewal inherits from the proposal it renews) creates the jobs on acceptance; manual still creates the workflows in Ignition but leaves them undeployed until someone deploys them from the client's Workflow tab. To create no job at all — the usual intent on a renewal that should keep the existing job — remove the workflows with remove_proposal_workflow instead. Call get_proposal_workflows first to see the current setting.
update_proposed_service
ChatGPTPatch a proposed service on a draft proposal, including text, pricing, quantity, tax, and add-on status.
update_proposed_service_portion
ChatGPTPatch a proposed service billing portion on a draft proposal. Supports fixed price amount and invoice strategy.
update_service
ChatGPTUpdate an existing service in the practice's service library
update_terms_template
ChatGPTUpdate an existing terms template. Uses PATCH semantics — only provided fields are changed. Content is HTML that may include Liquid placeholders. Use list_terms_placeholders to discover available placeholders.
validate_proposal_document
ChatGPTValidate a create_proposal document without saving it. Returns field errors and pricing summary when buildable.
void_invoice
ChatGPTVoid an issued invoice. Only invoices without any paid or in-progress payments can be voided. Once voided, the invoice cannot be paid but is retained for audit trail. Use archive_invoice if you want to hide the invoice from lists after voiding.