VH3 AI integration researchA little less busywork with VH3 AI.

Cancel a field service job. Requires the numeric job ID. Optional reason text. Use only when the job will not happen at all (otherwise prefer Set Job Result with completedWithIssues).

Create a new field service job. Requires a job type ID (from List Job Types) and a contact (customer/site) ID (from List Contacts). Returns the new job ID. Does not schedule it — call Schedule Job afterwards.

Create a job where custom fields are supplied as a pre-built JSON array from a previous node (e.g. a Code node). Useful for automated pipelines where custom field values are resolved dynamically at runtime rather than configured manually.

Add a scheduling rule to a job (e.g. must start before X, requires engineer Y or skill Z). Time-based types need constraintAt; resource/skill types need entityId. Used by the BigChange scheduler.

Plan or record stock/parts movement on a job (brought, used, taken back). Requires job ID; supply stockDetailsId or stockItemId plus an action and quantity.

Remove a scheduling constraint by its constraint ID (get it first via List Job Constraints)

Update fields on an existing job (description, reference, planned duration, person, order number, custom fields, office notes, isActioned, isFinanciallyComplete). Does not change schedule or status — use Schedule Job / Start Job / Set Job Result for those.

Get the FULL enriched view of one job (status history, assigned engineer, site address, custom fields, completed worksheet answers, attachments). Heavier payload — use this when an agent needs to summarise/answer questions about a specific job. For a quick lookup, use Get Job by ID instead.

Lightweight single-job lookup by numeric ID via the proxy. Optionally include worksheets. Faster and cheaper than Get Job — prefer this when you only need core job fields. Set Simplify=true to strip the deep BigChange envelope.

List all scheduling constraints currently attached to a job (pre-existing rules the scheduler must respect)

Get the full audit trail of status transitions for a job (new → scheduled → started → completedOk, etc.) with timestamps and actors. Use to debug "why is this job in this state?" or build a timeline.

List every stock/parts line attached to a job — what was planned, brought, used, or taken back

Primary search for jobs. REQUIRES a created-from / created-to UTC window. Filter by status (e.g. completedOk, scheduled, started), job type IDs, contact (customer/site) IDs, resource (engineer) IDs, vehicle IDs, or reference. Returns paginated job records. Default returnAll=false. Set Simplify=true to strip envelopes.

Assign an engineer (resource), vehicle, and/or planned start time to a job. Use after Create Job or to reassign. plannedStartAt is UTC ISO-8601.

Close a job by writing its completion outcome. Status MUST be completedOk or completedWithIssues. Optional result text and an override timestamp. After this call the job is treated as done.

Mark a job as started (engineer en-route/on-site). Optional comment (max 250 chars) and override timestamp. Cannot start an already-completed or cancelled job.

Create a new customer or site. Requires name, group ID, and lat/lng (lat/lng can be 0 if unknown but must be supplied). Optional address fields and parent contact ID for child sites.

Create a new contact group (folder/category for customers and sites). Requires only a name.

Update an existing contact (customer or site). Name, group, and lat/lng must be re-supplied even if unchanged. Address fields are optional.

Get one contact by numeric ID. Returns address, location, custom fields, group, status, parent linkage. Use this when an agent asks "what address is customer X at?" or "tell me about site Y".

Get one contact group by ID. Use to look up a group's name/metadata.

List all contact groups (the categories used to organise customers and sites). Useful for mapping group IDs to names.

Primary search for customers and sites. Filter by name (starts-with), reference, IDs, parent ID, group ID, or status (normal / contactOnStop / creditLimitOnStop). Supports paging. Use this whenever an agent needs to find a contact by name or list customers/sites.

Block a customer or site from new jobs/invoices. Choose contactOnStop (general hold) or creditLimitOnStop (account is over credit). Optional reason. Pick whether to cascade to child sites via Applies To.

Lift a stop on a customer or site so new jobs/invoices can be raised again. Pick whether to cascade to children via Applies To.

Rename an existing contact group. Provide the group ID and the new name.

Create a new engineer/technician/operative. Requires name and groupId (team). Optional email, mobile, reference. Returns the new resource ID for use in Schedule Job.

Get one engineer by numeric ID — name, group/team, contact details, reference. Use to look up an engineer's profile.

Get one resource group (team) by ID. Use to map a group ID to its name.

List the teams that engineers belong to (e.g. "North region", "Senior techs"). Use as a lookup before listing/creating resources.

