# Ignition

> 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.

App · 26 actions. Web page: https://docs.lodol.com/docs/integrations/ignition

## Actions

### Add contact

Add a contact to a client.

**Inputs**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.
- Name (`name`, text, required): The contact's full name.
- Email (`email`, text): The contact's email address.
- Phone (`phone`, text): The contact's phone number.
- Mobile (`mobile`, text): The contact's mobile number.
- Primary contact (`is_primary`, true/false): Make this the client's primary contact, who receives proposals. Default: `false`.
- Receives invoice emails (`receives_invoice_emails`, true/false): Send this contact the client's invoice emails. Default: `false`.
- External ID (`external_id`, text): Your own identifier for the contact, to match it with another system.

**Outputs**

- `contact` (object): The contact added

**Example output**

```json
{
  "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**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.

**Outputs**

- `client` (object): The client, now archived

**Example output**

```json
{
  "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**

- Proposal (`proposal_slug`, text, required): The proposal. Pick one, or give its slug from an earlier step.

**Outputs**

- `proposal` (object): The proposal, now archived

**Example output**

```json
{
  "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 name (`name`, text, required): The client's name.
- Primary contact name (`contact_name`, text, required): The person at the client Ignition sends proposals and invoices to.
- Primary contact email (`contact_email`, text): The primary contact's email address.
- Primary contact phone (`contact_phone`, text): The primary contact's phone number.
- Primary contact mobile (`contact_mobile`, text): The primary contact's mobile number.
- Phone (`phone`, text): The client's phone number.
- Website (`website`, text): The client's website.
- Tax number (`tax_number`, text): The client's tax or VAT number.
- Company number (`company_number`, text): The client's company registration number.
- Business structure (`business_structure`, text): How the client is set up, such as Sole Trader, Company or Partnership.
- Notes (`notes`, text): Notes about the client.
- External ID (`external_id`, text): Your own identifier for the client, to match it with another system.
- Street address (`address_line1`, text): The first line of the street address.
- City (`address_city`, text): The city or town of the address.
- State or region (`address_region`, text): The state, province or region.
- Postal code (`address_postal_code`, text): The postal or ZIP code.
- Country (`address_country`, text): The country of the address.

**Outputs**

- `client` (object): The client created or updated

**Example output**

```json
{
  "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**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.
- Proposal name (`name`, text, required): The proposal's name, shown to the client.
- Service (`service_slug`, text, required): The service from your service library. Pick one, or give its slug.
- Billing (`billing`, text): 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`.
- Quantity (`quantity`, number): How many of the service. Defaults to 1. At least 0.
- Price (`price`, number): 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 client (`personalised_message`, text): A personal note shown at the top of the proposal.
- Next steps (`next_steps_message`, text): What happens after the client accepts.

**Outputs**

- `proposal` (object): The draft proposal created

**Example output**

```json
{
  "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 name (`name`, text, required): The service's name.
- Tax rate (`tax_rate_slug`, text, required): The tax rate the service is sold at.
- Price type (`price_type`, text): 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`.
- Price (`price`, number): The price in your practice's currency, such as 150 for $150. Used by fixed and per-unit prices. At least 0.
- Unit name (`unit_name`, text): What one unit is, such as hour, for a per-unit price. Only when Price type is Price per unit.
- Minimum price (`minimum_price`, number): 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 price (`maximum_price`, number): The highest price for a price range. Only when Price type is Price range. At least 0.
- When it is billed (`billing_mode`, text): 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`.
- Description (`description`, text): What the service includes, shown to clients.
- Terms (`terms`, text): Terms specific to this service.

**Outputs**

- `service` (object): The service created

**Example output**

```json
{
  "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 slug (`contact_slug`, text, required): The contact's slug (it starts with con_), from 'List contacts' or an earlier step.

**Outputs**

- `contact_slug` (text): The contact deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "contact_slug": "con_example0001",
  "deleted": true
}
```

### Get client

Get one client with its details, contacts and tags.

**Inputs**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.

**Outputs**

- `client` (object): The client

**Example output**

```json
{
  "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 slug (`contact_slug`, text, required): The contact's slug (it starts with con_), from 'List contacts' or an earlier step.

**Outputs**

- `contact` (object): The contact

**Example output**

```json
{
  "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**

- `practice` (object): The connected practice

**Example output**

```json
{
  "practice": {
    "name": "Acme Advisory",
    "object": "practice",
    "slug": "prac_example0001"
  }
}
```

### Get proposal

Get one proposal with its state, client and values.

**Inputs**

- Proposal (`proposal_slug`, text, required): The proposal. Pick one, or give its slug from an earlier step.

**Outputs**

- `proposal` (object): The proposal

**Example output**

```json
{
  "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**

- Service (`service_slug`, text, required): The service from your service library. Pick one, or give its slug.

**Outputs**

- `service` (object): The service

**Example output**

```json
{
  "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**

- Client (`client_slug`, text): Only this client's records. Pick one, or give its slug.
- Proposal (`proposal_slug`, text): Only services agreed through this proposal.
- State (`state`, text): Only agreed services in this state. One of: `upcoming`, `enabled`, `disabled`, `cancelled`.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `agreed_services` (list): The agreed services
- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one

**Example output**

```json
{
  "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 contains (`name`, text): Only clients whose name contains this text.
- State (`state`, text): Only clients in this state. One of: `lead`, `active`, `inactive`, `archived`.
- External ID (`external_id`, text): Only the client carrying this external id.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `clients` (list): The clients
- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one

**Example output**

```json
{
  "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**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.

**Outputs**

- `contacts` (list): The client's contacts
- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one

**Example output**

```json
{
  "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**

- Client (`client_slug`, text): Only this client's records. Pick one, or give its slug.
- State (`state`, text): Only invoices in this state. One of: `issued`, `voided`, `archived`.
- Payment (`payment_state`, text): Only invoices that are unpaid, partly paid or paid. One of: `unpaid`, `partially_paid` (Partially paid), `paid`.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `invoices` (list): The invoices
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one

**Example output**

```json
{
  "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 size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `payments` (list): The payments

**Example output**

```json
{
  "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**

- State (`state`, text): Only proposals in this state. One of: `draft`, `awaiting_acceptance` (Awaiting acceptance), `accepted`, `completed`, `lost`.
- Client (`client_slug`, text): Only this client's records. Pick one, or give its slug.
- Page size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `proposals` (list): The proposals

**Example output**

```json
{
  "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 size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `services` (list): The services

**Example output**

```json
{
  "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 size (`limit`, number): How many to return, 1 to 100. Defaults to 25. From 1 to 100.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.
- Order (`sort`, text): When the records were created. Defaults to newest first. One of: `-created_at` (Newest first (default)), `created_at` (Oldest first).

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): True if there are more records after this page
- `next_cursor` (text): Pass as 'after' for the next page; empty on the last one
- `tax_rates` (list): The tax rates

**Example output**

```json
{
  "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**

- Proposal (`proposal_slug`, text, required): The proposal. Pick one, or give its slug from an earlier step.

**Outputs**

- `proposal` (object): The proposal, now lost

**Example output**

```json
{
  "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**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.

**Outputs**

- `client` (object): The client, restored

**Example output**

```json
{
  "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**

- Client (`client_slug`, text, required): The client. Pick one, or give its slug from an earlier step.
- Client name (`name`, text): A new name for the client.
- Phone (`phone`, text): The client's phone number.
- Website (`website`, text): The client's website.
- Tax number (`tax_number`, text): The client's tax or VAT number.
- Company number (`company_number`, text): The client's company registration number.
- Business structure (`business_structure`, text): How the client is set up, such as Sole Trader, Company or Partnership.
- Notes (`notes`, text): Notes about the client.
- External ID (`external_id`, text): Your own identifier for the client, to match it with another system.
- Street address (`address_line1`, text): The first line of the street address.
- City (`address_city`, text): The city or town of the address.
- State or region (`address_region`, text): The state, province or region.
- Postal code (`address_postal_code`, text): The postal or ZIP code.
- Country (`address_country`, text): The country of the address.

**Outputs**

- `client` (object): The client, as updated

**Example output**

```json
{
  "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 slug (`contact_slug`, text, required): The contact's slug (it starts with con_), from 'List contacts' or an earlier step.
- Name (`name`, text): A new full name for the contact.
- Email (`email`, text): The contact's email address.
- Phone (`phone`, text): The contact's phone number.
- Mobile (`mobile`, text): The contact's mobile number.
- Primary contact (`is_primary`, text): Make this the client's primary contact. Leave blank to keep it as it is. One of: `true` (Yes), `false` (No).
- Receives invoice emails (`receives_invoice_emails`, text): Send this contact the client's invoice emails. Leave blank to keep it as it is. One of: `true` (Yes), `false` (No).
- External ID (`external_id`, text): Your own identifier for the contact, to match it with another system.

**Outputs**

- `contact` (object): The contact, as updated

**Example output**

```json
{
  "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**

- Proposal (`proposal_slug`, text, required): The proposal. Pick one, or give its slug from an earlier step.
- Proposal name (`name`, text): A new name for the proposal.
- Message to the client (`personalised_message`, text): A new personal note. Only drafts can change.
- Next steps (`next_steps_message`, text): New next steps text. Only drafts can change.
- Contract term (`contract_term`, text): Whether the contract ends after a fixed length or is ongoing. One of: `fixed` (Fixed length), `ongoing`.
- Contract length (months) (`minimum_contract_length`, number): The number of months of a fixed contract. Only when Contract term is Fixed length. From 1 to 120.

**Outputs**

- `proposal` (object): The proposal, as updated

**Example output**

```json
{
  "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**

- Service (`service_slug`, text, required): The service from your service library. Pick one, or give its slug.
- Service name (`name`, text): A new name for the service.
- Tax rate (`tax_rate_slug`, text): A different tax rate for the service.
- Price type (`price_type`, text): 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).
- Price (`price`, number): The price in your practice's currency, such as 150 for $150. Used by fixed and per-unit prices. At least 0.
- Unit name (`unit_name`, text): What one unit is, such as hour, for a per-unit price. Only when Price type is Price per unit.
- Minimum price (`minimum_price`, number): 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 price (`maximum_price`, number): The highest price for a price range. Only when Price type is Price range. At least 0.
- When it is billed (`billing_mode`, text): When the service is billed. Leave blank to keep it as it is. One of: `upfront` (On acceptance), `on_completion` (On completion), `recurring`.
- Description (`description`, text): What the service includes, shown to clients.
- Terms (`terms`, text): Terms specific to this service.

**Outputs**

- `service` (object): The service, as updated

**Example output**

```json
{
  "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"
  }
}
```
