# Servicem8

Your Toolhouse AI Worker can connect to Servicem8 using 28 specialized tools.

## Auth Connection

{% hint style="info" %}
This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=servicem8).
{% endhint %}

## Tools (28)

### `Servicem8 Create Job Note`

Integration name: **SERVICEM8\_CREATE\_JOB\_NOTE**

Create a new job note in ServiceM8. Requires the job's UUID (`related_object_uuid`) and the note content. Returns the UUID of the created note record. Use this to add comments, updates, or action items to a specific job.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter                        | Type    | Required | Example                                     | Description                                                                                               |
| -------------------------------- | ------- | :------: | ------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `note`                           | string  |     ✅    | `"Left voicemail requesting confirmation."` | Content of the note.                                                                                      |
| `uuid`                           | string  |          | `"123e4567-e89b-12d3-a456-426655440000"`    | Unique identifier for this note record. If omitted, a UUID will be generated.                             |
| `active`                         | integer |          | `1`                                         | Record active flag: 1 = active (default), 0 = deleted.                                                    |
| `create_date`                    | string  |          | `"2023-07-01 12:34:56"`                     | Timestamp when the note was created (format: YYYY-MM-DD HH:MM:SS). Server sets automatically if omitted.  |
| `related_object`                 | string  |          | `"job"`                                     | Type of the related object. Defaults to 'job' for job notes. Other possible values may include 'company'. |
| `action_required`                | string  |          | `"Client to confirm schedule."`             | Optional follow-up action required description.                                                           |
| `related_object_uuid`            | string  |     ✅    | `"123e4567-e89b-12d3-a456-426655440001"`    | UUID of the related job.                                                                                  |
| `action_completed_by_staff_uuid` | string  |          | `"abcdef12-3456-7890-abcd-ef1234567890"`    | UUID of staff member who completed the required action.                                                   |

***

### `Servicem8 Create Job Payment`

Integration name: **SERVICEM8\_CREATE\_JOB\_PAYMENT**

Tool to create a new job payment in ServiceM8. Use when you have collected payment details and need to record payment against a job. Example: "Create a 100.00 cash payment for job 123e4567-e89b-12d3-a456-426614174000 at 2023-01-01 13:00:00."

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter          | Type    | Required | Example                                  | Description                                                                                                                                  |
| ------------------ | ------- | :------: | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `note`             | string  |          | `"Customer paid in full."`               | Additional notes or comments regarding the payment.                                                                                          |
| `uuid`             | string  |          | `"123e4567-e89b-12d3-a456-426614174003"` | Optional UUID for the payment record. If omitted, a UUID will be auto-generated by the server.                                               |
| `active`           | integer |          | `1`                                      | Record active flag: 1 = active (default), 0 = archived/deleted.                                                                              |
| `amount`           | string  |     ✅    | `"100.00"`                               | Amount of the payment as a decimal string (e.g., '100.00', '50.50'). Use string format to preserve decimal precision.                        |
| `method`           | string  |     ✅    | `"cash"`                                 | Payment method used. Common values: 'cash', 'credit\_card', 'eftpos', 'cheque', 'bank\_transfer', 'online'.                                  |
| `job_uuid`         | string  |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | UUID of the job to record the payment against. Obtain this from list\_all\_jobs or create\_job actions.                                      |
| `edit_date`        | string  |          | `"2023-01-01 12:00:00"`                  | Timestamp of last edit in 'YYYY-MM-DD HH:MM:SS' format. Usually auto-set by the server if omitted.                                           |
| `timestamp`        | string  |     ✅    | `"2023-01-01 13:00:00"`                  | Timestamp when the payment was received in 'YYYY-MM-DD HH:MM:SS' format.                                                                     |
| `is_deposit`       | integer |          | `0`                                      | Deposit flag: 1 = this payment is a deposit, 0 = regular payment (default if omitted).                                                       |
| `attachment_uuid`  | string  |          | `"123e4567-e89b-12d3-a456-426614174002"` | UUID of any attachment (e.g., receipt image) related to the payment.                                                                         |
| `actioned_by_uuid` | string  |          | `"123e4567-e89b-12d3-a456-426614174001"` | UUID of the staff member who recorded/processed the payment. Obtain from staff endpoints. If omitted, may default to the authenticated user. |

***

### `Servicem8 Create Jobs`

Integration name: **SERVICEM8\_CREATE\_JOBS**