List every engineer/technician/operative on the books. Use whenever an agent needs to find engineers, map names to IDs, or pick someone to assign a job to.

Update fields on an existing engineer record (name, group/team, email, mobile, reference). Only supplied fields are changed.

Get one job type definition by numeric ID — name, default duration, custom field schema, configuration. Use to discover what custom fields a job of this type accepts.

List every job type/template (e.g. installation, repair, maintenance, callout). Required reference data before Create Job — use this to find the right typeId.

Add a new vehicle to the fleet. Requires groupId, vehicleType (e.g. van, car, truck), registration. Optional make, model, registrationYear, reference, fixedResourceId (driver).

Get one vehicle by numeric ID — registration, make, model, year, group, fixed driver. Use to look up a vehicle from a job.

List all fleet vehicles. Use as a lookup before scheduling jobs to a vehicle, or to find the registration/make of an asset.

Update fields on a vehicle (group, type, registration, make, model, year, reference, fixed driver). Only supplied fields change.

Get one worksheet form template (the schema/blueprint) by numeric ID — title, group, version metadata. For the questions inside it, use Get Worksheet Questions.

List the questions/fields defined inside a worksheet template (text, multiple choice, photo, signature). Use to map a question ID to its label when interpreting answers.

Get completed worksheet submissions for one or more jobs — answers, photos, signatures, parts captured. Requires a comma-separated list of job IDs. Use when an agent needs to summarise what an engineer did or extract specific captured values.

List every worksheet form template (the blueprints engineers fill in on the mobile app). Use to discover available worksheets or map worksheet IDs to titles.

Get one worksheet group (folder) by numeric ID. Use to map a group ID to its name.

List the folders that organise worksheet templates. Use as a lookup before browsing worksheet definitions.

Cancel an invoice by ID. Use only for invoices that should not be paid (e.g. raised in error). Cancellation is permanent.

Raise a new invoice. Requires currencyCode (ISO 4217, e.g. GBP, USD, EUR). Link to a job, job group, OR contact via additional fields. Optionally set invoice date (createdAt), notes, bank account, department, nominal code. After creation, add lines via Create Invoice Line Item, then Mark Invoice Sent.

Add a billable line to an invoice. Requires invoiceId, contactId, description, quantity, unitCost, unitSellingPrice, taxId, nominalCodeId, departmentCodeId. Get tax/nominal/department code IDs from List Reference Data.

Remove a line item from an invoice (only valid before the invoice is sent/paid). Needs both invoiceId and lineItemId.

Update notes on an existing invoice (clientNotes shown to customer; internalNotes private). Cannot change currency, totals, or links — recreate for those changes.

Get a single invoice by numeric ID — totals, status, customer, links, tax breakdown. Use List Invoice Line Items for the lines.

Get one line on an invoice (description, qty, unit cost/price, tax, nominal, department). Needs both invoiceId and lineItemId.

List every line on an invoice (what was billed). Use to compute totals, audit a bill, or extract narrative for a customer email.

List invoices. BigChange requires at least one filter or a date range — if you supply none, the node defaults to the last 12 months. Filter by job ID(s), contact ID(s), reference, or createdAt window. Use to find recent/unpaid invoices, customer history, etc.

Record payment received on an invoice. Optional paidAt timestamp (UTC, defaults to now). Use after manual payment reconciliation.

Mark an invoice as issued/sent to the customer. Required before payment can be recorded. No fields beyond invoiceId.

Attach a note/task/comment to an entity. Requires entityType (job, contact, person, etc.), entityId, typeId (from List Note Types), and a subject. Optional description, dueAt (UTC), status, owner. Use for follow-ups, customer comms log, internal flags.

Append a progress comment to an existing note (does not modify the original). Use for status updates on tasks/follow-ups.

Update an existing note. All core fields (entityType, entityId, typeId, subject) must be re-supplied. Use to change status, due date, ownership, or content.

Get a single note by numeric ID — entity link, subject, description, status, owner, due date

Get one note type by ID. Use to map a note type ID to its display name and configuration.

List the available note types (categories). Required reference data before creating notes — pick the right typeId from here.

List notes. Filter by entityType + entityId (e.g. all notes on job 123), typeId(s), status, contactId, sort. Use to surface follow-ups, callback queues, or audit trails.

Create an individual contact at a customer/site (e.g. site manager, decision maker). Requires contactId (the parent customer/site), forename, surname. Optional title, email, mobile, landline, position, department, isOptedOut.

