Ignition

App · 26 actions

Work with your Ignition practice: manage clients and their contacts, keep your service library, create draft proposals, and read agreed services, invoices and payments. Start a workflow when a client or proposal is added.

Actions

ActionWhat it does
Add contactAdd a contact to a client.
Archive clientArchive a client so it leaves the active lists.
Archive proposalArchive a lost proposal so it leaves your lists.
Create clientAdd a client with its primary contact.
Create proposalCreate a draft proposal for a client with one service from your library, billed once or every month.
Create serviceAdd a service to the practice's service library, to put on proposals.
Delete contactDelete a contact.
Get clientGet one client with its details, contacts and tags.
Get contactGet one contact.
Get practiceGet the Ignition practice the connection belongs to: its slug and name.
Get proposalGet one proposal with its state, client and values.
Get serviceGet one service with its price and tax rate.
List agreed servicesList the services clients agreed to by accepting proposals, optionally by client, proposal or state.
List clientsList the practice's clients, newest first, optionally narrowed by name, state or your own external id.
List contactsList a client's contacts with their emails and phone numbers.
List invoicesList invoices, newest first, optionally by client, state or whether they are paid.
List paymentsList payments collected through Ignition, newest first.
List proposalsList proposals, newest first, optionally by state or client.
List servicesList the services in the practice's service library with their prices and tax rates.
List tax ratesList the tax rates set up in the practice.
Mark proposal lostMark a draft or awaiting-acceptance proposal as lost.
Restore clientBring an archived client back.
Update clientChange a client's name or details.
Update contactChange a contact's name or details.
Update proposalChange a draft proposal's name, messages or contract length.
Update serviceChange a library service's name, price, tax rate or text.

Add contact

Add a contact to a client.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.
NamenametextRequired
The contact's full name.
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number.
Mobilemobiletext
The contact's mobile number.
Primary contactis_primarytrue/false
Make this the client's primary contact, who receives proposals.Default: false.
Receives invoice emailsreceives_invoice_emailstrue/false
Send this contact the client's invoice emails.Default: false.
External IDexternal_idtext
Your own identifier for the contact, to match it with another system.

Outputs

contactobject
The contact added
Example output
{
  "contact": {
    "email": "jo@acme.example",
    "external_id": "crm-4821",
    "is_primary": true,
    "mobile": "",
    "name": "Jo Fernandez",
    "object": "contact",
    "phone": "(555) 555-0100",
    "receives_invoice_emails": true,
    "slug": "con_example0001"
  }
}

Archive client

Archive a client so it leaves the active lists. It can be restored.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.

Outputs

clientobject
The client, now archived
Example output
{
  "client": {
    "address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "business_structure": "Sole Trader",
    "company_number": "12345",
    "contacts": [
      {
        "email": "jo@acme.example",
        "external_id": "crm-4821",
        "is_primary": true,
        "mobile": "",
        "name": "Jo Fernandez",
        "object": "contact",
        "phone": "(555) 555-0100",
        "receives_invoice_emails": true,
        "slug": "con_example0001"
      }
    ],
    "created_at": "2026-11-13T18:28:24Z",
    "external_id": "crm-4821",
    "manager": {
      "name": "Alex Manager",
      "slug": "user_example0002"
    },
    "name": "Acme Pty Ltd",
    "notes": "",
    "object": "client",
    "partner": {
      "name": "Sam Partner",
      "slug": "user_example0001"
    },
    "phone": "(555) 555-0100",
    "postal_address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "reference": "CLI-0001",
    "slug": "cli_example0001",
    "state": "archived",
    "tags": [],
    "tax_number": "",
    "updated_at": "2026-11-13T18:28:24Z",
    "website": "https://acme.example"
  }
}

Archive proposal

Archive a lost proposal so it leaves your lists.

Inputs

Proposalproposal_slugtextRequired
The proposal. Pick one, or give its slug from an earlier step.

Outputs