Tool to create a new Job in ServiceM8. Use when you have gathered all job details and need to push a record. Example: "Create a Quote job for 123 Main St with PO #1234."

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter               | Type    | Required | Example | Description                                                   |
| ----------------------- | ------- | :------: | ------- | ------------------------------------------------------------- |
| `date`                  | string  |          | —       | Date the job is scheduled or created (YYYY-MM-DD).            |
| `active`                | integer |          | —       | Active flag (1 = active, 0 = deleted). Defaults to 1.         |
| `badges`                | array   |          | —       | List of badge UUIDs to apply to this job.                     |
| `status`                | string  |     ✅    | —       | Current status of the job. Controls dispatch board placement. |
| `queue_uuid`            | string  |          | —       | UUID of the queue to assign this job to.                      |
| `job_address`           | string  |     ✅    | —       | Physical address where the job is to be performed.            |
| `company_uuid`          | string  |          | —       | UUID of the customer/company associated with this job.        |
| `category_uuid`         | string  |          | —       | UUID of the job category.                                     |
| `job_description`       | string  |          | —       | Brief description of the work to be done.                     |
| `created_by_staff_uuid` | string  |          | —       | UUID of the staff member creating this job.                   |
| `purchase_order_number` | string  |          | —       | Client purchase order reference number.                       |

***

### `Servicem8 Delete Custom Field`

Integration name: **SERVICEM8\_DELETE\_CUSTOM\_FIELD**

Delete a custom field in ServiceM8 by its UUID. Use this when you need to permanently remove a custom field definition from the system. This will remove the custom field and any associated data.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                          |
| --------- | ------ | :------: | ---------------------------------------- | -------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"e64eddf4-fbbc-49e8-9ebd-23d804b2265b"` | The UUID of the custom field to delete. Must be a valid UUID string. |

***

### `Servicem8 Delete Job Note`

Integration name: **SERVICEM8\_DELETE\_JOB\_NOTE**

Deletes (archives) a job note in ServiceM8 by its UUID. Use this tool when you need to remove a note from a job's diary. In ServiceM8, deletion is a soft-delete: the note is archived (`active=0`) rather than permanently removed, and can be restored later if needed. Prerequisites: You need the note's UUID, which can be obtained from the 'List All Job Notes' or 'Retrieve Job Note' actions.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example | Description                                                                     |
| --------- | ------ | :------: | ------- | ------------------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | —       | UUID of the job note to delete. Example: '123e4567-e89b-12d3-a456-426614174000' |

***

### `Servicem8 Delete Job Payment`

Integration name: **SERVICEM8\_DELETE\_JOB\_PAYMENT**

Archives (soft-deletes) a job payment record in ServiceM8 by its UUID. In ServiceM8, records are never permanently deleted. Instead, deletion sets the record's `active` field to 0, which hides it from the UI but keeps it accessible via the API. Archived records can be restored by setting their `active` field back to 1. Use this tool when you need to remove a payment record from active use, such as when a payment was recorded in error or needs to be voided. Requires the `manage_job_payments` OAuth scope.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                                                                                                                                                 |
| --------- | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426655440000"` | The UUID of the job payment to delete (archive). In ServiceM8, deletion is a soft delete that sets the record's active field to 0, hiding it from the UI but keeping it accessible via API. |

***

### `Servicem8 List All Assets`

Integration name: **SERVICEM8\_LIST\_ALL\_ASSETS**

Tool to list all ServiceM8 assets. Use when you need a comprehensive asset registry, including custom fields, for inventory or reporting.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                                                                                                                                                 |
| --------- | ------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter`  | string |          | `"active eq 1"` | OData-style filter expression to narrow down assets. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). Multiple conditions can be combined with 'and'. Examples: 'active eq 1', 'name eq 'Pump Model X''. String values must be wrapped in single quotes. |

***

### `Servicem8 List All Clients`

Integration name: **SERVICEM8\_LIST\_ALL\_CLIENTS**

Tool to list all ServiceM8 clients. Use when you need a complete set of customer records for integrations or reporting.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                                                                                                                                                                         |
| --------- | ------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter`  | string |          | `"active eq 1"` | OData-style filter expression using $filter syntax. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). Combine conditions with 'and' (max 10 conditions). Examples: "active eq 1", "name eq 'Acme Corp'", "create\_date gt '2024-01-01'". Note: ge/le operators are not supported. |

***

### `Servicem8 List All Document Templates`