Update an existing person. forename and surname must be re-supplied. Use to update contact details, role, marketing opt-out status.

Get one person by their UUID (string) — name, role, contact details, parent contact, opt-out status

Audit trail of marketing-consent changes for a specific person (GDPR/CASL compliance). Requires personId (UUID).

List individual people. Filter by contactId(s) (find people at a customer/site), surname (starts-with), or email. Use to find the right person to contact at a customer.

Raise a new sales quote. Requires currencyCode (ISO 4217). Link to a job, job group, or contact via additional fields. Optional daysValidFor, custom fields, delivery site, and notes (clientNotes shown to customer; internalNotes private). Add lines via Create Quote Line Item, then Mark Quote Sent.

Add a priced line to a quote. Requires quoteId, contactId, description, quantity, unitCost, unitSellingPrice, taxId, nominalCodeId, departmentCodeId.

Remove a line from a quote. Needs both quoteId and lineItemId. Only valid before the quote is accepted.

Update notes, daysValidFor, delivery site, nominal/department codes, or custom fields on an existing quote. Cannot change currency or convert to invoice.

Update an existing line on a quote. All pricing fields (qty, unitCost, unitSellingPrice, taxId, nominalCodeId, departmentCodeId) and description must be supplied.

Get one quote by ID — totals, status, customer, validity, custom fields. Use List Quote Line Items for the priced lines.

Get one priced line on a quote (description, qty, unit cost/price, tax, nominal, department). Needs both quoteId and lineItemId.

List every priced line on a quote. Use to compute totals, generate a customer-facing breakdown, or audit pricing.

List quotes. BigChange requires at least one filter (ID/jobId/jobGroupId/contactId/reference) or a createdAt window — if none supplied, the node defaults to the last 12 months. Use for pipeline/conversion analysis or finding a customer's outstanding quote.

Customer accepted the quote — locks pricing and unblocks job/invoice creation against it

Customer rejected the quote. Closes the quote out of the active pipeline.

Mark a quote as issued/sent to the customer. Optional sentAt timestamp (UTC, defaults to now).

Add a priced line to a sales opportunity. Requires salesOpportunityId, contactId, description, quantity, unitCost, unitSellingPrice, taxId, nominalCodeId, departmentCodeId.

Remove a line from a sales opportunity. Needs both salesOpportunityId and lineItemId.

Update a sales opportunity (PATCH semantics — omit a field to keep its existing value)

Update an existing line on a sales opportunity (PATCH semantics — omit a field to keep its existing value)

Get one sales opportunity by ID — status, stage, probability, owner, contact, totals, custom fields. Use List Sales Opportunity Line Items for the priced lines.

Get one priced line on a sales opportunity. Needs both salesOpportunityId and lineItemId.

List configured sales opportunity probabilities (reference data — e.g. 25%, 50%, 75%)

List sales opportunities. BigChange requires at least one filter (ID/status/contactId/ownerId/reference) or a date window (createdAt or dueDate) — if none supplied, the node defaults to the last 12 months.

List every priced line on a sales opportunity. Use to compute weighted/forecast totals or audit pricing.

List configured sales opportunity pipeline stages (reference data — e.g. Qualified, Proposal, Negotiation, Closed Won)

Create a new purchase order. supplierId is required. Optionally link to a job, job group, or contact via additional fields.

Add a line to a purchase order. Requires purchaseOrderId, contactId, description, quantity, unitCost, unitSellingPrice, taxId, nominalCodeId, departmentCodeId.

Remove a line from a purchase order. Needs both purchaseOrderId and lineItemId.

Update a purchase order (PATCH semantics — omit a field to keep its existing value)

Update an existing line on a purchase order (PATCH semantics — omit a field to keep its existing value)

Get one purchase order by ID — supplier, status, totals, links, custom fields. Use List Purchase Order Line Items for the lines.

Get one line on a purchase order. Needs both purchaseOrderId and lineItemId.

Get a single purchase order series (numbering sequence) by ID

List every line on a purchase order. Use to compute totals or audit ordered goods.

List configured purchase order series (numbering sequences) — reference data

List purchase orders. BigChange requires at least one filter (ID/jobId/jobGroupId/contactId/reference) or a createdAt window — if none supplied, the node defaults to the last 12 months. Note: date-only filtering may return a BC 500 on some tenants — combine with ID[]/jobId[]/contactId[] when possible.

