NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Servicem8

servicem8

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

Scheduling & BookingProposal & Invoice ManagementWeb del proveedor
Acciones
28
Triggers
0
Autenticación
—
OAuth gestionado
Sí
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (28)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

ServiceM8 Create Job NoteSERVICEM8_CREATE_JOB_NOTEAcción

Tool to create a new job note in servicem8. use when you need to attach additional information to a specific job after obtaining its uuid.

Parámetros de entrada

  • notestringObligatorio

    Content of the note.

  • uuidstring

    Unique identifier for this note record. If omitted, a UUID will be generated.

  • activeinteger

    Record active flag: 1 = active (default), 0 = deleted.

  • create_datestring

    Timestamp when record was last modified (ISO 8601). Server overrides if omitted.

  • related_objectstringObligatorio

    Type of the related object. Use 'job' for job notes.

  • action_requiredstring

    Optional follow-up action required description.

  • related_object_uuidstringObligatorio

    UUID of the related job.

  • action_completed_by_staff_uuidstring

    UUID of staff member who completed the required action.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

ServiceM8 Create Job PaymentSERVICEM8_CREATE_JOB_PAYMENTAcción

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

Parámetros de entrada

  • notestring

    Additional notes regarding the payment.

  • uuidstring

    Optional unique identifier for the job payment.

  • activeintegerObligatorioenum

    1 if the payment is active; 0 if archived.

    01
  • amountstringObligatorio

    Amount of the payment.

  • methodstringObligatorio

    Payment method used.

  • job_uuidstringObligatorio

    UUID of the associated job.

  • edit_datestringObligatorio

    Timestamp of last edit in 'YYYY-MM-DD HH:MM:SS' format.

  • timestampstringObligatorio

    Timestamp of the payment in 'YYYY-MM-DD HH:MM:SS' format.

  • is_depositintegerenum

    1 if this payment is a deposit; 0 otherwise.

    01
  • attachment_uuidstring

    UUID of any attachment related to the payment.

  • actioned_by_uuidstringObligatorio

    UUID of the staff member who actioned the payment.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create a new JobSERVICEM8_CREATE_JOBSAcción

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

Parámetros de entrada

  • datestring

    Date the job is scheduled or created (YYYY-MM-DD).

  • activeinteger

    Active flag (1 = active, 0 = deleted). Defaults to 1.

  • badgesstring[]

    List of badge UUIDs to apply (comma-separated).

  • statusstringObligatorioenum

    Current status of the job. Controls dispatch board placement.

    QuoteWork OrderUnsuccessfulCompleted
  • queue_uuidstring

    UUID of the queue to assign this job to.

  • job_addressstringObligatorio

    Physical address where the job is to be performed.

  • company_uuidstring

    UUID of the customer/company associated with this job.

  • category_uuidstring

    UUID of the job category.

  • job_descriptionstring

    Brief description of the work to be done.

  • created_by_staff_uuidstring

    UUID of the staff member creating this job.

  • purchase_order_numberstring

    Client purchase order reference number.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Job NoteSERVICEM8_DELETE_JOB_NOTEAcción

Tool to delete a specific job note. use when you need to archive a note by its uuid.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the job note to delete. Example: '123e4567-e89b-12d3-a456-426614174000'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

ServiceM8 Delete Job PaymentSERVICEM8_DELETE_JOB_PAYMENTAcción

Tool to delete (archive) a specific job payment by its uuid. use when you need to archive a payment record.

Parámetros de entrada

  • uuidstringObligatorio

    The UUID of the job payment to delete (archive).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All AssetsSERVICEM8_LIST_ALL_ASSETSAcción

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

Parámetros de entrada

  • filterstring

    Filter expression to narrow down assets; use ServiceM8 filtering syntax, e.g., 'active eq 1'.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All ClientsSERVICEM8_LIST_ALL_CLIENTSAcción

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

Parámetros de entrada

  • filterstring

    Filter expression to narrow down clients; use ServiceM8 filtering syntax, e.g., 'active eq true'.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All Document TemplatesSERVICEM8_LIST_ALL_DOCUMENT_TEMPLATESAcción

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

Parámetros de entrada

  • limitinteger

    Maximum number of templates to return (must be ≥1).

  • filterstring

    Filter expression to narrow document templates; use ServiceM8 filtering syntax, e.g., 'name eq "Invoice"'.

  • offsetinteger

    Number of templates to skip before returning results (must be ≥0).

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All FormsSERVICEM8_LIST_ALL_FORMSAcción

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

Parámetros de entrada

  • filterstring

    Filter expression to narrow down forms; use ServiceM8 filtering syntax, e.g., 'active eq true'.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All Job NotesSERVICEM8_LIST_ALL_JOB_NOTESAcción

Tool to list all job notes in servicem8. use when you need to fetch notes, optionally filtered or paginated.

Parámetros de entrada

  • limitinteger

    Maximum number of notes to return (must be >=1).

  • filterstring

    ServiceM8 OData filter expression; only one filter per request.

  • offsetinteger

    Number of notes to skip (must be >=0).

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All Job QueuesSERVICEM8_LIST_ALL_JOB_QUEUESAcción

Tool to list all job queues in servicem8. use when you need to fetch configured queues before dispatching jobs.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All JobsSERVICEM8_LIST_ALL_JOBSAcción

Tool to list all jobs. use when you need to fetch all job records from your servicem8 account.

Parámetros de entrada

  • filterstring

    Filter criteria to narrow down jobs. Use ServiceM8 filtering syntax, e.g. "status='Completed'".

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All LocationsSERVICEM8_LIST_ALL_LOCATIONSAcción

