Ascora MCP by usefulapi is an MCP server published by io.usefulapi, hosted at ascora.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 28 tools, including ascora_list_customers, ascora_get_customer, ascora_list_contacts, ascora_list_customer_contacts, ascora_list_supplies.
Read customers, quotes, jobs, bookings and price list; create quotes, jobs and bookings in Ascora.
4,274 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Search Ascora customers (sites and billing customers): id, number, name, contact, email, phone, addresses, on-hold flags, customer type, lead source, billing customer and assigned user. GET /Customers/Customers.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| filter_text | string | Free text across customer number, email, phone, mobile, billing customer name and contact names. |
| lead_source | string | Lead source name. |
| phone_number | string | Searches the phone and mobile fields. |
| assigned_user | string | Full name of the assigned user. |
| customer_type | string | Customer type name. |
| site_billing_type | string | Which kind of customer to return (default All). |
{
"name": "ascora_list_customers",
"title": "List customers",
"description": "Search Ascora customers (sites and billing customers): id, number, name, contact, email, phone, addresses, on-hold flags, customer type, lead source, billing customer and assigned user. GET /Customers/Customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free text across customer number, email, phone, mobile, billing customer name and contact names."
},
"lead_source": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Lead source name."
},
"phone_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Searches the phone and mobile fields."
},
"assigned_user": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name of the assigned user."
},
"customer_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Customer type name."
},
"site_billing_type": {
"enum": [
"Site",
"Billing",
"All"
],
"type": "string",
"description": "Which kind of customer to return (default All)."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One Ascora customer by id (GUID from ascora_list_customers), including custom fields. GET /Customers/Customer/{id}.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | Ascora customer id. |
{
"name": "ascora_get_customer",
"title": "Get customer",
"description": "One Ascora customer by id (GUID from ascora_list_customers), including custom fields. GET /Customers/Customer/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Ascora customer id."
}
}
},
"annotations": {
"title": "Get customer",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search contacts across all customers by name, email or phone. GET /Customers/Contacts.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| filter_text | string | Contains-match on first name, last name, email, phone or mobile. |
| phone_number | string | Exact match on phone or mobile (spaces ignored). |
{
"name": "ascora_list_contacts",
"title": "List contacts",
"description": "Search contacts across all customers by name, email or phone. GET /Customers/Contacts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contains-match on first name, last name, email, phone or mobile."
},
"phone_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact match on phone or mobile (spaces ignored)."
}
}
},
"annotations": {
"title": "List contacts",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}All contacts of one customer, with role and default-contact flag. GET /Customers/GetContactsForCustomer/{customerId}.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| customer_id * | string | Ascora customer id. |
{
"name": "ascora_list_customer_contacts",
"title": "List contacts of a customer",
"description": "All contacts of one customer, with role and default-contact flag. GET /Customers/GetContactsForCustomer/{customerId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Ascora customer id."
}
}
},
"annotations": {
"title": "List contacts of a customer",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search the inventory price list: materials and services with part number, description, cost, sell price ex/inc tax, supplier, categories and reorder flags. Use the supply id to add items to quotes. GET /Inventory/Supplies.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| filter_text | string | Searches part number, supplier part number, description, annotation and category name. |
| favourite_only | boolean | Only favourite items. |
| category_one_id | string | Category 1 id (from ascora_list_categories). |
| category_two_id | string | Category 2 id (from ascora_list_categories). |
{
"name": "ascora_list_supplies",
"title": "List supplies (price list)",
"description": "Search the inventory price list: materials and services with part number, description, cost, sell price ex/inc tax, supplier, categories and reorder flags. Use the supply id to add items to quotes. GET /Inventory/Supplies.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Searches part number, supplier part number, description, annotation and category name."
},
"favourite_only": {
"type": "boolean",
"description": "Only favourite items."
},
"category_one_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Category 1 id (from ascora_list_categories)."
},
"category_two_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Category 2 id (from ascora_list_categories)."
}
}
},
"annotations": {
"title": "List supplies",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search kits (bundles of supplies and labour) with part number, description, markup, sell price and pricing method. GET /Inventory/Kits.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| filter_text | string | Searches part number, supplier part number, description, annotation and category name. |
| favourite_only | boolean | Only favourite items. |
| category_one_id | string | Category 1 id (from ascora_list_categories). |
| category_two_id | string | Category 2 id (from ascora_list_categories). |
{
"name": "ascora_list_kits",
"title": "List kits",
"description": "Search kits (bundles of supplies and labour) with part number, description, markup, sell price and pricing method. GET /Inventory/Kits.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Searches part number, supplier part number, description, annotation and category name."
},
"favourite_only": {
"type": "boolean",
"description": "Only favourite items."
},
"category_one_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Category 1 id (from ascora_list_categories)."
},
"category_two_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Category 2 id (from ascora_list_categories)."
}
}
},
"annotations": {
"title": "List kits",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Inventory categories (Category 1 or 2, top-level or sub-categories) used to filter supplies and kits. GET /Inventory/Categories.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| filter_text | string | Searches the category name. |
| parent_only | boolean | Only top-level categories. |
| category_number | any | 1 or 2; omit for both. |
{
"name": "ascora_list_categories",
"title": "List inventory categories",
"description": "Inventory categories (Category 1 or 2, top-level or sub-categories) used to filter supplies and kits. GET /Inventory/Categories.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Searches the category name."
},
"parent_only": {
"type": "boolean",
"description": "Only top-level categories."
},
"category_number": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
],
"description": "1 or 2; omit for both."
}
}
},
"annotations": {
"title": "List inventory categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Labour roles with their hourly rate ex tax, ordered by name. Use the role id to add labour to a quote. GET /Quotes/LabourRoles.
No parameters.
{
"name": "ascora_list_labour_roles",
"title": "List labour roles",
"description": "Labour roles with their hourly rate ex tax, ordered by name. Use the role id to add labour to a quote. GET /Quotes/LabourRoles.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List labour roles",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search quotes: number, name, status, date, totals ex/inc tax, pricing method, job type and site/billing customer. Status defaults to OPEN (in progress or sent) when omitted. GET /Quotes/Quotes.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| end_date | string | Quotes created on or before this date, yyyy-mm-dd. |
| job_type | string | Job type name. |
| page_size | integer | Results per page, 1-250 (default 50). |
| start_date | string | Quotes created on or after this date, yyyy-mm-dd. |
| filter_text | string | Partial match on quote number, name or address. |
| quote_status | string | Status filter; OPEN (default) = in progress or sent to customer, WON = converted to jobs, ACCEPTED = accepted but not yet converted, ALL = every quote. |
| assigned_user | string | Full name of the assigned user. |
| customer_name | string | Partial match on site or billing customer name. |
One quote by its full number (e.g. Q57): status, dates, totals, pricing method, addresses, job type, customers and custom fields. GET /Quotes/Quote/{quoteNumber}.
| Parameter | Type | Description |
|---|---|---|
| quote_number * | string | Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01). |
{
"name": "ascora_get_quote",
"title": "Get quote",
"description": "One quote by its full number (e.g. Q57): status, dates, totals, pricing method, addresses, job type, customers and custom fields. GET /Quotes/Quote/{quoteNumber}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"quote_number"
],
"properties": {
"quote_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01)."
}
}
},
"annotations": {
"title": "Get quote",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search jobs: number, name, status, totals, pricing method, job type, site/billing customer, secondary status and pipeline phase. Status defaults to OPEN when omitted. GET /Jobs/Jobs.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| end_date | string | Jobs created on or before this date, yyyy-mm-dd. |
| job_type | string | Job type name. |
| page_size | integer | Results per page, 1-250 (default 50). |
| job_status | string | Status filter (default open jobs). COMPLETED-NOT-INVOICED and READY-TO-INVOICE find work not yet billed; ALL = every job. |
| start_date | string | Jobs created on or after this date, yyyy-mm-dd. |
| filter_text | string | Partial match on job number, name or address. |
| assigned_user | string | Full name of the assigned user. |
| customer_name | string | Partial match on site or billing customer name. |
| include_child_jobs | boolean |
One job by its full number (e.g. J112): status, dates, totals, pricing method, job type, customers, secondary status and pipeline phase. A deleted job reads as not found. GET /Jobs/Job/{jobNumber}.
| Parameter | Type | Description |
|---|---|---|
| job_number * | string | Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01). |
{
"name": "ascora_get_job",
"title": "Get job",
"description": "One job by its full number (e.g. J112): status, dates, totals, pricing method, job type, customers, secondary status and pipeline phase. A deleted job reads as not found. GET /Jobs/Job/{jobNumber}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_number"
],
"properties": {
"job_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01)."
}
}
},
"annotations": {
"title": "Get job",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Labour lines on a job: role, hours, hourly rate, totals, staff member, chargeable and invoiced flags. GET /Jobs/JobLabour/{jobNumber}.
| Parameter | Type | Description |
|---|---|---|
| job_number * | string | Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01). |
{
"name": "ascora_get_job_labour",
"title": "Get job labour",
"description": "Labour lines on a job: role, hours, hourly rate, totals, staff member, chargeable and invoiced flags. GET /Jobs/JobLabour/{jobNumber}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_number"
],
"properties": {
"job_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01)."
}
}
},
"annotations": {
"title": "Get job labour",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Timesheet entries on a job: staff member, start/end, hours, meal break and payroll-sent flag (pay and cost rates are not returned). GET /Jobs/JobTimesheets/{jobNumber}.
| Parameter | Type | Description |
|---|---|---|
| job_number * | string | Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01). |
{
"name": "ascora_get_job_timesheets",
"title": "Get job timesheets",
"description": "Timesheet entries on a job: staff member, start/end, hours, meal break and payroll-sent flag (pay and cost rates are not returned). GET /Jobs/JobTimesheets/{jobNumber}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_number"
],
"properties": {
"job_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Job Number, e.g. J112. A section or stage is J1234.01 (or J1234-01)."
}
}
},
"annotations": {
"title": "Get job timesheets",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search the schedule: bookings of jobs, quotes and activities with staff member, start/end, notes, arrival window and the job or quote they belong to. Archived bookings are excluded unless include_archived. GET /Bookings/Bookings.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| user | string | One staff member, by id, full name, email or login. |
| sort_by | string | Sort order (default StartTime). |
| end_date | any | Bookings overlapping this period end. |
| page_size | integer | Results per page, 1-250 (default 50). |
| team_name | string | Bookings of the members of this team. |
| job_number | string | Bookings of this job (sections and stages included). |
| job_status | string | Comma-separated job statuses, e.g. BOOKED,IN-PROGRESS (also ALL-OPEN, COMPLETED, CLOSED, CANCELLED). |
| start_date | any | Bookings overlapping this period start (yyyy-mm-dd covers the whole day). |
| customer_id |
One booking by id: type, times (local and UTC), staff member, job/quote/activity, customers, address, notes, arrival window, rates and reminder flags. GET /Bookings/Booking/{bookingId}.
| Parameter | Type | Description |
|---|---|---|
| booking_id * | string | Ascora booking id (from ascora_list_bookings). |
{
"name": "ascora_get_booking",
"title": "Get booking",
"description": "One booking by id: type, times (local and UTC), staff member, job/quote/activity, customers, address, notes, arrival window, rates and reminder flags. GET /Bookings/Booking/{bookingId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"booking_id"
],
"properties": {
"booking_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Ascora booking id (from ascora_list_bookings)."
}
}
},
"annotations": {
"title": "Get booking",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Activity types that non-job bookings (training, leave-style activities, etc.) can be made with. GET /Bookings/ActivityTypes.
No parameters.
{
"name": "ascora_list_activity_types",
"title": "List activity types",
"description": "Activity types that non-job bookings (training, leave-style activities, etc.) can be made with. GET /Bookings/ActivityTypes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "List activity types",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Staff users of the Ascora company (archived users excluded): id, name, email, mobile, job title, team, scheduler group, licence and access flags. Pay rates are not returned. GET /Users/Users.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| last_name | string | Contains-match on last name. |
| page_size | integer | Results per page, 1-250 (default 50). |
| team_name | string | Only members of this team. |
| first_name | string | Contains-match on first name. |
| filter_text | string | Contains-match on first name, last name, email and login. |
| scheduler_group_name | string | Only members of this scheduler group. |
{
"name": "ascora_list_users",
"title": "List staff users",
"description": "Staff users of the Ascora company (archived users excluded): id, name, email, mobile, job title, team, scheduler group, licence and access flags. Pay rates are not returned. GET /Users/Users.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contains-match on last name."
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"team_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only members of this team."
},
"first_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contains-match on first name."
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contains-match on first name, last name, email and login."
},
"scheduler_group_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only members of this scheduler group."
}
}
},
"annotations": {
"title": "List staff users",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search suppliers by name, supplier number or exact business number (ABN). GET /Suppliers/Suppliers.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| supplier_name | string | Partial match on supplier name. |
| business_number | string | Exact match on the business number (e.g. ABN), spaces ignored. |
| supplier_number | string | Partial match on supplier number. |
{
"name": "ascora_list_suppliers",
"title": "List suppliers",
"description": "Search suppliers by name, supplier number or exact business number (ABN). GET /Suppliers/Suppliers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"supplier_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on supplier name."
},
"business_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact match on the business number (e.g. ABN), spaces ignored."
},
"supplier_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on supplier number."
}
}
},
"annotations": {
"title": "List suppliers",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Search supplier invoices and credit notes: supplier, dates, tracking number, lines and totals. GET /SupplierInvoices/SupplierInvoices.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| page_size | integer | Results per page, 1-250 (default 50). |
| supplier_name | string | Partial match on supplier name. |
| tracking_number | string | Partial match on the supplier invoice or credit note number. |
| invoice_date_end | string | Invoice date on or before, yyyy-mm-dd. |
| invoice_date_start | string | Invoice date on or after, yyyy-mm-dd. |
| to_be_sent_to_accounting | boolean | Only invoices not yet pushed to the accounting package. |
{
"name": "ascora_list_supplier_invoices",
"title": "List supplier invoices",
"description": "Search supplier invoices and credit notes: supplier, dates, tracking number, lines and totals. GET /SupplierInvoices/SupplierInvoices.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"supplier_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on supplier name."
},
"tracking_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on the supplier invoice or credit note number."
},
"invoice_date_end": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoice date on or before, yyyy-mm-dd."
},
"invoice_date_start": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoice date on or after, yyyy-mm-dd."
},
"to_be_sent_to_accounting": {
"type": "boolean",
"description": "Only invoices not yet pushed to the accounting package."
}
}
},
"annotations": {
"title": "List supplier invoices",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: create a new enquiry (lead) in Ascora. Every call creates another enquiry (not idempotent; Ascora allows 500 enquiries an hour per company), so do not repeat it. Needs at least a name, company, email, phone or mobile. POST /Enquiry.
| Parameter | Type | Description |
|---|---|---|
| string | ||
| phone | string | |
| state | string | |
| mobile | string | |
| suburb | string | |
| country | string | |
| postcode | string | |
| last_name | string | |
| first_name | string | |
| description | string | Description of the work requested. |
| lead_source | string | Lead source name, e.g. Online. |
| company_name | string |
WRITE: create a new customer (site or billing) in Ascora. Always creates a new record (it never updates an existing customer), so search with ascora_list_customers first to avoid duplicates. A customer type or lead source name that does not exist is created. POST /Customers/Customer.
| Parameter | Type | Description |
|---|---|---|
| string | ||
| phone | string | |
| mobile | string | |
| last_name | string | |
| first_name | string | |
| lead_source | string | Lead source name. |
| company_name | string | Company name; for an individual leave empty and give first and last name. |
| street_line1 | string | |
| street_line2 | string | |
| street_state | string | |
| custom_fields | array | Custom field values. The field definitions must already exist in Ascora. |
WRITE: add a note to an enquiry, job, quote, invoice or customer (the entity must already exist). Notes cannot be edited or removed through this server, and every call adds another note. POST /Notes/Note.
| Parameter | Type | Description |
|---|---|---|
| content * | string | The note text. |
| entity_id * | string | Id (GUID) of the enquiry, job, quote, invoice or customer. |
| entity_type * | string | What the note is attached to. |
| created_by_name | string | Name shown as the author (default 'AI assistant'). |
{
"name": "ascora_add_note",
"title": "Add note",
"description": "WRITE: add a note to an enquiry, job, quote, invoice or customer (the entity must already exist). Notes cannot be edited or removed through this server, and every call adds another note. POST /Notes/Note.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_type",
"entity_id",
"content"
],
"properties": {
"content": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"description": "The note text."
},
"entity_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Id (GUID) of the enquiry, job, quote, invoice or customer."
},
"entity_type": {
"enum": [
"Enquiry",
"Job",
"Quotation",
"Invoice",
"Customer"
],
"type": "string",
"description": "What the note is attached to."
},
"created_by_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Name shown as the author (default 'AI assistant')."
}
}
},
"annotations": {
"title": "Add note",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}WRITE: create a new quote (status In Progress; it is NOT sent to the customer) for a site customer, optionally with supplies, kits and labour from the price list. Ids that Ascora cannot find are skipped silently when creating, so check the totals in the reply. Every call creates another quote. POST /Quotes/Quote.
| Parameter | Type | Description |
|---|---|---|
| kits | array | Kits from ascora_list_kits. |
| labour | array | Labour roles from ascora_list_labour_roles; quantity = hours. |
| supplies | array | Supplies from ascora_list_supplies (not for SECTIONS or STAGES pricing). |
| quote_name | string | |
| description | string | |
| job_type_name | string | Job type name; default job type when empty. |
| pricing_method | string | Default TIME-AND-MATERIALS. |
| site_customer_id | string | Site customer id (from ascora_list_customers). Give this or site_customer_name. |
| site_customer_name | string | Exact customer name if you have no id. |
| billing_customer_id | string |
WRITE: change a quote's status to IN-PROGRESS, SENT-TO-CUSTOMER, LOST or WON. WON converts the quote into a new Job (the same as ascora_convert_quote_to_job; a second WON returns the existing job). Ascora's reference documents only a status change, not an email to the customer. POST /Quotes/UpdateStatus.
| Parameter | Type | Description |
|---|---|---|
| status * | string | New status. |
| quote_number * | string | Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01). |
| reason_for_loss | string | Recorded as the reason for loss when status is LOST. |
{
"name": "ascora_update_quote_status",
"title": "Update quote status",
"description": "WRITE: change a quote's status to IN-PROGRESS, SENT-TO-CUSTOMER, LOST or WON. WON converts the quote into a new Job (the same as ascora_convert_quote_to_job; a second WON returns the existing job). Ascora's reference documents only a status change, not an email to the customer. POST /Quotes/UpdateStatus.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"quote_number",
"status"
],
"properties": {
"status": {
"enum": [
"IN-PROGRESS",
"SENT-TO-CUSTOMER",
"LOST",
"WON"
],
"type": "string",
"description": "New status."
},
"quote_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01)."
},
"reason_for_loss": {
"type": "string",
"maxLength": 500,
"description": "Recorded as the reason for loss when status is LOST."
}
}
},
"annotations": {
"title": "Update quote status",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: convert a quote into a Job (what Convert to Job does in Ascora): supplies, labour, notes, bookings and attachments carry over and the quote is marked converted. Never forces a new job: a variation quote is added onto its original job, a quote whose job still exists is reconnected to it, and a quote already converted is refused with a message naming the existing job. Specify the parent quote number, not a section. POST /Quotes/ConvertToJob.
| Parameter | Type | Description |
|---|---|---|
| quote_number * | string | Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01). |
{
"name": "ascora_convert_quote_to_job",
"title": "Convert quote to job",
"description": "WRITE: convert a quote into a Job (what Convert to Job does in Ascora): supplies, labour, notes, bookings and attachments carry over and the quote is marked converted. Never forces a new job: a variation quote is added onto its original job, a quote whose job still exists is reconnected to it, and a quote already converted is refused with a message naming the existing job. Specify the parent quote number, not a section. POST /Quotes/ConvertToJob.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"quote_number"
],
"properties": {
"quote_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Quote Number, e.g. Q57. A section is Q1234.01 (or Q1234-01)."
}
}
},
"annotations": {
"title": "Convert quote to job",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}WRITE: create a new job for a site customer (it never updates an existing job). Every call creates another job; add work with a quote or in Ascora. The job is not booked and nothing is sent to the customer. POST /Jobs/Job.
| Parameter | Type | Description |
|---|---|---|
| job_name | string | |
| description | string | |
| job_type_name | string | Job type name; default job type when empty. |
| pricing_method | string | Default pricing method of the company when empty. |
| site_customer_id | string | Site customer id (from ascora_list_customers). Give this or site_customer_name. |
| site_customer_name | string | Exact customer name if you have no id. |
| billing_customer_id | string | Billing customer id; defaults to the site's billing customer. |
| client_order_number | string | |
| purchase_order_number | string |
WRITE: schedule staff on a job or a quote (give exactly one of job_number / quote_number). One booking is created per staff member and the job or quote moves to Booked; the bookings show on the Scheduler and the staff mobile apps, and Ascora's own reminder settings may notify the customer or staff. Repeating the identical request returns the existing booking. By default a clash with another booking or leave refuses the whole request (reject_conflicts). POST /Bookings/Booking.
| Parameter | Type | Description |
|---|---|---|
| notes | string | Booking notes for the staff. |
| users * | array | Staff to book: each a user id (GUID from ascora_list_users) or a full name, email or login. |
| end_time | string | End; give this or duration_minutes. |
| job_number | string | Full Job Number to book, e.g. J1234 or J1234.01. |
| start_time * | string | Start, e.g. 2026-10-06T08:00:00 (company local time unless you add Z or an offset). |
| time_window | string | Arrival window shown to the customer, e.g. 8am - 10am. |
| quote_number | string | Full Quote Number to book. |
| duration_minutes | integer |
Tools for Ascora, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which quotes have been sent to customers but not yet accepted?"; "Show me the jobs that are completed but not yet invoiced."; "Who is booked on the schedule next week?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Ascora data. Free plan: 50 tool calls per month. Run ascora_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run ascora_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run ascora_upgrade without a plan: it returns both plans, each with a payment link for the user to open. ascora_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "ascora_list_quotes",
"title": "List quotes",
"description": "Search quotes: number, name, status, date, totals ex/inc tax, pricing method, job type and site/billing customer. Status defaults to OPEN (in progress or sent) when omitted. GET /Quotes/Quotes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"end_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Quotes created on or before this date, yyyy-mm-dd."
},
"job_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Job type name."
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"start_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Quotes created on or after this date, yyyy-mm-dd."
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on quote number, name or address."
},
"quote_status": {
"enum": [
"IN-PROGRESS",
"SENT-TO-CUSTOMER",
"OPEN",
"WON",
"LAST-7-DAYS",
"ALL",
"ACCEPTED"
],
"type": "string",
"description": "Status filter; OPEN (default) = in progress or sent to customer, WON = converted to jobs, ACCEPTED = accepted but not yet converted, ALL = every quote."
},
"assigned_user": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name of the assigned user."
},
"customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on site or billing customer name."
}
}
},
"annotations": {
"title": "List quotes",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}| Also return the sections and stages inside jobs. |
{
"name": "ascora_list_jobs",
"title": "List jobs",
"description": "Search jobs: number, name, status, totals, pricing method, job type, site/billing customer, secondary status and pipeline phase. Status defaults to OPEN when omitted. GET /Jobs/Jobs.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"end_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Jobs created on or before this date, yyyy-mm-dd."
},
"job_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Job type name."
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"job_status": {
"enum": [
"NEW",
"IN-PROGRESS",
"COMPLETED",
"CANCELLED",
"BOOKED",
"ALL-OPEN",
"PARTS-REQUIRING-REORDER",
"COMPLETED-NOT-INVOICED",
"READY-TO-INVOICE",
"CLOSED",
"REATTENDANCE-REQUIRED",
"INCOMPLETE",
"COMPLETED-OR-CLOSED",
"ALL"
],
"type": "string",
"description": "Status filter (default open jobs). COMPLETED-NOT-INVOICED and READY-TO-INVOICE find work not yet billed; ALL = every job."
},
"start_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Jobs created on or after this date, yyyy-mm-dd."
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on job number, name or address."
},
"assigned_user": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name of the assigned user."
},
"customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on site or billing customer name."
},
"include_child_jobs": {
"type": "boolean",
"description": "Also return the sections and stages inside jobs."
}
}
},
"annotations": {
"title": "List jobs",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}| string |
| Bookings whose job or quote has this site customer. |
| filter_text | string | Partial match on job or quote number, name, address, site customer, activity title and notes. |
| booking_type | string | Only this kind of booking. |
| quote_number | string | Bookings of this quote. |
| quote_status | string | Comma-separated quote statuses, e.g. IN-PROGRESS,SENT-TO-CUSTOMER (also OPEN, WON, LOST). |
| customer_name | string | Partial match on site or billing customer name. |
| modified_since | string | Bookings created, changed or archived at or after this date-time (ISO 8601). |
| sort_descending | boolean | Latest first. |
| include_archived | boolean | Also return archived bookings. |
{
"name": "ascora_list_bookings",
"title": "List bookings (schedule)",
"description": "Search the schedule: bookings of jobs, quotes and activities with staff member, start/end, notes, arrival window and the job or quote they belong to. Archived bookings are excluded unless include_archived. GET /Bookings/Bookings.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"user": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "One staff member, by id, full name, email or login."
},
"sort_by": {
"enum": [
"StartTime",
"LastModified"
],
"type": "string",
"description": "Sort order (default StartTime)."
},
"end_date": {
"anyOf": [
{
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?$"
}
],
"description": "Bookings overlapping this period end."
},
"page_size": {
"type": "integer",
"maximum": 250,
"description": "Results per page, 1-250 (default 50).",
"exclusiveMinimum": 0
},
"team_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Bookings of the members of this team."
},
"job_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Bookings of this job (sections and stages included)."
},
"job_status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Comma-separated job statuses, e.g. BOOKED,IN-PROGRESS (also ALL-OPEN, COMPLETED, CLOSED, CANCELLED)."
},
"start_date": {
"anyOf": [
{
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?$"
}
],
"description": "Bookings overlapping this period start (yyyy-mm-dd covers the whole day)."
},
"customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Bookings whose job or quote has this site customer."
},
"filter_text": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on job or quote number, name, address, site customer, activity title and notes."
},
"booking_type": {
"enum": [
"Job",
"Quote",
"Activity"
],
"type": "string",
"description": "Only this kind of booking."
},
"quote_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Bookings of this quote."
},
"quote_status": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Comma-separated quote statuses, e.g. IN-PROGRESS,SENT-TO-CUSTOMER (also OPEN, WON, LOST)."
},
"customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Partial match on site or billing customer name."
},
"modified_since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "Bookings created, changed or archived at or after this date-time (ISO 8601)."
},
"sort_descending": {
"type": "boolean",
"description": "Latest first."
},
"include_archived": {
"type": "boolean",
"description": "Also return archived bookings."
}
}
},
"annotations": {
"title": "List bookings",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}| address_line1 | string |
| address_line2 | string |
| custom_fields | array | Custom field values. The field definitions must already exist in Ascora. |
{
"name": "ascora_create_enquiry",
"title": "Create enquiry (lead)",
"description": "WRITE: create a new enquiry (lead) in Ascora. Every call creates another enquiry (not idempotent; Ascora allows 500 enquiries an hour per company), so do not repeat it. Needs at least a name, company, email, phone or mobile. POST /Enquiry.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200
},
"phone": {
"type": "string",
"maxLength": 50
},
"state": {
"type": "string",
"maxLength": 50
},
"mobile": {
"type": "string",
"maxLength": 50
},
"suburb": {
"type": "string",
"maxLength": 100
},
"country": {
"type": "string",
"maxLength": 100
},
"postcode": {
"type": "string",
"maxLength": 20
},
"last_name": {
"type": "string",
"maxLength": 100
},
"first_name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "Description of the work requested."
},
"lead_source": {
"type": "string",
"maxLength": 100,
"description": "Lead source name, e.g. Online."
},
"company_name": {
"type": "string",
"maxLength": 200
},
"address_line1": {
"type": "string",
"maxLength": 200
},
"address_line2": {
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Custom field name exactly as entered in Ascora (Administration -> Custom Fields)."
},
"value": {
"type": "string",
"maxLength": 2000
}
}
},
"maxItems": 50,
"description": "Custom field values. The field definitions must already exist in Ascora."
}
}
},
"annotations": {
"title": "Create enquiry",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}| customer_type | string | Customer type name, e.g. Domestic. |
| street_suburb | string |
| street_country | string |
| street_postcode | string |
{
"name": "ascora_create_customer",
"title": "Create customer",
"description": "WRITE: create a new customer (site or billing) in Ascora. Always creates a new record (it never updates an existing customer), so search with ascora_list_customers first to avoid duplicates. A customer type or lead source name that does not exist is created. POST /Customers/Customer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200
},
"phone": {
"type": "string",
"maxLength": 50
},
"mobile": {
"type": "string",
"maxLength": 50
},
"last_name": {
"type": "string",
"maxLength": 100
},
"first_name": {
"type": "string",
"maxLength": 100
},
"lead_source": {
"type": "string",
"maxLength": 100,
"description": "Lead source name."
},
"company_name": {
"type": "string",
"maxLength": 200,
"description": "Company name; for an individual leave empty and give first and last name."
},
"street_line1": {
"type": "string",
"maxLength": 200
},
"street_line2": {
"type": "string",
"maxLength": 200
},
"street_state": {
"type": "string",
"maxLength": 50
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Custom field name exactly as entered in Ascora (Administration -> Custom Fields)."
},
"value": {
"type": "string",
"maxLength": 2000
}
}
},
"maxItems": 50,
"description": "Custom field values. The field definitions must already exist in Ascora."
},
"customer_type": {
"type": "string",
"maxLength": 100,
"description": "Customer type name, e.g. Domestic."
},
"street_suburb": {
"type": "string",
"maxLength": 100
},
"street_country": {
"type": "string",
"maxLength": 100
},
"street_postcode": {
"type": "string",
"maxLength": 20
}
}
},
"annotations": {
"title": "Create customer",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}| Billing customer id; defaults to the site's billing customer. |
| client_order_number | string |
| purchase_order_number | string |
{
"name": "ascora_create_quote",
"title": "Create quote",
"description": "WRITE: create a new quote (status In Progress; it is NOT sent to the customer) for a site customer, optionally with supplies, kits and labour from the price list. Ids that Ascora cannot find are skipped silently when creating, so check the totals in the reply. Every call creates another quote. POST /Quotes/Quote.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kits": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Kit id"
},
"quantity": {
"type": "number",
"maximum": 1000000,
"exclusiveMinimum": 0
}
},
"description": "Kit and quantity"
},
"maxItems": 100,
"description": "Kits from ascora_list_kits."
},
"labour": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Labour role id"
},
"quantity": {
"type": "number",
"maximum": 1000000,
"exclusiveMinimum": 0
},
"description": {
"type": "string",
"maxLength": 500
}
}
},
"maxItems": 100,
"description": "Labour roles from ascora_list_labour_roles; quantity = hours."
},
"supplies": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"quantity"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Supply id"
},
"quantity": {
"type": "number",
"maximum": 1000000,
"exclusiveMinimum": 0
}
},
"description": "Supply and quantity"
},
"maxItems": 100,
"description": "Supplies from ascora_list_supplies (not for SECTIONS or STAGES pricing)."
},
"quote_name": {
"type": "string",
"maxLength": 200
},
"description": {
"type": "string",
"maxLength": 5000
},
"job_type_name": {
"type": "string",
"maxLength": 100,
"description": "Job type name; default job type when empty."
},
"pricing_method": {
"enum": [
"TIME-AND-MATERIALS",
"FIXED-PRICE",
"SECTIONS",
"STAGES"
],
"type": "string",
"description": "Default TIME-AND-MATERIALS."
},
"site_customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Site customer id (from ascora_list_customers). Give this or site_customer_name."
},
"site_customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact customer name if you have no id."
},
"billing_customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Billing customer id; defaults to the site's billing customer."
},
"client_order_number": {
"type": "string",
"maxLength": 1000
},
"purchase_order_number": {
"type": "string",
"maxLength": 100
}
}
},
"annotations": {
"title": "Create quote",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}{
"name": "ascora_create_job",
"title": "Create job",
"description": "WRITE: create a new job for a site customer (it never updates an existing job). Every call creates another job; add work with a quote or in Ascora. The job is not booked and nothing is sent to the customer. POST /Jobs/Job.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"job_name": {
"type": "string",
"maxLength": 200
},
"description": {
"type": "string",
"maxLength": 5000
},
"job_type_name": {
"type": "string",
"maxLength": 100,
"description": "Job type name; default job type when empty."
},
"pricing_method": {
"enum": [
"TIME-AND-MATERIALS",
"FIXED-PRICE",
"SECTIONS",
"STAGES"
],
"type": "string",
"description": "Default pricing method of the company when empty."
},
"site_customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Site customer id (from ascora_list_customers). Give this or site_customer_name."
},
"site_customer_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact customer name if you have no id."
},
"billing_customer_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "Billing customer id; defaults to the site's billing customer."
},
"client_order_number": {
"type": "string",
"maxLength": 1000
},
"purchase_order_number": {
"type": "string",
"maxLength": 100
}
}
},
"annotations": {
"title": "Create job",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}| Length in minutes; give this or end_time. |
| reject_conflicts | boolean | Refuse the request when a staff member is already booked or on leave then (default true here; false books anyway and lists the clashes). |
{
"name": "ascora_create_booking",
"title": "Create booking",
"description": "WRITE: schedule staff on a job or a quote (give exactly one of job_number / quote_number). One booking is created per staff member and the job or quote moves to Booked; the bookings show on the Scheduler and the staff mobile apps, and Ascora's own reminder settings may notify the customer or staff. Repeating the identical request returns the existing booking. By default a clash with another booking or leave refuses the whole request (reject_conflicts). POST /Bookings/Booking.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"users",
"start_time"
],
"properties": {
"notes": {
"type": "string",
"maxLength": 2000,
"description": "Booking notes for the staff."
},
"users": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"minItems": 1,
"description": "Staff to book: each a user id (GUID from ascora_list_users) or a full name, email or login."
},
"end_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "End; give this or duration_minutes."
},
"job_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Job Number to book, e.g. J1234 or J1234.01."
},
"start_time": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,7})?)?(Z|[+-]\\d{2}:\\d{2})?$",
"description": "Start, e.g. 2026-10-06T08:00:00 (company local time unless you add Z or an offset)."
},
"time_window": {
"type": "string",
"maxLength": 250,
"description": "Arrival window shown to the customer, e.g. 8am - 10am."
},
"quote_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]+$",
"maxLength": 40,
"minLength": 1,
"description": "Full Quote Number to book."
},
"duration_minutes": {
"type": "integer",
"maximum": 20160,
"description": "Length in minutes; give this or end_time.",
"exclusiveMinimum": 0
},
"reject_conflicts": {
"type": "boolean",
"description": "Refuse the request when a staff member is already booked or on leave then (default true here; false books anyway and lists the clashes)."
}
}
},
"annotations": {
"title": "Create booking",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}