proposalobject
The proposal, now archived
Example output
{
  "proposal": {
    "auto_expire_days": 0,
    "auto_expiring": false,
    "client_name": "Acme Pty Ltd",
    "client_slug": "cli_example0001",
    "contract_term": "fixed",
    "created_at": "2026-11-13T19:06:02Z",
    "currency": "USD",
    "email_template_slug": "practempl_example0001",
    "is_renewal": false,
    "minimum_contract_length": 12,
    "monthly_recurring_value_cents": 15000,
    "name": "Annual bookkeeping",
    "next_steps_message": "",
    "object": "proposal",
    "one_time_date_display": "hide",
    "personalised_message": "",
    "proposal_value_display": "hide",
    "reference_number": "PROP-0001",
    "sender_type": "practice",
    "sender_user_slug": "",
    "service_price_display": "hide",
    "slug": "prop_example0001",
    "start_date": "",
    "start_on": "acceptance",
    "state": "archived",
    "terms_template_slug": "practempl_example0002",
    "total_non_recurring_value_cents": 0,
    "total_recurring_value_cents": 180000,
    "updated_at": "2026-11-13T19:06:02Z"
  }
}

Create client

Add a client with its primary contact. If you give an external id and a client already has it, that client is updated instead.

Inputs

Client namenametextRequired
The client's name.
Primary contact namecontact_nametextRequired
The person at the client Ignition sends proposals and invoices to.
Primary contact emailcontact_emailtext
The primary contact's email address.
Primary contact phonecontact_phonetext
The primary contact's phone number.
Primary contact mobilecontact_mobiletext
The primary contact's mobile number.
Phonephonetext
The client's phone number.
Websitewebsitetext
The client's website.
Tax numbertax_numbertext
The client's tax or VAT number.
Company numbercompany_numbertext
The client's company registration number.
Business structurebusiness_structuretext
How the client is set up, such as Sole Trader, Company or Partnership.
Notesnotestext
Notes about the client.
External IDexternal_idtext
Your own identifier for the client, to match it with another system.
Street addressaddress_line1text
The first line of the street address.
Cityaddress_citytext
The city or town of the address.
State or regionaddress_regiontext
The state, province or region.
Postal codeaddress_postal_codetext
The postal or ZIP code.
Countryaddress_countrytext
The country of the address.

Outputs

clientobject
The client created or updated
Example output
{
  "client": {
    "address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "business_structure": "Sole Trader",
    "company_number": "12345",
    "contacts": [
      {
        "email": "jo@acme.example",
        "external_id": "crm-4821",
        "is_primary": true,
        "mobile": "",
        "name": "Jo Fernandez",
        "object": "contact",
        "phone": "(555) 555-0100",
        "receives_invoice_emails": true,
        "slug": "con_example0001"
      }
    ],
    "created_at": "2026-11-13T18:28:24Z",
    "external_id": "crm-4821",
    "manager": {
      "name": "Alex Manager",
      "slug": "user_example0002"
    },
    "name": "Acme Pty Ltd",
    "notes": "",
    "object": "client",
    "partner": {
      "name": "Sam Partner",
      "slug": "user_example0001"
    },
    "phone": "(555) 555-0100",
    "postal_address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "reference": "CLI-0001",
    "slug": "cli_example0001",
    "state": "lead",
    "tags": [],
    "tax_number": "",
    "updated_at": "2026-11-13T18:28:24Z",
    "website": "https://acme.example"
  }
}

Create proposal

Create a draft proposal for a client with one service from your library, billed once or every month. It is not sent: review and send it in Ignition.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.
Proposal namenametextRequired
The proposal's name, shown to the client.
Serviceservice_slugtextRequired
The service from your service library. Pick one, or give its slug.
Billingbillingtext
Bill the service once when the proposal is accepted, or every month. Defaults to once.One of: once_off (Once, when accepted (default)), monthly (Every month). Default: once_off.
Quantityquantitynumber
How many of the service. Defaults to 1.At least 0.
Pricepricenumber
Replace the service's fixed or per-unit price, in your practice's currency. Leave blank to use the library price.At least 0.
Message to the clientpersonalised_messagetext
A personal note shown at the top of the proposal.
Next stepsnext_steps_messagetext
What happens after the client accepts.

Outputs