Integration name: **SERVICEM8\_LIST\_ALL\_DOCUMENT\_TEMPLATES**

Tool to list document templates. Use when you need to retrieve available template UUIDs and names before generating job documents.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                 | Description                                                                                                                                                      |
| --------- | ------ | :------: | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor`  | string |          | —                       | Pagination cursor. Use '-1' for the first page. For subsequent pages, use the value from the 'x-next-cursor' response header. If omitted, returns all templates. |
| `filter`  | string |          | `"name eq \"Invoice\""` | OData-style filter expression to narrow document templates. Examples: 'name eq "Invoice"', 'active eq 1', 'template\_type eq "Quote"'.                           |

***

### `Servicem8 List All Forms`

Integration name: **SERVICEM8\_LIST\_ALL\_FORMS**

Tool to list all ServiceM8 forms. Use when you need to fetch available form templates with optional filters.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                                                                                                                                    |
| --------- | ------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `filter`  | string |          | `"active eq 1"` | OData-style filter expression to narrow down forms. Supported operators: eq (equals), ne (not equals), gt (greater than), lt (less than). Combine up to 10 conditions with 'and'. String values must use single quotes. Examples: "active eq 1", "name eq 'Safety Checklist'". |

***

### `Servicem8 List All Job Notes`

Integration name: **SERVICEM8\_LIST\_ALL\_JOB\_NOTES**

List all job notes from ServiceM8. Use this tool to:

* Retrieve all notes across all jobs (no filter)
* Get notes for a specific job using filter: `"related_object_uuid eq '<job_uuid>'"`
* Filter by active status: `"active eq 1"` for active notes only

The response contains a list of note records with their content, timestamps, and associated job UUIDs. For large result sets, use cursor-based pagination: pass `cursor='-1'` for the first page, then use the `next_cursor` value from each response to fetch subsequent pages. Each page returns up to 5,000 records.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                                           | Description                                                                                                                                                                                                                                             |
| --------- | ------ | :------: | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor`  | string |          | `"-1"`                                                            | Cursor for pagination. Use '-1' for the first page. For subsequent pages, use the 'next\_cursor' value from the previous response. Each page returns up to 5,000 records.                                                                               |
| `filter`  | string |          | `"related_object_uuid eq '123e4567-e89b-12d3-a456-426614174000'"` | OData filter expression to filter notes. Common filters include: 'related\_object\_uuid eq \<job\_uuid>' to get notes for a specific job, 'active eq 1' for active notes only. Use actual API field names (e.g., related\_object\_uuid, not job\_uuid). |

***

### `Servicem8 List All Job Queues`

Integration name: **SERVICEM8\_LIST\_ALL\_JOB\_QUEUES**

List all job queues in ServiceM8. Job queues are virtual folders for organizing jobs on hold. Use this to fetch available queues before assigning jobs to a queue, or to check queue configurations. Returns both regular queues (for jobs waiting on external actions) and assignable queues (for staff assignments).

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

*No parameters required.*

***

### `Servicem8 List All Jobs`

Integration name: **SERVICEM8\_LIST\_ALL\_JOBS**

Tool to list all jobs. Use when you need to fetch all job records from your ServiceM8 account.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                    | Description                                                                                                                                                                                                                                                                                                                 |
| --------- | ------ | :------: | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter`  | string |          | `"status eq 'Work Order'"` | OData-style filter expression to narrow down jobs. Supported operators: eq (equals), ne (not equals), gt (greater than), lt (less than). Combine up to 10 conditions with 'and'. String values must use single quotes. Examples: "status eq 'Completed'", "status eq 'Work Order' and active eq 1", "date gt '2024-01-01'". |

***

### `Servicem8 List All Locations`

Integration name: **SERVICEM8\_LIST\_ALL\_LOCATIONS**

Lists all ServiceM8 locations. Use to fetch configured service areas, office locations, or warehouses for job assignments, mapping, or reporting.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                  |
| --------- | ------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `filter`  | string |          | `"active eq 1"` | Optional filter expression to narrow down locations using ServiceM8 filtering syntax (e.g., 'active eq 1'). See ServiceM8 filtering docs for syntax details. |

***

### `Servicem8 List All Materials`

Integration name: **SERVICEM8\_LIST\_ALL\_MATERIALS**

Retrieve all materials (products, labour rates, inventory items) from ServiceM8. Use this to get a complete catalog of materials for quoting, invoicing, or inventory management. Requires the `read_inventory` OAuth scope.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                                        |
| --------- | ------ | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filter`  | string |          | `"active eq 1"` | Filter expression using ServiceM8 filtering syntax to narrow down results. Examples: 'active eq 1' for active materials only, 'name eq "Labour"' for materials with specific name. |