Create a job group (a folder/project that links multiple jobs together, e.g. a multi-day install). Requires contactId, isShownOnDevice, areJobsLinked, plannedStartOption, plannedEndOption. Optional title, planned start/end (UTC), category, order number.

Update fields on an existing job group (title, order number, planned start/end, category)

Get one job group by numeric ID — title, customer, planned dates, status, member jobs

Audit trail of status changes on a job group. Use to debug why a multi-job project is stuck.

List job groups (multi-job projects). Sort by created/title. Use for project pipeline views.

Force every job in the group into a "completed" state. Use when an entire multi-job project is done in one go (not common — usually each job is closed individually).

Lock the job group for finance — signals invoicing is finished. After this, no further invoices can be raised against the group.

Create a new stock product (SKU/template). Requires model and productCategoryId. Optional make, stockCode, batchNumber, isConsumable. This is the catalogue entry, NOT a physical unit — use Create Stock Item for those.

Create a physical stock unit (instance of a product). Requires stockDetailsId, model, productCategoryId. Optional serial number, condition, location contact, quantity. Use to register newly received inventory.

Get one product category by numeric ID. Use to map a category ID to a name when displaying stock.

Get one stock product definition by stockDetailsId — model, make, stock code, category, suppliers reference

Get one physical stock unit by stockItemId — serial number, condition, current location, quantity

Get one supplier link for a stock product. Needs both stockDetailsId and stockSupplierId.

List stock product categories (the top-level taxonomy of inventory). Filter by name (starts-with).

List stock product definitions. Filter by productCategoryId(s), stockCode(s), or isConsumable. Use to browse the SKU catalogue.

List physical stock units. Filter by stockDetailsId(s), serialNumber, or current locationContactId. Use to find what physical units exist of a given product or what's currently at a location.

List stock movement history (pickups/drop-offs). Filter by date ranges (pickUpAtFrom/To, dropOffAtFrom/To), jobId, stockDetailsId, stockItemId, vehicleId, dropOffContactId, dropOffVehicleId. Use for inventory audits and "where did this part go?" queries.

List suppliers linked to a specific stock product. Requires stockDetailsId.

Update fields on an existing stock product definition (model, category, make, stockCode, batchNumber, isConsumable)

Update fields on a physical stock unit (serial number, make, notes, quantity, location contact, condition)

Get one department code by ID — code and description. Use to map a departmentCodeId on a quote/invoice line to a human-readable label.

Get one nominal (accounting) code by ID — code and description. Use to map a nominalCodeId on a quote/invoice line to its accounting label.

List department codes (cost-centre codes used on quotes and invoices). Required reference data before Create Quote Line Item / Create Invoice Line Item.

List nominal (accounting) codes used on quotes and invoices. Required reference data before Create Quote Line Item / Create Invoice Line Item.

Generate a structured monthly account report aggregating jobs across the full parent–child contact hierarchy

Generate a structured pre-visit briefing and AI call script for a field service engineer heading to a job

Run up to 50 emails through the triage pipeline in a single call; portal/pre-filter hits are instant and only novel emails consume LLM tokens

Classify an incoming email using the AI triage pipeline

Run a general email through the full ingest pipeline via the /ingest/email/triage endpoint

Extract structured job data from an FM portal email via the /ingest/email/portal endpoint and resolve entities

Return the tenant's active triage categories with priority, destination, and prompt rules from the taxonomy database

Return the tenant's active email routing rules with full condition/action definitions; optionally filter by classification phase

Compute job metrics with grouping, time-axis control, and period-over-period comparison

Get a single job with worksheets, AI enrichment (vertical, sentiment, key phrases), and timing data

Paginated job feed scoped to a parent account and all its children. Pass any contact ID in the hierarchy — jobs for the entire account tree are returned.

Paginated list of AI-enriched jobs with filters for status, result, engineer, customer, job type, and category

Generate an AI-powered operational report (daily or weekly) with optional narrative summary

List all available report types and their sections

Quick fuzzy search across customers, engineers, jobs, persons, and sites

Retrieve all stored CustomerSummary sections for a single contact in one call

Search intake descriptions with enriched job context from the knowledge graph

Search intake descriptions without graph enrichment

Search job outcome and diagnostic summaries

Search job outcome summaries with Neo4j graph enrichment and optional date, status, and result filters

Semantic hybrid search across CustomerSummary knowledge base sections for one or all customers