proposalobject
The draft proposal created
Example output
{
  "proposal": {
    "auto_expire_days": 0,
    "auto_expiring": false,
    "client_name": "Acme Pty Ltd",
    "client_slug": "cli_example0001",
    "contract_term": "fixed",
    "created_at": "2026-11-13T19:06:02Z",
    "currency": "USD",
    "email_template_slug": "practempl_example0001",
    "is_renewal": false,
    "minimum_contract_length": 12,
    "monthly_recurring_value_cents": 15000,
    "name": "Annual bookkeeping",
    "next_steps_message": "",
    "object": "proposal",
    "one_time_date_display": "hide",
    "personalised_message": "",
    "proposal_value_display": "hide",
    "reference_number": "PROP-0001",
    "sender_type": "practice",
    "sender_user_slug": "",
    "service_price_display": "hide",
    "slug": "prop_example0001",
    "start_date": "",
    "start_on": "acceptance",
    "state": "draft",
    "terms_template_slug": "practempl_example0002",
    "total_non_recurring_value_cents": 0,
    "total_recurring_value_cents": 180000,
    "updated_at": "2026-11-13T19:06:02Z"
  }
}

Create service

Add a service to the practice's service library, to put on proposals.

Inputs

Service namenametextRequired
The service's name.
Tax ratetax_rate_slugtextRequired
The tax rate the service is sold at.
Price typeprice_typetext
How the service is priced. Defaults to a fixed price.One of: fixed (Fixed price), unit (Price per unit), minimum (Minimum price), range (Price range), included (Included at no charge). Default: fixed.
Pricepricenumber
The price in your practice's currency, such as 150 for $150. Used by fixed and per-unit prices.At least 0.
Unit nameunit_nametext
What one unit is, such as hour, for a per-unit price.Only when Price type is Price per unit.
Minimum priceminimum_pricenumber
The lowest price for a minimum price or a price range.Only when Price type is Minimum price or Price range. At least 0.
Maximum pricemaximum_pricenumber
The highest price for a price range.Only when Price type is Price range. At least 0.
When it is billedbilling_modetext
When a fixed-price service is billed. Other price types are estimated or included.Only when Price type is Fixed price. One of: upfront (On acceptance), on_completion (On completion), recurring.
Descriptiondescriptiontext
What the service includes, shown to clients.
Termstermstext
Terms specific to this service.

Outputs

serviceobject
The service created
Example output
{
  "service": {
    "active": true,
    "billing_mode": "recurring",
    "billing_mode_label": "Recurring",
    "created_at": "2026-11-13T18:28:40Z",
    "description": "Bookkeeping for your business.",
    "name": "Monthly bookkeeping",
    "object": "service",
    "price": {
      "amount_cents": 15000,
      "currency": "USD",
      "maximum_cents": 0,
      "minimum_cents": 0,
      "object": "price_rule",
      "type": "fixed",
      "unit_name": ""
    },
    "short_description": "",
    "slug": "svc_example0001",
    "tax_rate": {
      "code": "",
      "name": "Exempt",
      "object": "tax_rate",
      "rate": 0.0,
      "slug": "iatax_example0001"
    },
    "terms": "",
    "updated_at": "2026-11-13T18:28:40Z"
  }
}

Delete contact

Delete a contact. A client's primary contact cannot be deleted.

Inputs

Contact slugcontact_slugtextRequired
The contact's slug (it starts with con_), from 'List contacts' or an earlier step.

Outputs

contact_slugtext
The contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact_slug": "con_example0001",
  "deleted": true
}

Get client

Get one client with its details, contacts and tags.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.

Outputs

clientobject
The client
Example output
{
  "client": {
    "address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "business_structure": "Sole Trader",
    "company_number": "12345",
    "contacts": [
      {
        "email": "jo@acme.example",
        "external_id": "crm-4821",
        "is_primary": true,
        "mobile": "",
        "name": "Jo Fernandez",
        "object": "contact",
        "phone": "(555) 555-0100",
        "receives_invoice_emails": true,
        "slug": "con_example0001"
      }
    ],
    "created_at": "2026-11-13T18:28:24Z",
    "external_id": "crm-4821",
    "manager": {
      "name": "Alex Manager",
      "slug": "user_example0002"
    },
    "name": "Acme Pty Ltd",
    "notes": "",
    "object": "client",
    "partner": {
      "name": "Sam Partner",
      "slug": "user_example0001"
    },
    "phone": "(555) 555-0100",
    "postal_address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "reference": "CLI-0001",
    "slug": "cli_example0001",
    "state": "lead",
    "tags": [],
    "tax_number": "",
    "updated_at": "2026-11-13T18:28:24Z",
    "website": "https://acme.example"
  }
}