***

### `Servicem8 List All Tasks`

Integration name: **SERVICEM8\_LIST\_ALL\_TASKS**

Retrieves all tasks from a ServiceM8 account with optional filtering and cursor-based pagination. Use this to fetch task records, track task assignments, monitor completion status, or sync task data. Requires `read_tasks` OAuth scope.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example         | Description                                                                                                                                                                                                                                                          |
| --------- | ------ | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor`  | string |          | —               | Cursor for pagination. Use '-1' to start from the beginning. For subsequent pages, use the `next_cursor` value from the previous response. Each page returns up to 5000 records.                                                                                     |
| `filter`  | string |          | `"active eq 1"` | OData-style filter expression to narrow results. Supported operators: eq (equal), ne (not equal), gt (greater than), lt (less than). String values must use single quotes. Combine up to 10 conditions with 'and'. Example: "active eq 1 and job\_uuid eq 'abc-123'" |

***

### `Servicem8 Retrieve Client`

Integration name: **SERVICEM8\_RETRIEVE\_CLIENT**

Tool to retrieve details of a specific client by its UUID. Use after confirming the client's UUID is valid.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                              |
| --------- | ------ | :------: | ---------------------------------------- | ---------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | UUID of the company (client) to retrieve |

***

### `Servicem8 Retrieve Form`

Integration name: **SERVICEM8\_RETRIEVE\_FORM**

Retrieve details of a specific form template by its UUID. Use this tool when you have a form UUID and need to fetch its metadata, such as form name, description, and status. Requires the Forms add-on to be enabled in ServiceM8.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                           |
| --------- | ------ | :------: | ---------------------------------------- | ----------------------------------------------------- |
| `uuid`    | string |     ✅    | `"550e8400-e29b-41d4-a716-446655440000"` | The unique identifier (UUID) of the form to retrieve. |

***

### `Servicem8 Retrieve Job`

Integration name: **SERVICEM8\_RETRIEVE\_JOB**

Tool to retrieve details of a specific job by its UUID. Use when you have the Job UUID and need its full record.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                     |
| --------- | ------ | :------: | ---------------------------------------- | ------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426655440000"` | The UUID of the job to retrieve |

***

### `Servicem8 Retrieve Job Activity`

Integration name: **SERVICEM8\_RETRIEVE\_JOB\_ACTIVITY**

Tool to retrieve details of a specific job activity by its UUID. Use when you have the job activity UUID and need its full details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                    |
| --------- | ------ | :------: | ---------------------------------------- | ---------------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-92d2-45a0-b890-22af748ce73b"` | UUID of the ServiceM8 job activity to retrieve |

***

### `Servicem8 Retrieve Job Note`

Integration name: **SERVICEM8\_RETRIEVE\_JOB\_NOTE**

Retrieve the full details of a specific job note by its UUID. Use this action when you have a note UUID (e.g., from listing job notes) and need to view its complete record including content, timestamps, and the associated job reference.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                                                 |
| --------- | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | UUID of the job note to retrieve. You can obtain this from the 'List All Job Notes' action. |

***

### `Servicem8 Retrieve Job Payment`

Integration name: **SERVICEM8\_RETRIEVE\_JOB\_PAYMENT**

Retrieve a specific job payment record from ServiceM8 by its UUID. Use this tool when you need to:

* Get full details of a specific payment (amount, method, timestamp, notes)
* Check if a payment is a deposit or regular payment
* View which staff member processed a payment
* Verify payment information for a job

Prerequisites: You need the job payment UUID, which can be obtained from the 'List All Job Payments' action or from creating a new job payment.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                                                                                                            |
| --------- | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `uuid`    | string |     ✅    | `"550e8400-e29b-41d4-a716-446655440000"` | The unique identifier (UUID) of the job payment record to retrieve. This is a 36-character UUID string (e.g., '550e8400-e29b-41d4-a716-446655440000'). |

***

### `Servicem8 Retrieve Job Queue`

Integration name: **SERVICEM8\_RETRIEVE\_JOB\_QUEUE**

