Tools - OnboardMe

Each tool calls one or more Partner API endpoints. Read tools are available on every connection. Write tools need a write grant or an API client with canWrite. See Authentication and permissions.

How the tools work

Find before you change. Clients, leads, users, onboardings and proposals are addressed by GUID keys. The assistant finds them with a search_* tool first and never guesses a key.
Settings come from the practice. Status, source, entity type and role names come from list_settings.
Edits change only what you send. Update tools change only the fields or lines you supply. Replace tools remove anything you leave out.
Files return metadata. PDF and zip tools return the file name, type and size, not the file contents.
Destructive tools are marked. Tools that create users or bills, run paid checks, renew proposals or manage webhooks carry a destructive hint, so clients can ask before running them.

Practice and settings

Tool	Type	What it does
`auth_validate`	Read	Check the connection, practice, write access and scope
`get_practice`	Read	Practice details
`get_practice_subscription`	Read	Practice subscription
`list_settings`	Read	Entity types, roles, lead and deal sources and statuses

Clients and contacts

Tool	Type	What it does
`search_clients`	Read	Find clients by name, surname or email
`get_client`	Read	Load a client
`get_client_integrations`	Read	Linked XPM, Karbon, FYI, QuickBooks and FreeAgent IDs
`create_client`	Write	Create a client
`search_contacts`	Read	Find contacts across clients
`list_client_contacts`	Read	Contacts for one client
`get_client_contact`	Read	Load one contact
`create_client_contact`	Write	Add a contact to a client
`update_client_contact`	Write	Update a contact
`search_groups`	Read	Find client groups

Leads and deals

Tool	Type	What it does
`search_leads`	Read	Find leads
`get_lead`	Read	Load a lead
`get_lead_notes`	Read	Notes on a lead
`create_lead`	Write	Create a lead
`add_lead_note`	Write	Add a note to a lead
`convert_lead_to_client`	Write	Turn a lead into an Active client
`search_deals`	Read	Find deals
`get_deal`	Read	Load a deal
`get_deal_notes`	Read	Notes on a deal
`create_deal`	Write	Create a deal
`update_deal`	Write	Update a deal
`add_deal_note`	Write	Add a note to a deal
`delete_deal`	Write	Delete a deal

Onboardings

Tool	Type	What it does
`search_onboardings`	Read	Find onboardings
`get_onboarding`	Read	Load an onboarding
`get_onboarding_section`	Read	Clients, recipients, notes or relationships, with their IDs
`get_onboarding_client`	Read	Load one client on an onboarding
`list_onboarding_documents`	Read	Documents requested and uploaded
`get_onboarding_document_url`	Read	Short-lived download link for one document
`download_onboarding_documents_zip`	Read	Zip of all uploaded documents
`create_onboarding`	Write	Create an onboarding
`update_onboarding_section`	Write	Edit details, clients, recipients or relationships
`update_onboarding_client`	Write	Fill in client details or custom fields
`manage_onboarding_document`	Write	Request, rename, bypass, upload or remove documents
`manage_onboarding_contact`	Write	Add, edit or remove a client contact
`add_onboarding_note`	Write	Add a note
`onboarding_action`	Write	Send, approve, cancel, complete, manage reminders, push to client
`resend_onboardings`	Write	Resend several onboardings

Proposals

Tool	Type	What it does
`search_proposals`	Read	Find proposals, usually by client
`get_proposal`	Read	Load a proposal and its sections
`get_proposal_pricing`	Read	Services, invoices, recurring billing and jobs
`get_proposal_pdf`	Read	Proposal PDF
`preview_proposal_renewal`	Read	Signatory choices before renewing
`list_proposal_services`	Read	Active services
`list_proposal_packages`	Read	Packages
`list_proposal_templates`	Read	Proposal templates
`list_proposal_options`	Read	Terms, STP authorities, documents, attachments, cover pages, welcome messages, lengths, currencies, checklist and ethical letter templates
`get_checklist_template`	Read	Load a checklist template
`list_proposal_approvers`	Read	Who can approve for a user
`list_practice_job_options`	Read	XPM, FYI, Karbon and GreatSoft templates, staff and categories
`list_karbon_work_statuses`	Read	Karbon statuses for a work template
`create_proposal`	Write	Create an adhoc proposal
`create_proposal_from_template`	Write	Create a proposal from a template
`duplicate_proposal`	Write	Copy a proposal into a new draft
`renew_proposal`	Write	Renew a proposal
`update_proposal_services`	Write	Change individual service lines
`replace_proposal_services`	Write	Replace all service lines
`update_proposal_section`	Write	Edit details, signatories, billing, jobs, eForm or checklist
`replace_proposal`	Write	Replace a whole proposal
`proposal_action`	Write	Send, approve, cancel, reactivate, mark accepted or completed, reset reminders

eForms

Tool	Type	What it does
`list_eform_templates`	Read	eForm templates
`get_eform_template`	Read	Load a template and its schema
`get_eform_schema_guide`	Read	Field types and rules for schemas
`search_eforms`	Read	Find sent eForms
`get_eform`	Read	Load an eForm with answers
`send_eform`	Write	Send an eForm from a template
`create_eform`	Write	Create from a template, custom schema or stack
`send_eform_draft`	Write	Send a draft eForm
`resend_eform`	Write	Resend the invitation
`cancel_eform`	Write	Cancel an eForm
`create_eform_template`	Write	Create a template
`update_eform_template`	Write	Update a template
`duplicate_eform_template`	Write	Copy a template
`deactivate_eform_template`	Write	Deactivate a template

Identity and AML

Tool	Type	What it does
`get_id_verification_certificate`	Read	Verification certificate PDF
`send_id_verification`	Write	Send an identity verification (optionally with AML)
`create_aml_check`	Write	Run a standalone AML check

Billing

Tool	Type	What it does
`search_bills`	Read	Bills by date range
`get_bill`	Read	Load a bill
`get_bill_pdf`	Read	Bill PDF
`list_bill_payments`	Read	Payments against a bill
`list_bill_ledger_options`	Read	Ledger status, accounts, tax rates, branding themes
`create_bill`	Write	Create an adhoc bill
`search_payments`	Read	Payments by date range
`get_payment`	Read	Load a payment
`list_statements`	Read	Statements for a client
`get_statement`	Read	Load a statement
`get_statement_pdf`	Read	Statement PDF
`get_debtors_ageing`	Read	Ageing as at a date
`list_outstanding_invoices`	Read	Outstanding invoices
`get_debtors_movement`	Read	Opening, billed, paid and closing balance
`search_recurring_billing`	Read	Recurring billing schedules
`get_recurring_billing`	Read	Load a schedule
`list_recurring_billing_runs`	Read	Runs for a schedule

Users

Tool	Type	What it does
`search_users`	Read	Find practice users
`get_user`	Read	Load a user
`create_user`	Write	Add a user
`update_user`	Write	Update a user
`disable_user`	Write	Disable a user

Webhooks

Available on API key connections only.

Tool	Type	What it does
`list_webhooks`	Read	Subscriptions
`list_webhook_events`	Read	Supported event keys
`create_webhook`	Write	Subscribe a URL to an event
`test_webhook`	Write	Send a test delivery
`delete_webhook`	Write	Unsubscribe

​How the tools work

​Practice and settings

​Clients and contacts

​Leads and deals

​Onboardings

​Proposals

​eForms

​Identity and AML

​Billing

​Users

​Webhooks