Get contact

Get one contact.

Inputs

Contact slugcontact_slugtextRequired
The contact's slug (it starts with con_), from 'List contacts' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "email": "jo@acme.example",
    "external_id": "crm-4821",
    "is_primary": true,
    "mobile": "",
    "name": "Jo Fernandez",
    "object": "contact",
    "phone": "(555) 555-0100",
    "receives_invoice_emails": true,
    "slug": "con_example0001"
  }
}

Get practice

Get the Ignition practice the connection belongs to: its slug and name.

Inputs

None.

Outputs

practiceobject
The connected practice
Example output
{
  "practice": {
    "name": "Acme Advisory",
    "object": "practice",
    "slug": "prac_example0001"
  }
}

Get proposal

Get one proposal with its state, client and values.

Inputs

Proposalproposal_slugtextRequired
The proposal. Pick one, or give its slug from an earlier step.

Outputs

proposalobject
The proposal
Example output
{
  "proposal": {
    "auto_expire_days": 0,
    "auto_expiring": false,
    "client_name": "Acme Pty Ltd",
    "client_slug": "cli_example0001",
    "contract_term": "fixed",
    "created_at": "2026-11-13T19:06:02Z",
    "currency": "USD",
    "email_template_slug": "practempl_example0001",
    "is_renewal": false,
    "minimum_contract_length": 12,
    "monthly_recurring_value_cents": 15000,
    "name": "Annual bookkeeping",
    "next_steps_message": "",
    "object": "proposal",
    "one_time_date_display": "hide",
    "personalised_message": "",
    "proposal_value_display": "hide",
    "reference_number": "PROP-0001",
    "sender_type": "practice",
    "sender_user_slug": "",
    "service_price_display": "hide",
    "slug": "prop_example0001",
    "start_date": "",
    "start_on": "acceptance",
    "state": "draft",
    "terms_template_slug": "practempl_example0002",
    "total_non_recurring_value_cents": 0,
    "total_recurring_value_cents": 180000,
    "updated_at": "2026-11-13T19:06:02Z"
  }
}

Get service

Get one service with its price and tax rate.

Inputs

Serviceservice_slugtextRequired
The service from your service library. Pick one, or give its slug.

Outputs

serviceobject
The service
Example output
{
  "service": {
    "active": true,
    "billing_mode": "recurring",
    "billing_mode_label": "Recurring",
    "created_at": "2026-11-13T18:28:40Z",
    "description": "Bookkeeping for your business.",
    "name": "Monthly bookkeeping",
    "object": "service",
    "price": {
      "amount_cents": 15000,
      "currency": "USD",
      "maximum_cents": 0,
      "minimum_cents": 0,
      "object": "price_rule",
      "type": "fixed",
      "unit_name": ""
    },
    "short_description": "",
    "slug": "svc_example0001",
    "tax_rate": {
      "code": "",
      "name": "Exempt",
      "object": "tax_rate",
      "rate": 0.0,
      "slug": "iatax_example0001"
    },
    "terms": "",
    "updated_at": "2026-11-13T18:28:40Z"
  }
}

List agreed services

List the services clients agreed to by accepting proposals, optionally by client, proposal or state.

Inputs

Clientclient_slugtext
Only this client's records. Pick one, or give its slug.
Proposalproposal_slugtext
Only services agreed through this proposal.
Statestatetext
Only agreed services in this state.One of: upcoming, enabled, disabled, cancelled.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