Tool to retrieve details of a specific job queue by its UUID. Use when you need full queue metadata before dispatching work.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                        |
| --------- | ------ | :------: | ---------------------------------------- | ---------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | UUID of the job queue to retrieve. |

***

### `Servicem8 Retrieve Location`

Integration name: **SERVICEM8\_RETRIEVE\_LOCATION**

Retrieve a specific ServiceM8 location by its UUID. Returns complete location details including name, address fields (street, city, state, country, postal code), geographic coordinates (lat/lng), contact phone number, and active status. Use this when you have a known location UUID and need its full details. To list all available locations, use the List All Locations action first.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                                                         |
| --------- | ------ | :------: | ---------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-c066-4232-b537-234d5a2f838b"` | The unique identifier (UUID) of the location to retrieve. Must be a valid 36-character UUID string. |

***

### `Servicem8 Retrieve Material`

Integration name: **SERVICEM8\_RETRIEVE\_MATERIAL**

Retrieve detailed information about a specific material/product/service by its UUID. Returns pricing, inventory levels, tax settings, and identification details. Use this when you have a material UUID from a job or list operation and need complete details like current stock levels or pricing information.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                                                                      |
| --------- | ------ | :------: | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"` | UUID of the material to retrieve. Obtain this from the 'List All Materials' action or from job material records. |

***

### `Servicem8 Retrieve Staff Member`

Integration name: **SERVICEM8\_RETRIEVE\_STAFF\_MEMBER**

Tool to retrieve details of a specific staff member by their UUID. Use when you need up-to-date staff information given a known staff UUID.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                                  | Description                                                   |
| --------- | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------- |
| `uuid`    | string |     ✅    | `"550e8400-e29b-41d4-a716-446655440000"` | The unique identifier (UUID) of the staff member to retrieve. |

***

### `Servicem8 Update Job Note`

Integration name: **SERVICEM8\_UPDATE\_JOB\_NOTE**

Tool to update details of an existing job note. Use when modifying a note after its creation.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter   | Type    | Required | Example                                   | Description                                                             |
| ----------- | ------- | :------: | ----------------------------------------- | ----------------------------------------------------------------------- |
| `note`      | string  |          | `"Rescheduled to next Tuesday at 10 AM."` | New content for the job note                                            |
| `uuid`      | string  |     ✅    | `"123e4567-e89b-12d3-a456-426614174000"`  | UUID of the job note to update                                          |
| `active`    | integer |          | `1`                                       | Active flag: 1=active, 0=archived                                       |
| `edit_date` | string  |          | `"2023-10-01 15:30:00"`                   | Timestamp when the note was last edited in 'YYYY-MM-DD HH:MM:SS' format |

***

### `Servicem8 Update Job Payment`

Integration name: **SERVICEM8\_UPDATE\_JOB\_PAYMENT**

Update an existing job payment record in ServiceM8. Use this to modify payment details such as amount, method, note, or status. Requires the payment UUID and at least one field to update.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter          | Type    | Required | Example                                  | Description                                                                               |
| ------------------ | ------- | :------: | ---------------------------------------- | ----------------------------------------------------------------------------------------- |
| `note`             | string  |          | `"Customer paid in full."`               | Note or memo for the payment                                                              |
| `uuid`             | string  |     ✅    | `"123e4567-e89b-12d3-a456-426655440000"` | UUID of the job payment record to update (required)                                       |
| `active`           | integer |          | `1`                                      | Active status: 1=active, 0=archived/deleted                                               |
| `amount`           | string  |          | `"150.00"`                               | New payment amount as a decimal string (e.g., '150.00')                                   |
| `method`           | string  |          | `"credit_card"`                          | Payment method: 'cash', 'credit\_card', 'eftpos', 'cheque', 'direct\_deposit', or 'other' |
| `timestamp`        | string  |          | `"2023-01-01 13:00:00"`                  | Payment date/time in 'YYYY-MM-DD HH:MM:SS' format                                         |
| `is_deposit`       | integer |          | `0`                                      | Whether this is a deposit: 1=deposit, 0=regular payment                                   |
| `attachment_uuid`  | string  |          | `"123e4567-e89b-12d3-a456-426655440002"` | UUID of an attachment (e.g., receipt image) linked to this payment                        |
| `actioned_by_uuid` | string  |          | `"123e4567-e89b-12d3-a456-426655440001"` | UUID of the staff member who recorded or updated the payment                              |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.toolhouse.ai/toolhouse/integrations/servicem8.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.