> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Servicem8

> ServiceM8 helps field service businesses schedule jobs, send quotes, and manage invoices, offering staff mobile apps and real-time job status tracking

![Servicem8 logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/servicem8.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=be056442c1e51d5b20cfa121742b2ef1)

* **Category:** scheduling & booking
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** Yes
* **Tools:** 61
* **Triggers:** 0
* **Slug:** `SERVICEM8`
* **Version:** 20261103\_00

## Tools

> [accordion] Create ServiceM8 Client
>
> **Slug:** `SERVICEM8_CREATE_CLIENT`
>
> Create a ServiceM8 client company and retrieve its saved record. The client may be created even if the subsequent retrieval fails.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Company or client name
>
> **uuid** `string`
>
> UUID to assign to the new client record
>
> **badges** `array`
>
> Badge UUIDs to associate with the client
>
> **address** `string`
>
> Complete company address
>
> **website** `string`
>
> Company website
>
> **abn\_number** `string`
>
> Australian Business Number
>
> **fax\_number** `string`
>
> Fax number
>
> **address\_city** `string`
>
> City or suburb
>
> **address\_state** `string`
>
> State, territory, or province
>
> **payment\_terms** `string`
>
> Payment terms
>
> **tax\_rate\_uuid** `string`
>
> UUID of the tax rate associated with the client
>
> **address\_street** `string`
>
> Street address
>
> **address\_country** `string`
>
> Country
>
> **billing\_address** `string`
>
> Complete billing address
>
> **deposit\_percent** `integer`
>
> Deposit percentage
>
> **address\_postcode** `string`
>
> Postal or ZIP code
>
> **billing\_attention** `string`
>
> Contact name for billing correspondence
>
> **parent\_company\_uuid** `string`
>
> UUID of the parent company, or blank for a head office
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Company Contact
>
> **Slug:** `SERVICEM8_CREATE_COMPANY_CONTACT`
>
> Create a contact for a ServiceM8 client company and return its UUID.
>
> #### Input Parameters
>
> **last** `string`
>
> Contact's last name.
>
> **type** `string`
>
> Contact type, such as BILLING or JOB.
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **email** `string`
>
> Email address used for contact communications.
>
> **first** `string`
>
> Contact's first name.
>
> **phone** `string`
>
> Contact's primary phone number, including area or country code.
>
> **mobile** `string`
>
> Contact's mobile phone number, including area or country code.
>
> **company\_uuid** `string`
>
> UUID of the company this contact belongs to.
>
> **is\_primary\_contact** `string ("0" | "1")`
>
> Provider string flag: 1 for the primary contact, otherwise 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Activity
>
> **Slug:** `SERVICEM8_CREATE_JOB_ACTIVITY`
>
> Create a scheduled or recorded ServiceM8 job activity and return its UUID.
>
> #### Input Parameters
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **end\_date** `string`
>
> Scheduled end date and time of the activity.
>
> **job\_uuid** `string`
>
> UUID of the job this activity belongs to.
>
> **staff\_uuid** `string`
>
> UUID of the staff member assigned to this activity.
>
> **start\_date** `string`
>
> Scheduled start date and time of the activity.
>
> **material\_uuid** `string`
>
> UUID of the material used to determine the activity cost.
>
> **has\_been\_opened** `string ("0" | "1")`
>
> Provider string flag indicating whether the assigned staff member has viewed this scheduled activity.
>
> **allocated\_timestamp** `string`
>
> Deprecated timestamp when the activity was allocated.
>
> **activity\_was\_recorded** `string ("0" | "1")`
>
> Provider string flag indicating whether the activity was recorded after completion; it cannot be true when activity\_was\_scheduled is true.
>
> **activity\_was\_automated** `string ("0" | "1")`
>
> Provider string flag indicating whether the activity was automated.
>
> **activity\_was\_scheduled** `string ("0" | "1")`
>
> Provider string flag indicating whether the activity was scheduled in advance; it cannot be true when activity\_was\_recorded is true.
>
> **travel\_time\_in\_seconds** `integer`
>
> Estimated travel time to the activity location in seconds.
>
> **allocated\_by\_staff\_uuid** `string`
>
> Deprecated UUID of the staff member who allocated the activity.
>
> **has\_been\_opened\_timestamp** `string`
>
> Date and time the assigned staff member first viewed the activity, in YYYY-MM-DD HH:MM:SS format.
>
> **travel\_distance\_in\_meters** `integer`
>
> Estimated travel distance to the activity location in meters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Checklist
>
> **Slug:** `SERVICEM8_CREATE_JOB_CHECKLIST`
>
> Create a ServiceM8 job checklist item and return its UUID.
>
> #### Input Parameters
>
> **name** `string`
>
> Name or description displayed for the checklist item.
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **job\_uuid** `string`
>
> UUID of the job this checklist item belongs to.
>
> **item\_type** `string ("Todo" | "Asset" | "Photo" | "Form" | "Document")`
>
> Checklist item type. ServiceM8 defaults this to 'Todo' when omitted.
>
> **sort\_order** `integer`
>
> Display order; lower values appear first.
>
> **section\_name** `string`
>
> Section or category under which the checklist item is grouped.
>
> **reminder\_data** `string`
>
> Additional settings for an absolute or relative date-time reminder.
>
> **reminder\_type** `string ("" | "CHECK_IN" | "NAVIGATE" | "CHECK_OUT" | "ABSOLUTE_DATETIME" | "RELATIVE_DATETIME")`
>
> Event or date calculation that triggers the reminder; empty means none.
>
> **regarding\_object** `string`
>
> Type of object related to this checklist item, such as 'Form'.
>
> **completed\_timestamp** `string`
>
> Completion date and time. Empty or '0000-00-00 00:00:00' means not completed.
>
> **regarding\_object\_uuid** `string`
>
> UUID of the object related to this checklist item.
>
> **assigned\_to\_staff\_uuids** `array`
>
> Staff UUIDs assigned to the item; ServiceM8 currently allows at most one.
>
> **completed\_by\_staff\_uuid** `string`
>
> UUID of the completing staff member, or empty when not completed.
>
> **fulfilled\_by\_object\_name** `string`
>
> Type of object that completes this checklist item.
>
> **fulfilled\_by\_object\_uuid** `string`
>
> UUID of the object that completes this checklist item.
>
> **completed\_during\_checkin\_uuid** `string`
>
> UUID of the job check-in during which the item was completed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Contact
>
> **Slug:** `SERVICEM8_CREATE_JOB_CONTACT`
>
> Add a contact to a ServiceM8 job and return its created UUID.
>
> #### Input Parameters
>
> **last** `string`
>
> Last name of the job contact.
>
> **type** `string ("JOB" | "Job Contact" | "BILLING" | "Billing Contact" | "Property Manager")`
>
> Contact relationship type: JOB, BILLING, or Property Manager.
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **email** `string`
>
> Email address used for job-related communications.
>
> **first** `string`
>
> First name of the job contact.
>
> **phone** `string`
>
> Landline or office phone number of the job contact.
>
> **mobile** `string`
>
> Mobile phone number of the job contact.
>
> **job\_uuid** `string`
>
> UUID of the valid job this contact is associated with.
>
> **is\_primary\_contact** `string`
>
> Deprecated provider field indicating the primary contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Job Material
>
> **Slug:** `SERVICEM8_CREATE_JOB_MATERIAL`
>
> Add a material line to a ServiceM8 job and return its created UUID.
>
> #### Input Parameters
>
> **cost** `string`
>
> Material cost excluding tax, represented as a string.
>
> **name** `string`
>
> Material name displayed on invoices and quotes.
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **price** `string`
>
> Unit price excluding tax, represented as a string.
>
> **job\_uuid** `string`
>
> UUID of the job this material line is associated with.
>
> **quantity** `string` *required*
>
> Quantity of the material used on the job.
>
> **sort\_order** `string`
>
> Display order for the material line, represented as a string.
>
> **material\_uuid** `string`
>
> UUID of the catalog material this line is based on.
>
> **tax\_rate\_uuid** `string`
>
> UUID of the tax rate applied to this material line.
>
> **displayed\_cost** `string`
>
> Material cost displayed as tax-inclusive or tax-exclusive, represented as a string.
>
> **displayed\_amount** `string`
>
> Unit price displayed on invoices and quotes, represented as a string.
>
> **job\_material\_bundle\_uuid** `string`
>
> UUID of the job material bundle containing this line.
>
> **displayed\_amount\_is\_tax\_inclusive** `boolean`
>
> Whether displayed\_amount includes tax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ServiceM8 Create Job Note
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **note** `string` *required*
>
> Content of the note.
>
> **uuid** `string`
>
> Unique identifier for this note record. If omitted, a UUID will be generated.
>
> **active** `integer`
>
> Record active flag: 1 = active (default), 0 = deleted.
>
> **create\_date** `string`
>
> Timestamp when the note was created (format: YYYY-MM-DD HH:MM:SS). Server sets automatically if omitted.
>
> **related\_object** `string`
>
> Type of the related object. Defaults to 'job' for job notes. Other possible values may include 'company'.
>
> **action\_required** `string`
>
> Optional follow-up action required description.
>
> **related\_object\_uuid** `string` *required*
>
> UUID of the related job.
>
> **action\_completed\_by\_staff\_uuid** `string`
>
> UUID of staff member who completed the required action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ServiceM8 Create Job Payment
>
> **Slug:** `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."
>
> #### Input Parameters
>
> **note** `string`
>
> Additional notes or comments regarding the payment.
>
> **uuid** `string`
>
> Optional UUID for the payment record. If omitted, a UUID will be auto-generated by the server.
>
> **active** `integer`
>
> Record active flag: 1 = active (default), 0 = archived/deleted.
>
> **amount** `string` *required*
>
> Amount of the payment as a decimal string (e.g., '100.00', '50.50'). Use string format to preserve decimal precision.
>
> **method** `string` *required*
>
> Payment method used. Common values: 'cash', 'credit\_card', 'eftpos', 'cheque', 'bank\_transfer', 'online'.
>
> **job\_uuid** `string` *required*
>
> UUID of the job to record the payment against. Obtain this from list\_all\_jobs or create\_job actions.
>
> **edit\_date** `string`
>
> Timestamp of last edit in 'YYYY-MM-DD HH:MM:SS' format. Usually auto-set by the server if omitted.
>
> **timestamp** `string` *required*
>
> Timestamp when the payment was received in 'YYYY-MM-DD HH:MM:SS' format.
>
> **is\_deposit** `integer`
>
> Deposit flag: 1 = this payment is a deposit, 0 = regular payment (default if omitted).
>
> **attachment\_uuid** `string`
>
> UUID of any attachment (e.g., receipt image) related to the payment.
>
> **actioned\_by\_uuid** `string`
>
> UUID of the staff member who recorded/processed the payment. Obtain from staff endpoints. If omitted, may default to the authenticated user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a new Job
>
> **Slug:** `SERVICEM8_CREATE_JOBS`
>
> Create a new ServiceM8 job and retrieve its saved record. The job may be created even if the subsequent retrieval fails.
>
> #### Input Parameters
>
> **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 ("Quote" | "Work Order" | "Unsuccessful" | "Completed")` *required*
>
> Current status of the job. Controls dispatch board placement.
>
> **queue\_uuid** `string`
>
> UUID of the queue to assign this job to.
>
> **job\_address** `string` *required*
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Material
>
> **Slug:** `SERVICEM8_CREATE_MATERIAL`
>
> Create a ServiceM8 material catalog record and return its UUID.
>
> #### Input Parameters
>
> **cost** `string`
>
> Purchase cost of the material.
>
> **name** `string` *required*
>
> Name of the material, product, or labour rate.
>
> **uuid** `string`
>
> Optional UUID for the new record. ServiceM8 generates one when omitted.
>
> **price** `string`
>
> Selling price of the material.
>
> **barcode** `string`
>
> UPC, EAN, or other barcode for the material.
>
> **item\_number** `string`
>
> Unique item number for the material, up to 30 characters.
>
> **tax\_rate\_uuid** `string`
>
> UUID of the default tax rate for the material.
>
> **item\_description** `string`
>
> Description of the material.
>
> **quantity\_in\_stock** `string`
>
> Current quantity of the material in stock.
>
> **item\_is\_inventoried** `integer ("0" | "1")`
>
> Whether inventory tracking is enabled: 1 for yes, 0 for no.
>
> **price\_includes\_taxes** `integer ("0" | "1")`
>
> Whether price and cost include tax: 1 for yes, 0 for no.
>
> **use\_description\_for\_invoicing** `string`
>
> Provider value controlling use of the description for invoicing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ServiceM8 Create Task
>
> **Slug:** `SERVICEM8_CREATE_TASK`
>
> Create a ServiceM8 task, optionally related to another ServiceM8 record.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Task title.
>
> **uuid** `string`
>
> Caller-provided UUID for the task. If omitted, ServiceM8 generates one.
>
> **due\_date** `string`
>
> Date by which the task should be completed, in YYYY-MM-DD format.
>
> **create\_date** `string`
>
> Task creation timestamp in YYYY-MM-DD HH:MM:SS format.
>
> **task\_details** `string`
>
> Instructions, details, or other notes for completing the task.
>
> **task\_complete** `string ("0" | "1")`
>
> Completion flag: '0' for pending or '1' for complete.
>
> **related\_object** `string`
>
> ServiceM8 object class related to the task, such as 'job' or 'client'. Supply together with related\_object\_uuid.
>
> **completed\_timestamp** `string`
>
> Completion timestamp in YYYY-MM-DD HH:MM:SS format.
>
> **related\_object\_uuid** `string`
>
> UUID of the related ServiceM8 record. Supply together with related\_object.
>
> **created\_by\_staff\_uuid** `string`
>
> UUID of the staff member creating the task.
>
> **assigned\_to\_staff\_uuid** `string`
>
> UUID of the staff member assigned to complete the task.
>
> **completed\_by\_staff\_uuid** `string`
>
> UUID of the staff member who completed the task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Field
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> The UUID of the custom field to delete. Must be a valid UUID string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Job Activity
>
> **Slug:** `SERVICEM8_DELETE_JOB_ACTIVITY`
>
> Archive a ServiceM8 job activity by UUID. ServiceM8 deletion is reversible: it sets the activity's `active` field to 0, hiding the record in the UI while leaving it accessible through the API. Restore the activity by updating `active` to 1.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job activity to archive (soft-delete).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Job Note
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job note to delete. Example: '123e4567-e89b-12d3-a456-426614174000'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Job Payment
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Assets
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **filter** `string`
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Clients
>
> **Slug:** `SERVICEM8_LIST_ALL_CLIENTS`
>
> Tool to list all ServiceM8 clients. Use when you need a complete set of customer records for integrations or reporting.
>
> #### Input Parameters
>
> **filter** `string`
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Document Templates
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **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`
>
> OData-style filter expression to narrow document templates. Examples: 'name eq "Invoice"', 'active eq 1', 'template\_type eq "Quote"'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Forms
>
> **Slug:** `SERVICEM8_LIST_ALL_FORMS`
>
> List ServiceM8 form templates, optionally using an OData-style filter to narrow the results.
>
> #### Input Parameters
>
> **filter** `string`
>
> 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'".
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Job Notes
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **cursor** `string`
>
> 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`
>
> 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).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Job Queues
>
> **Slug:** `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).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Jobs
>
> **Slug:** `SERVICEM8_LIST_ALL_JOBS`
>
> Tool to list all jobs. Use when you need to fetch all job records from your ServiceM8 account.
>
> #### Input Parameters
>
> **filter** `string`
>
> 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'".
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Locations
>
> **Slug:** `SERVICEM8_LIST_ALL_LOCATIONS`
>
> Lists all ServiceM8 locations. Use to fetch configured service areas, office locations, or warehouses for job assignments, mapping, or reporting.
>
> #### Input Parameters
>
> **filter** `string`
>
> Optional filter expression to narrow down locations using ServiceM8 filtering syntax (e.g., 'active eq 1'). See ServiceM8 filtering docs for syntax details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Materials
>
> **Slug:** `SERVICEM8_LIST_ALL_MATERIALS`
>
> List ServiceM8 materials, including products, labour rates and inventory items, with optional filtering; requires the 'read\_inventory' OAuth scope. Numeric zero active flags are returned as active.
>
> #### Input Parameters
>
> **filter** `string`
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Tasks
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **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`
>
> 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'"
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attachments
>
> **Slug:** `SERVICEM8_LIST_ATTACHMENTS`
>
> List ServiceM8 attachment metadata with filtering and cursor pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Contacts
>
> **Slug:** `SERVICEM8_LIST_COMPANY_CONTACTS`
>
> List company contacts, optionally narrowed by an OData filter.
>
> #### Input Parameters
>
> **filter** `string`
>
> OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with 'and' and quote string values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Form Responses
>
> **Slug:** `SERVICEM8_LIST_FORM_RESPONSES`
>
> List submitted ServiceM8 form responses with filtering and pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Activities
>
> **Slug:** `SERVICEM8_LIST_JOB_ACTIVITIES`
>
> List and filter ServiceM8 job activities with cursor pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Allocations
>
> **Slug:** `SERVICEM8_LIST_JOB_ALLOCATIONS`
>
> List ServiceM8 job allocations, optionally filtered by public fields.
>
> #### Input Parameters
>
> **filter** `string`
>
> OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with 'and' and quote string values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Categories
>
> **Slug:** `SERVICEM8_LIST_JOB_CATEGORIES`
>
> List job categories, optionally narrowed by an OData filter.
>
> #### Input Parameters
>
> **filter** `string`
>
> OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with 'and' and quote string values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Checklists
>
> **Slug:** `SERVICEM8_LIST_JOB_CHECKLISTS`
>
> List ServiceM8 job checklist items with filtering and cursor pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Contacts
>
> **Slug:** `SERVICEM8_LIST_JOB_CONTACTS`
>
> List contacts linked to ServiceM8 jobs, with filtering and cursor pagination.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Materials
>
> **Slug:** `SERVICEM8_LIST_JOB_MATERIALS`
>
> List material assignments on ServiceM8 jobs.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor. Pass the next\_cursor from a previous response; use '-1' to begin explicit cursor pagination.
>
> **filter** `string`
>
> ServiceM8 filter expression. Supported operators are eq, ne, gt, and lt; strings use single quotes and up to 10 conditions may be joined with 'and'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Payments
>
> **Slug:** `SERVICEM8_LIST_JOB_PAYMENTS`
>
> List, filter, and cursor-page ServiceM8 job payments.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor. Use '-1' for the first page, then pass the next\_cursor returned by the previous call.
>
> **filter** `string`
>
> Filter records using ServiceM8 public field names and the eq, ne, gt, or lt operators. Combine up to 10 conditions with 'and' and enclose string values in single quotes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Staff Members
>
> **Slug:** `SERVICEM8_LIST_STAFF`
>
> List staff members, optionally narrowed by an OData filter.
>
> #### Input Parameters
>
> **filter** `string`
>
> OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with 'and' and quote string values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Vendors
>
> **Slug:** `SERVICEM8_LIST_VENDORS`
>
> List vendor accounts, optionally narrowed by an OData filter.
>
> #### Input Parameters
>
> **filter** `string`
>
> OData filter using public API field names and eq, ne, gt, or lt. Combine up to 10 conditions with 'and' and quote string values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve ServiceM8 Client
>
> **Slug:** `SERVICEM8_RETRIEVE_CLIENT`
>
> Tool to retrieve details of a specific client by its UUID. Use after confirming the client's UUID is valid.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the company (client) to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Contact
>
> **Slug:** `SERVICEM8_RETRIEVE_COMPANY_CONTACT`
>
> Retrieve one ServiceM8 company contact by its UUID.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the company contact to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Form
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> The unique identifier (UUID) of the form to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Job
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> The UUID of the job to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Job Activity
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the ServiceM8 job activity to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Contact
>
> **Slug:** `SERVICEM8_RETRIEVE_JOB_CONTACT`
>
> Retrieve one ServiceM8 job contact by its UUID.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job contact to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Material
>
> **Slug:** `SERVICEM8_RETRIEVE_JOB_MATERIAL`
>
> Retrieve one ServiceM8 job material line item by its UUID.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job material line item to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Job Note
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job note to retrieve. You can obtain this from the 'List All Job Notes' action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Job Payment
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> 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').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Job Queue
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job queue to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Location
>
> **Slug:** `SERVICEM8_RETRIEVE_LOCATION`
>
> Retrieve a ServiceM8 location by UUID, including available address, geographic coordinates, contact phone number, and active status.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> The unique identifier (UUID) of the location to retrieve. Must be a valid 36-character UUID string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve ServiceM8 Material
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the material to retrieve. Obtain this from the 'List All Materials' action or from job material records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Staff Member
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> The unique identifier (UUID) of the staff member to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ServiceM8 Client
>
> **Slug:** `SERVICEM8_UPDATE_CLIENT`
>
> Update a ServiceM8 client by UUID, requiring the client name, and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Updated company name
>
> **uuid** `string` *required*
>
> UUID of the existing client to update; used in the request path
>
> **badges** `array`
>
> Badge UUIDs to associate with the client
>
> **address** `string`
>
> Updated complete company address
>
> **website** `string`
>
> Updated company website
>
> **body\_uuid** `string`
>
> Optional UUID to send in the update body as the client's uuid field
>
> **abn\_number** `string`
>
> Updated Australian Business Number
>
> **fax\_number** `string`
>
> Updated fax number
>
> **address\_city** `string`
>
> Updated city or suburb
>
> **address\_state** `string`
>
> Updated state, territory, or province
>
> **payment\_terms** `string`
>
> Updated payment terms
>
> **tax\_rate\_uuid** `string`
>
> UUID of the tax rate associated with the client
>
> **address\_street** `string`
>
> Updated street address
>
> **address\_country** `string`
>
> Updated country
>
> **billing\_address** `string`
>
> Updated complete billing address
>
> **deposit\_percent** `integer`
>
> Updated deposit percentage
>
> **address\_postcode** `string`
>
> Updated postal or ZIP code
>
> **billing\_attention** `string`
>
> Updated billing attention name
>
> **parent\_company\_uuid** `string`
>
> UUID of the parent Company, or blank for a Head Office
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Company Contact
>
> **Slug:** `SERVICEM8_UPDATE_COMPANY_CONTACT`
>
> Partially update a company contact by UUID and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.
>
> #### Input Parameters
>
> **last** `string`
>
> Updated last name.
>
> **type** `string`
>
> Updated contact type, such as BILLING or JOB.
>
> **uuid** `string` *required*
>
> UUID of the existing company contact to update; used in the request path.
>
> **email** `string`
>
> Updated email address.
>
> **first** `string`
>
> Updated first name.
>
> **phone** `string`
>
> Updated phone number.
>
> **mobile** `string`
>
> Updated mobile number.
>
> **body\_uuid** `string`
>
> Optional UUID to send in the update body as the contact's uuid field.
>
> **company\_uuid** `string`
>
> UUID of the company this contact belongs to.
>
> **is\_primary\_contact** `string`
>
> Provider string flag: 1 for the primary contact and 0 otherwise.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ServiceM8 Job
>
> **Slug:** `SERVICEM8_UPDATE_JOB`
>
> Update a ServiceM8 job by UUID, requiring a job status, and retrieve the saved record. The update may succeed even if the subsequent retrieval fails.
>
> #### Input Parameters
>
> **date** `string`
>
> Updated job date in YYYY-MM-DD format
>
> **uuid** `string` *required*
>
> UUID of the existing job to update; used in the request path
>
> **badges** `array`
>
> Badge UUIDs to associate with the job
>
> **status** `string ("Quote" | "Work Order" | "Unsuccessful" | "Completed")` *required*
>
> Updated job status
>
> **queue\_uuid** `string`
>
> UUID of the queue assigned to the job
>
> **quote\_date** `string`
>
> Updated timestamp when the job became a quote
>
> **quote\_sent** `integer`
>
> Whether a quote has been sent: 1 or 0
>
> **job\_address** `string`
>
> Updated physical job address
>
> **company\_uuid** `string`
>
> UUID of the client associated with the job
>
> **invoice\_date** `string`
>
> Updated invoice issue timestamp
>
> **invoice\_sent** `integer`
>
> Whether an invoice has been sent: 1 or 0
>
> **category\_uuid** `string`
>
> UUID of the job category
>
> **billing\_address** `string`
>
> Updated billing address
>
> **completion\_date** `string`
>
> Updated completion timestamp in YYYY-MM-DD HH:MM:SS format
>
> **job\_description** `string`
>
> Updated description of the work to perform
>
> **work\_order\_date** `string`
>
> Updated timestamp when the job became a work order
>
> **payment\_received** `integer`
>
> Whether full payment was received: 1 or 0
>
> **payment\_processed** `integer`
>
> Whether the job has been exported to accounting: 1 or 0
>
> **queue\_expiry\_date** `string`
>
> Updated queue expiry timestamp
>
> **unsuccessful\_date** `string`
>
> Updated timestamp when the job became unsuccessful
>
> **created\_by\_staff\_uuid** `string`
>
> UUID of the staff member recorded as creating the job
>
> **purchase\_order\_number** `string`
>
> Updated client purchase order reference
>
> **work\_done\_description** `string`
>
> Updated description of work completed
>
> **queue\_assigned\_staff\_uuid** `string`
>
> UUID of the staff member assigned to the queued job
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Activity
>
> **Slug:** `SERVICEM8_UPDATE_JOB_ACTIVITY`
>
> Update a known job activity and return it. Provide at least one field to update.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> UUID of the job activity to update.
>
> **end\_date** `string`
>
> Scheduled end date and time in YYYY-MM-DD HH:MM:SS format.
>
> **job\_uuid** `string`
>
> UUID of the job this activity belongs to.
>
> **staff\_uuid** `string`
>
> UUID of the staff member assigned to this activity.
>
> **start\_date** `string`
>
> Scheduled start date and time in YYYY-MM-DD HH:MM:SS format.
>
> **material\_uuid** `string`
>
> UUID of the material associated with this activity.
>
> **has\_been\_opened** `string`
>
> Flag indicating whether the assigned staff member opened it.
>
> **activity\_was\_recorded** `string`
>
> Flag indicating whether the activity was recorded.
>
> **activity\_was\_automated** `string`
>
> Flag indicating whether the activity was automated.
>
> **activity\_was\_scheduled** `string`
>
> Flag indicating whether the activity was scheduled.
>
> **travel\_time\_in\_seconds** `integer`
>
> Estimated travel time to the activity in seconds.
>
> **has\_been\_opened\_timestamp** `string`
>
> Date and time the activity was first opened, in YYYY-MM-DD HH:MM:SS format.
>
> **travel\_distance\_in\_meters** `integer`
>
> Estimated travel distance to the activity in meters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Contact
>
> **Slug:** `SERVICEM8_UPDATE_JOB_CONTACT`
>
> Update selected fields on a ServiceM8 job contact and return the saved record.
>
> #### Input Parameters
>
> **last** `string`
>
> Last name of the job contact.
>
> **type** `string ("JOB" | "Job Contact" | "BILLING" | "Billing Contact" | "Property Manager")`
>
> Contact role: JOB or Job Contact, BILLING or Billing Contact, or Property Manager.
>
> **uuid** `string` *required*
>
> UUID of the job contact to update.
>
> **email** `string`
>
> Email address of the job contact.
>
> **first** `string`
>
> First name of the job contact.
>
> **phone** `string`
>
> Landline or office phone number of the job contact.
>
> **mobile** `string`
>
> Mobile phone number of the job contact.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Material
>
> **Slug:** `SERVICEM8_UPDATE_JOB_MATERIAL`
>
> Update an existing material line assigned to a ServiceM8 job.
>
> #### Input Parameters
>
> **cost** `string`
>
> Material cost excluding tax, represented as a string.
>
> **name** `string`
>
> Material name displayed on invoices and quotes.
>
> **uuid** `string` *required*
>
> UUID of the job material to update.
>
> **price** `string`
>
> Unit price excluding tax, represented as a string.
>
> **job\_uuid** `string`
>
> UUID of the job this material line is associated with.
>
> **quantity** `string` *required*
>
> Quantity of the material used on the job. ServiceM8 requires this field for updates.
>
> **sort\_order** `string`
>
> Display order for the material line, represented as a string.
>
> **material\_uuid** `string`
>
> UUID of the catalog material this line is based on.
>
> **tax\_rate\_uuid** `string`
>
> UUID of the tax rate applied to this material line.
>
> **displayed\_cost** `string`
>
> Displayed material cost, represented as a string.
>
> **displayed\_amount** `string`
>
> Unit price displayed on invoices and quotes, represented as a string.
>
> **job\_material\_bundle\_uuid** `string`
>
> UUID of the job material bundle containing this line, or an empty string to remove it from a bundle.
>
> **displayed\_amount\_is\_tax\_inclusive** `string`
>
> Provider string flag indicating whether displayed\_amount includes tax.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update a ServiceM8 Job Note
>
> **Slug:** `SERVICEM8_UPDATE_JOB_NOTE`
>
> Tool to update details of an existing job note. Use when modifying a note after its creation.
>
> #### Input Parameters
>
> **note** `string`
>
> New content for the job note
>
> **uuid** `string` *required*
>
> UUID of the job note to update
>
> **active** `integer`
>
> Active flag: 1=active, 0=archived
>
> **edit\_date** `string`
>
> Timestamp when the note was last edited in 'YYYY-MM-DD HH:MM:SS' format
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Payment
>
> **Slug:** `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.
>
> #### Input Parameters
>
> **note** `string`
>
> Note or memo for the payment
>
> **uuid** `string` *required*
>
> UUID of the job payment record to update (required)
>
> **active** `integer`
>
> Active status: 1=active, 0=archived/deleted
>
> **amount** `string`
>
> New payment amount as a decimal string (e.g., '150.00')
>
> **method** `string`
>
> Payment method: 'cash', 'credit\_card', 'eftpos', 'cheque', 'direct\_deposit', or 'other'
>
> **timestamp** `string`
>
> Payment date/time in 'YYYY-MM-DD HH:MM:SS' format
>
> **is\_deposit** `integer`
>
> Whether this is a deposit: 1=deposit, 0=regular payment
>
> **attachment\_uuid** `string`
>
> UUID of an attachment (e.g., receipt image) linked to this payment
>
> **actioned\_by\_uuid** `string`
>
> UUID of the staff member who recorded or updated the payment
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ServiceM8 Job Queue
>
> **Slug:** `SERVICEM8_UPDATE_JOB_QUEUE`
>
> Update a ServiceM8 job queue and return its saved provider record.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated job queue name
>
> **uuid** `string` *required*
>
> UUID of the existing job queue to update; used in the request path
>
> **subscribed\_staff** `string`
>
> Updated semicolon-delimited list of subscribed staff UUIDs
>
> **default\_timeframe** `integer`
>
> Updated default timeframe in days
>
> **requires\_assignment** `integer`
>
> Whether jobs require assignment: 1 for yes, 0 for no
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update ServiceM8 Material
>
> **Slug:** `SERVICEM8_UPDATE_MATERIAL`
>
> Update an inventory material by UUID, requiring its name, and return its saved provider record.
>
> #### Input Parameters
>
> **cost** `string`
>
> Updated purchase or internal cost as a decimal string
>
> **name** `string` *required*
>
> Updated material name
>
> **uuid** `string` *required*
>
> UUID of the existing material to update; used in the request path
>
> **price** `string`
>
> Updated selling price as a decimal string
>
> **barcode** `string`
>
> Updated barcode
>
> **item\_number** `string`
>
> Updated item or SKU number
>
> **tax\_rate\_uuid** `string`
>
> UUID of the default tax rate for the material
>
> **item\_description** `string`
>
> Updated material description
>
> **quantity\_in\_stock** `number`
>
> Updated inventory quantity in stock
>
> **item\_is\_inventoried** `integer`
>
> Whether inventory tracking is enabled: 1 for yes, 0 for no
>
> **price\_includes\_taxes** `integer`
>
> Whether the selling price includes tax: 1 for yes, 0 for no
>
> **use\_description\_for\_invoicing** `string`
>
> Updated description setting used for invoicing
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] ServiceM8 Update Task
>
> **Slug:** `SERVICEM8_UPDATE_TASK`
>
> Update a ServiceM8 task by UUID, requiring its name, and return the saved record.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New task title.
>
> **uuid** `string` *required*
>
> UUID of the task to update.
>
> **due\_date** `string`
>
> New due date in YYYY-MM-DD format.
>
> **create\_date** `string`
>
> Task creation timestamp in YYYY-MM-DD HH:MM:SS format.
>
> **task\_details** `string`
>
> New instructions, details, or notes for the task.
>
> **task\_complete** `string ("0" | "1")`
>
> New completion flag: '0' for pending or '1' for complete.
>
> **related\_object** `string`
>
> New related ServiceM8 object class, such as 'job' or 'client'.
>
> **completed\_timestamp** `string`
>
> New completion timestamp in YYYY-MM-DD HH:MM:SS format.
>
> **related\_object\_uuid** `string`
>
> UUID of the new related ServiceM8 record.
>
> **created\_by\_staff\_uuid** `string`
>
> UUID of the staff member who created the task.
>
> **assigned\_to\_staff\_uuid** `string`
>
> UUID of the staff member newly assigned to complete the task.
>
> **completed\_by\_staff\_uuid** `string`
>
> UUID of the staff member who completed the task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