Retrieve the cached results from the most recent sentinel run for your tenant

List all available sentinel definitions with their thresholds and recommended schedules

Run sentinel checks and return only triggered alerts

Link a job, customer, site, engineer, or other record to a case

Add a comment to a case activity timeline

Add a user as a participant. Roles are owner, investigator, reviewer, observer, and contributor.

Assign or clear the Case Assigned Team. Pass Team ID 0 to clear.

Create a new case in draft with title, type, and optional priority, tags, and metadata

Archive a case for audit. The record, linked items, and activity stay. Does not permanently delete or restore.

Get a single case with participants, items, and latest activity

Get the activity timeline for a case, paginated with newest first

List all items linked to a case, optionally filtered by item type

List cases for a company with filtering and pagination. Sorting is server-side. Omitted Scope, Sort, and Order use the FSI API defaults.

Reverse lookup — find all cases that reference a specific job, customer, site, or other item

Unlink an item from a case

Full-text search across case titles and descriptions with optional filters

Transition a case to an allowed next status. Invalid transitions fail with the permitted-next list.

Update selected case fields. Unselected fields are preserved. Adding an empty clearable field clears the current value. Actor ID is a Connect user ID; omit or 0 uses the API-key owner.

Get a cached business-health dashboard snapshot with pipeline, performance, workforce, and asset metrics

Get a weather forecast for a latitude/longitude

Get historical weather data for a latitude/longitude

Get weather data for a specific job by ID

Get weather data for a specific site by site key

Generate or regenerate intelligence profiles for a tenant

Get intelligence profile for a specific job type

List all intelligence profiles for a tenant

Multi-step hybrid investigation across vector and graph data

Send a message to the Connie AI assistant

Generate a Connie AI summary for a contact

Get messages for a specific chat session

List Connie chat sessions for a user or contact

Search across Connie conversation history

Soft-delete (archive) a user from the company

Send an email invitation to join the company

Get all pending (unaccepted) invitations for the company

Get all teams for a user with their role and default-team flag

Get all active users for the company

Change the role assigned to a user

Link a job, customer, site, engineer, or other record to a team

Add a user to a team with a specified role

Create a team with the tenant API key. Name required; optional purpose, description, and metadata. Connect UI edit of an existing team still requires team-lead or manager.

Get a single team with its members and entity links

List records linked to a team, optionally filtered by entity type

List all members of a team

List teams for the company. Optional purpose and Search filters are live tenant-key query params.

Reverse lookup — find all teams that include a specific job, customer, site, or other entity

Remove a linked entity from a team

Remove a membership record from a team

Full-text search across team names and descriptions. Live tenant-key operation, not Connect-UI-only.

Update team fields — only provided fields are changed

Get a single contact with an operational snapshot and optional customer summary

Paginated contact/customer feed with filters for search, group, reference, and account status

Get a single Quotient quotation by UUID or quote number

Paginated Quotient quotations with date-window and status filters

Persist a VH3-owned Quote Document after a Quote Run

Get one VH3-owned Quote Document by ID

Hydrate Parts Catalog rows by catalog ID for quote-time pricing

Get one immutable Quote Document revision

List VH3-owned Quote Documents, optionally filtered by job reference or status

Page Parts Catalog rows for the tenant, optionally filtered by vendor

List Quote Run rate cards, optionally filtered by contact

List quoting rate-default pointers for the tenant

List immutable revisions for one Quote Document

Patch structured SALMA commercial sections onto an existing Quote Document

Patch Quote Document version, status, or accepted revision pointer

Update a Quote Document revision status (for example superseded or accepted)

Run a Quote Run estimate for a job and send it to the supplied recipients

This service lists information about any attachments to the requested entity

This service retrieves an attachment using an AttachmentId. This can be retrieved using ListAttachments.

Returns the same dataset used by the Driver Infringement Report, allowing you to extract each driving infringement event

This webservice returns the same dataset used by the Driver Performance Report allowing you to extract each data around how your resources drive

BigChange Web Services ReportList: get a list of reports

This service returns a detailed list of the report templates available in BigChange

BigChange Web Services ReportVehicleInfringement: vehicle infringement events

This service allows you to view how your assets drive. This works like the 'Driver Behaviour' report to relay the same information, but for assets instead of resources.

Retrieve a list of journeys within a specified date range

Retrieves the latest known position of resources and mobile assets

This method does not return positional information

This service returns details of Assets last known position and odometer