agreed_serviceslist
The agreed services
countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "agreed_services": [
    {
      "billing_name": "Monthly bookkeeping",
      "billing_schedule": "Monthly",
      "client_slug": "cli_example0001",
      "created_at": "2026-11-20T09:00:00Z",
      "expires_on": "",
      "monthly_recurring_value_cents": 15000,
      "name": "Monthly bookkeeping",
      "object": "agreed_service",
      "slug": "agsvc_example0001",
      "starts_on": "2026-12-01",
      "state": "enabled"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List clients

List the practice's clients, newest first, optionally narrowed by name, state or your own external id.

Inputs

Name containsnametext
Only clients whose name contains this text.
Statestatetext
Only clients in this state.One of: lead, active, inactive, archived.
External IDexternal_idtext
Only the client carrying this external id.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

clientslist
The clients
countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "clients": [
    {
      "address": {
        "city": "Exampleville",
        "country": "USA",
        "line1": "100 Example Way",
        "postal_code": "10560",
        "region": "Example State"
      },
      "business_structure": "Sole Trader",
      "company_number": "12345",
      "contacts": [
        {
          "email": "jo@acme.example",
          "external_id": "crm-4821",
          "is_primary": true,
          "mobile": "",
          "name": "Jo Fernandez",
          "object": "contact",
          "phone": "(555) 555-0100",
          "receives_invoice_emails": true,
          "slug": "con_example0001"
        }
      ],
      "created_at": "2026-11-13T18:28:24Z",
      "external_id": "crm-4821",
      "manager": {
        "name": "Alex Manager",
        "slug": "user_example0002"
      },
      "name": "Acme Pty Ltd",
      "notes": "",
      "object": "client",
      "partner": {
        "name": "Sam Partner",
        "slug": "user_example0001"
      },
      "phone": "(555) 555-0100",
      "postal_address": {
        "city": "Exampleville",
        "country": "USA",
        "line1": "100 Example Way",
        "postal_code": "10560",
        "region": "Example State"
      },
      "reference": "CLI-0001",
      "slug": "cli_example0001",
      "state": "lead",
      "tags": [],
      "tax_number": "",
      "updated_at": "2026-11-13T18:28:24Z",
      "website": "https://acme.example"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List contacts

List a client's contacts with their emails and phone numbers.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.

Outputs

contactslist
The client's contacts
countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "contacts": [
    {
      "email": "jo@acme.example",
      "external_id": "crm-4821",
      "is_primary": true,
      "mobile": "",
      "name": "Jo Fernandez",
      "object": "contact",
      "phone": "(555) 555-0100",
      "receives_invoice_emails": true,
      "slug": "con_example0001"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List invoices

List invoices, newest first, optionally by client, state or whether they are paid.

Inputs

Clientclient_slugtext
Only this client's records. Pick one, or give its slug.
Statestatetext
Only invoices in this state.One of: issued, voided, archived.
Paymentpayment_statetext
Only invoices that are unpaid, partly paid or paid.One of: unpaid, partially_paid (Partially paid), paid.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
invoiceslist
The invoices
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "has_more": false,
  "invoices": [
    {
      "amount_cents": 15000,
      "client_slug": "cli_example0001",
      "created_at": "2026-11-20T09:00:00Z",
      "currency": "USD",
      "date": "2026-11-20",
      "due_on": "2026-12-04",
      "number": "INV-0001",
      "object": "invoice",
      "payment_slugs": [],
      "payment_state": "unpaid",
      "slug": "inv_example0001",
      "state": "issued",
      "tax_amount_cents": 0,
      "updated_at": "2026-11-20T09:00:00Z"
    }
  ],
  "next_cursor": ""
}

List payments

List payments collected through Ignition, newest first.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
paymentslist
The payments
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "payments": [
    {
      "amount_cents": 15000,
      "collection_state": "succeeded",
      "created_at": "2026-11-21T09:00:00Z",
      "currency": "USD",
      "invoice_slugs": [
        "inv_example0001"
      ],
      "object": "payment",
      "scheduled_collection_at": "",
      "slug": "pay_example0001",
      "state": "succeeded"
    }
  ]
}

List proposals

List proposals, newest first, optionally by state or client. Archived proposals are not listed.

Inputs

Statestatetext
Only proposals in this state.One of: draft, awaiting_acceptance (Awaiting acceptance), accepted, completed, lost.
Clientclient_slugtext
Only this client's records. Pick one, or give its slug.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
proposalslist
The proposals
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "proposals": [
    {
      "auto_expire_days": 0,
      "auto_expiring": false,
      "client_name": "Acme Pty Ltd",
      "client_slug": "cli_example0001",
      "contract_term": "fixed",
      "created_at": "2026-11-13T19:06:02Z",
      "currency": "USD",
      "email_template_slug": "practempl_example0001",
      "is_renewal": false,
      "minimum_contract_length": 12,
      "monthly_recurring_value_cents": 15000,
      "name": "Annual bookkeeping",
      "next_steps_message": "",
      "object": "proposal",
      "one_time_date_display": "hide",
      "personalised_message": "",
      "proposal_value_display": "hide",
      "reference_number": "PROP-0001",
      "sender_type": "practice",
      "sender_user_slug": "",
      "service_price_display": "hide",
      "slug": "prop_example0001",
      "start_date": "",
      "start_on": "acceptance",
      "state": "draft",
      "terms_template_slug": "practempl_example0002",
      "total_non_recurring_value_cents": 0,
      "total_recurring_value_cents": 180000,
      "updated_at": "2026-11-13T19:06:02Z"
    }
  ]
}

List services

List the services in the practice's service library with their prices and tax rates.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
serviceslist
The services
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "services": [
    {
      "active": true,
      "billing_mode": "recurring",
      "billing_mode_label": "Recurring",
      "created_at": "2026-11-13T18:28:40Z",
      "description": "Bookkeeping for your business.",
      "name": "Monthly bookkeeping",
      "object": "service",
      "price": {
        "amount_cents": 15000,
        "currency": "USD",
        "maximum_cents": 0,
        "minimum_cents": 0,
        "object": "price_rule",
        "type": "fixed",
        "unit_name": ""
      },
      "short_description": "",
      "slug": "svc_example0001",
      "tax_rate": {
        "code": "",
        "name": "Exempt",
        "object": "tax_rate",
        "rate": 0.0,
        "slug": "iatax_example0001"
      },
      "terms": "",
      "updated_at": "2026-11-13T18:28:40Z"
    }
  ]
}

List tax rates

List the tax rates set up in the practice.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Defaults to 25.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.
Ordersorttext
When the records were created. Defaults to newest first.One of: -created_at (Newest first (default)), created_at (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more records after this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
tax_rateslist
The tax rates
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "tax_rates": [
    {
      "code": "",
      "name": "Exempt",
      "object": "tax_rate",
      "rate": 0.0,
      "slug": "iatax_example0001"
    }
  ]
}

Mark proposal lost

Mark a draft or awaiting-acceptance proposal as lost.

Inputs

Proposalproposal_slugtextRequired
The proposal. Pick one, or give its slug from an earlier step.

Outputs

proposalobject
The proposal, now lost
Example output
{
  "proposal": {
    "auto_expire_days": 0,
    "auto_expiring": false,
    "client_name": "Acme Pty Ltd",
    "client_slug": "cli_example0001",
    "contract_term": "fixed",
    "created_at": "2026-11-13T19:06:02Z",
    "currency": "USD",
    "email_template_slug": "practempl_example0001",
    "is_renewal": false,
    "minimum_contract_length": 12,
    "monthly_recurring_value_cents": 15000,
    "name": "Annual bookkeeping",
    "next_steps_message": "",
    "object": "proposal",
    "one_time_date_display": "hide",
    "personalised_message": "",
    "proposal_value_display": "hide",
    "reference_number": "PROP-0001",
    "sender_type": "practice",
    "sender_user_slug": "",
    "service_price_display": "hide",
    "slug": "prop_example0001",
    "start_date": "",
    "start_on": "acceptance",
    "state": "lost",
    "terms_template_slug": "practempl_example0002",
    "total_non_recurring_value_cents": 0,
    "total_recurring_value_cents": 180000,
    "updated_at": "2026-11-13T19:06:02Z"
  }
}

Restore client

Bring an archived client back.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.

Outputs

clientobject
The client, restored
Example output
{
  "client": {
    "address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "business_structure": "Sole Trader",
    "company_number": "12345",
    "contacts": [
      {
        "email": "jo@acme.example",
        "external_id": "crm-4821",
        "is_primary": true,
        "mobile": "",
        "name": "Jo Fernandez",
        "object": "contact",
        "phone": "(555) 555-0100",
        "receives_invoice_emails": true,
        "slug": "con_example0001"
      }
    ],
    "created_at": "2026-11-13T18:28:24Z",
    "external_id": "crm-4821",
    "manager": {
      "name": "Alex Manager",
      "slug": "user_example0002"
    },
    "name": "Acme Pty Ltd",
    "notes": "",
    "object": "client",
    "partner": {
      "name": "Sam Partner",
      "slug": "user_example0001"
    },
    "phone": "(555) 555-0100",
    "postal_address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "reference": "CLI-0001",
    "slug": "cli_example0001",
    "state": "lead",
    "tags": [],
    "tax_number": "",
    "updated_at": "2026-11-13T18:28:24Z",
    "website": "https://acme.example"
  }
}

Update client

Change a client's name or details. Fields left blank stay as they are.

Inputs

Clientclient_slugtextRequired
The client. Pick one, or give its slug from an earlier step.
Client namenametext
A new name for the client.
Phonephonetext
The client's phone number.
Websitewebsitetext
The client's website.
Tax numbertax_numbertext
The client's tax or VAT number.
Company numbercompany_numbertext
The client's company registration number.
Business structurebusiness_structuretext
How the client is set up, such as Sole Trader, Company or Partnership.
Notesnotestext
Notes about the client.
External IDexternal_idtext
Your own identifier for the client, to match it with another system.
Street addressaddress_line1text
The first line of the street address.
Cityaddress_citytext
The city or town of the address.
State or regionaddress_regiontext
The state, province or region.
Postal codeaddress_postal_codetext
The postal or ZIP code.
Countryaddress_countrytext
The country of the address.

Outputs

clientobject
The client, as updated
Example output
{
  "client": {
    "address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "business_structure": "Sole Trader",
    "company_number": "12345",
    "contacts": [
      {
        "email": "jo@acme.example",
        "external_id": "crm-4821",
        "is_primary": true,
        "mobile": "",
        "name": "Jo Fernandez",
        "object": "contact",
        "phone": "(555) 555-0100",
        "receives_invoice_emails": true,
        "slug": "con_example0001"
      }
    ],
    "created_at": "2026-11-13T18:28:24Z",
    "external_id": "crm-4821",
    "manager": {
      "name": "Alex Manager",
      "slug": "user_example0002"
    },
    "name": "Acme Pty Ltd",
    "notes": "",
    "object": "client",
    "partner": {
      "name": "Sam Partner",
      "slug": "user_example0001"
    },
    "phone": "(555) 555-0100",
    "postal_address": {
      "city": "Exampleville",
      "country": "USA",
      "line1": "100 Example Way",
      "postal_code": "10560",
      "region": "Example State"
    },
    "reference": "CLI-0001",
    "slug": "cli_example0001",
    "state": "lead",
    "tags": [],
    "tax_number": "",
    "updated_at": "2026-11-13T18:28:24Z",
    "website": "https://acme.example"
  }
}

Update contact

Change a contact's name or details. Fields left blank keep their current value.

Inputs

Contact slugcontact_slugtextRequired
The contact's slug (it starts with con_), from 'List contacts' or an earlier step.
Namenametext
A new full name for the contact.
Emailemailtext
The contact's email address.
Phonephonetext
The contact's phone number.
Mobilemobiletext
The contact's mobile number.
Primary contactis_primarytext
Make this the client's primary contact. Leave blank to keep it as it is.One of: true (Yes), false (No).
Receives invoice emailsreceives_invoice_emailstext
Send this contact the client's invoice emails. Leave blank to keep it as it is.One of: true (Yes), false (No).
External IDexternal_idtext
Your own identifier for the contact, to match it with another system.

Outputs

contactobject
The contact, as updated
Example output
{
  "contact": {
    "email": "jo@acme.example",
    "external_id": "crm-4821",
    "is_primary": true,
    "mobile": "",
    "name": "Jo Fernandez",
    "object": "contact",
    "phone": "(555) 555-0100",
    "receives_invoice_emails": true,
    "slug": "con_example0001"
  }
}

Update proposal

Change a draft proposal's name, messages or contract length. Fields left blank stay as they are.

Inputs

Proposalproposal_slugtextRequired
The proposal. Pick one, or give its slug from an earlier step.
Proposal namenametext
A new name for the proposal.
Message to the clientpersonalised_messagetext
A new personal note. Only drafts can change.
Next stepsnext_steps_messagetext
New next steps text. Only drafts can change.
Contract termcontract_termtext
Whether the contract ends after a fixed length or is ongoing.One of: fixed (Fixed length), ongoing.
Contract length (months)minimum_contract_lengthnumber
The number of months of a fixed contract.Only when Contract term is Fixed length. From 1 to 120.

Outputs

proposalobject
The proposal, as updated
Example output
{
  "proposal": {
    "auto_expire_days": 0,
    "auto_expiring": false,
    "client_name": "Acme Pty Ltd",
    "client_slug": "cli_example0001",
    "contract_term": "fixed",
    "created_at": "2026-11-13T19:06:02Z",
    "currency": "USD",
    "email_template_slug": "practempl_example0001",
    "is_renewal": false,
    "minimum_contract_length": 12,
    "monthly_recurring_value_cents": 15000,
    "name": "Annual bookkeeping",
    "next_steps_message": "",
    "object": "proposal",
    "one_time_date_display": "hide",
    "personalised_message": "",
    "proposal_value_display": "hide",
    "reference_number": "PROP-0001",
    "sender_type": "practice",
    "sender_user_slug": "",
    "service_price_display": "hide",
    "slug": "prop_example0001",
    "start_date": "",
    "start_on": "acceptance",
    "state": "draft",
    "terms_template_slug": "practempl_example0002",
    "total_non_recurring_value_cents": 0,
    "total_recurring_value_cents": 180000,
    "updated_at": "2026-11-13T19:06:02Z"
  }
}

Update service

Change a library service's name, price, tax rate or text. Fields left blank stay as they are.

Inputs

Serviceservice_slugtextRequired
The service from your service library. Pick one, or give its slug.
Service namenametext
A new name for the service.
Tax ratetax_rate_slugtext
A different tax rate for the service.
Price typeprice_typetext
A different kind of price. Leave blank to keep the current kind.One of: fixed (Fixed price), unit (Price per unit), minimum (Minimum price), range (Price range), included (Included at no charge).
Pricepricenumber
The price in your practice's currency, such as 150 for $150. Used by fixed and per-unit prices.At least 0.
Unit nameunit_nametext
What one unit is, such as hour, for a per-unit price.Only when Price type is Price per unit.
Minimum priceminimum_pricenumber
The lowest price for a minimum price or a price range.Only when Price type is Minimum price or Price range. At least 0.
Maximum pricemaximum_pricenumber
The highest price for a price range.Only when Price type is Price range. At least 0.
When it is billedbilling_modetext
When the service is billed. Leave blank to keep it as it is.One of: upfront (On acceptance), on_completion (On completion), recurring.
Descriptiondescriptiontext
What the service includes, shown to clients.
Termstermstext
Terms specific to this service.

Outputs

serviceobject
The service, as updated
Example output
{
  "service": {
    "active": true,
    "billing_mode": "recurring",
    "billing_mode_label": "Recurring",
    "created_at": "2026-11-13T18:28:40Z",
    "description": "Bookkeeping for your business.",
    "name": "Monthly bookkeeping",
    "object": "service",
    "price": {
      "amount_cents": 15000,
      "currency": "USD",
      "maximum_cents": 0,
      "minimum_cents": 0,
      "object": "price_rule",
      "type": "fixed",
      "unit_name": ""
    },
    "short_description": "",
    "slug": "svc_example0001",
    "tax_rate": {
      "code": "",
      "name": "Exempt",
      "object": "tax_rate",
      "rate": 0.0,
      "slug": "iatax_example0001"
    },
    "terms": "",
    "updated_at": "2026-11-13T18:28:40Z"
  }
}

On this page