Tool to list all servicem8 locations. use when you need to fetch every configured location for assignments or mapping.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All MaterialsSERVICEM8_LIST_ALL_MATERIALSAcción

Tool to list all materials. use when you need a full inventory dump after authenticating with read inventory scope.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List All TasksSERVICEM8_LIST_ALL_TASKSAcción

Tool to list all tasks in a servicem8 account. use when you need to fetch task records, optionally filtered. requires 'read tasks' oauth scope.

Parámetros de entrada

  • limitinteger

    Maximum number of tasks to return (must be ≥1).

  • filterstring

    Filter expression to narrow task results; use OData syntax, e.g., "completed eq false".

  • offsetinteger

    Number of tasks to skip (must be ≥0).

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve ServiceM8 ClientSERVICEM8_RETRIEVE_CLIENTAcción

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

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the company (client) to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve FormSERVICEM8_RETRIEVE_FORMAcción

Tool to retrieve details of a specific form by its uuid. use when you need up-to-date form metadata given a known form uuid.

Parámetros de entrada

  • uuidanyObligatoriouuid

    The unique identifier (UUID) of the form to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve JobSERVICEM8_RETRIEVE_JOBAcción

Tool to retrieve details of a specific job by its uuid. use when you have the job uuid and need its full record.

Parámetros de entrada

  • uuidstringObligatorio

    The UUID of the job to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Job ActivitySERVICEM8_RETRIEVE_JOB_ACTIVITYAcción

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.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the ServiceM8 job activity to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Job NoteSERVICEM8_RETRIEVE_JOB_NOTEAcción

Tool to retrieve details of a specific job note by its uuid. use when you have the note uuid (e.g., after listing notes) and need its full record before processing or display.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the job note to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Job PaymentSERVICEM8_RETRIEVE_JOB_PAYMENTAcción

Tool to retrieve details of a specific job payment by its uuid. use when you have the payment uuid and need its full record and metadata.

Parámetros de entrada

  • uuidstringObligatorio

    The UUID of the job payment to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Job QueueSERVICEM8_RETRIEVE_JOB_QUEUEAcción

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

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the job queue to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve LocationSERVICEM8_RETRIEVE_LOCATIONAcción

Tool to retrieve details of a specific location by its uuid. use when you already have the location's uuid and need full location details.

Parámetros de entrada

  • uuidanyObligatoriouuid

    UUID of the ServiceM8 location to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve ServiceM8 MaterialSERVICEM8_RETRIEVE_MATERIALAcción

Tool to retrieve details of a specific material by its uuid. use when you have a material uuid and need current inventory or pricing details.

Parámetros de entrada

  • uuidstringObligatorio

    UUID of the material to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Staff MemberSERVICEM8_RETRIEVE_STAFF_MEMBERAcción

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.

Parámetros de entrada

  • uuidanyObligatoriouuid

    The unique identifier (UUID) of the staff member to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

ServiceM8 Create JobSERVICEM8_SERVICE_M8_CREATE_JOBAcción

Tool to create a new job in servicem8. use when you have all job details and need to push a record into servicem8. example: "create a quote job for 123 main st with po #1234."

Parámetros de entrada

  • datestring

    Date the job is scheduled or created (YYYY-MM-DD).

  • activeintegerenum

    Active flag (1=active, 0=deleted). Defaults to 1.

    01
  • badgesstring[]

    List of badge UUIDs to apply (visual indicators on dispatch board).

  • statusstringObligatorioenum

    Current status of the job (controls dispatch board placement).

    QuoteWork OrderUnsuccessfulCompleted
  • queue_uuidstring

    UUID of the queue to assign this job to.

  • job_addressstringObligatorio

    Physical address where the job is to be performed.

  • company_uuidstring

    UUID of the customer/company associated with this job.

  • category_uuidstring

    UUID of the job category (e.g., Plumbing, Electrical).

  • job_descriptionstring

    Brief description of the work to be done.

  • created_by_staff_uuidstring

    UUID of the staff member creating this job.

  • purchase_order_numberstring

    Client purchase order reference number.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update a ServiceM8 Job NoteSERVICEM8_UPDATE_JOB_NOTEAcción

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

Parámetros de entrada

  • notestring

    New content for the job note

  • uuidstringObligatorio

    UUID of the job note to update

  • activeinteger

    Active flag: 1=active, 0=archived

  • edit_datestring

    Timestamp when the note was last edited in 'YYYY-MM-DD HH:MM:SS' format

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

ServiceM8 Update Job PaymentSERVICEM8_UPDATE_JOB_PAYMENTAcción

Tool to update details of an existing job payment. use after confirming the payment uuid and desired changes.

Parámetros de entrada

  • notestring

    Optional note for the payment

  • uuidstringObligatorio

    UUID of the job payment to update

  • activeinteger

    Active flag: 1=active, 0=archived

  • amountstringObligatorio

    Amount of the payment

  • methodstring

    Payment method used, e.g., 'cash' or 'credit_card'

  • job_uuidstringObligatorio

    UUID of the associated job

  • edit_datestring

    Last edited timestamp in 'YYYY-MM-DD HH:MM:SS' format

  • timestampstring

    Payment timestamp in 'YYYY-MM-DD HH:MM:SS' format

  • is_depositinteger

    Deposit flag: 1=deposit, 0=not a deposit

  • attachment_uuidstring

    UUID of an attachment related to the payment

  • actioned_by_uuidstring

    UUID of the staff member who actioned the payment

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not