Skip to main content
Ascora logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 23
  • Triggers: 0
  • Slug: ASCORA
  • Version: 20261101_00

Tools

Slug: ASCORA_CREATE_NOTECreates a note on an Ascora customer, job, quote, enquiry, invoice, purchase order, or asset. Requires the entity type and a valid entity ID.

Input Parameters

string
required
The text content of the note to be created. Can contain any text describing information, updates, or observations about the entity.
string
required
The unique identifier (UUID/GUID format) of the entity to attach the note to. Must be a valid UUID from the Ascora system.
string ("Customer" | "Job" | "Quote" | "Enquiry" | "Invoice" | "PurchaseOrder" | "Asset")
required
The type of entity to attach the note to. Must be one of: Customer, Job, Quote, Enquiry, Invoice, PurchaseOrder, or Asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_CREATE_OR_UPDATE_CONTACTTool to create a new contact or update an existing contact for a customer. Use when you need to add or modify contact information for a specific customer in Ascora. Requires a valid customer ID and accepts optional contact details like name, email, phone numbers, and default contact flag.

Input Parameters

string
The email address of the contact
string
The phone number of the contact
string
The last name of the contact
string
The fax number of the contact
string
The first name of the contact
string
required
The unique identifier of the customer to associate the contact with (UUID format)
string
The mobile number of the contact
boolean
Whether this is the default contact for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_CREATE_OR_UPDATE_CUSTOMERCreates or updates a customer in Ascora using a company name and optional contact and street and postal address details.

Input Parameters

string
required
Company name for the customer (required)
string
Phone number of the customer
string
Postal address line 1
string
Postal address line 2
string
Postal state
string
Street address line 1
string
Street address line 2 (e.g., unit or suite number)
string
Customer display name (defaults to CompanyName if not provided)
string
Email address of the customer
string
Mobile number of the customer
string
Postal suburb
string
Street suburb
string
Postal country
string
Street country
string
Postal postcode
string
Street postcode
string
Last name of the contact person
string
First name of the contact person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_CREATE_OR_UPDATE_SUPPLIERTool to create a new supplier or update an existing supplier in Ascora. Use when you need to add a new supplier with contact and address details, or modify an existing supplier’s information by providing the supplierId.

Input Parameters

string
The supplier’s fax number
string
required
The name of the supplier
string
Additional notes about the supplier
string
The supplier’s phone number
string
The supplier’s mobile number
string
The unique identifier for the supplier. Required when updating an existing supplier, omit when creating a new supplier.
string
Postal address line 1
string
Postal address line 2
string
Postal address state
string
Street address line 1
string
Street address line 2
string
Street address state
string
The supplier’s email address
string
Postal address suburb
string
Street address suburb
string
The supplier’s business number (ABN/ACN)
string
The expense account code for this supplier
string
Postal address postcode
string
Street address postcode
string
The supplier’s reference number
string
The last name of the contact person
string
The first name of the contact person
integer
The number of days for invoice due date calculation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_CREATE_QUOTATIONCreates an enquiry in Ascora for a customer, submitting a quote request with customer details, optional address information, work description, and custom fields. Returns an entity ID for the created enquiry.

Input Parameters

string
required
Customer’s email address
string
Customer’s landline phone number
string
Customer’s mobile phone number
string
required
Customer’s last name
string
required
Customer’s first name
string
required
Name of the customer’s company
string
First line of the address, e.g., street and number
string
Second line of the address, e.g., unit or suite
string
State or territory of the address, e.g., ‘WA’, ‘NSW’
array
List of custom field name/value pairs to include with the request
string
Suburb or city of the address
string
Country of the address
string
Postal code for the address
string
Description of the quote request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_DELETE_CUSTOMERDeletes a specific customer by ID. The tool reports success for HTTP 200, 204, or 404, so a success result does not confirm that a customer was deleted.

Input Parameters

string
required
Unique identifier of the customer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_CONTACTTool to retrieve details of a specific contact by their unique identifier. Use when you need to fetch information about a contact including their name, contact details, address, and customer association.

Input Parameters

string
required
The unique identifier (UUID) of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_CUSTOMERTool to retrieve details of a specific customer by their unique identifier. Use when you need to fetch information about a single customer including contact details, addresses, and status.

Input Parameters

string
required
The unique identifier (UUID) of the customer to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_CUSTOMERSRetrieves all customers from the Ascora system. Returns a list of customer records including contact information (name, email, phone) and address details (street, city, state, postcode, country). This is a read-only operation that requires authentication via API key. Useful for syncing customer data, creating customer lists, or verifying customer information exists in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_INVENTORY_CATEGORIESRetrieves all inventory categories used to organize supplies and kits in Ascora. Returns a paginated list of categories with their IDs, names, and numeric identifiers. Use this when you need to list available inventory categories or reference category information for organizing inventory items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_INVENTORY_KITSRetrieves all inventory kits from Ascora. Returns a paginated list of kit items that bundle multiple supplies together. Use this when you need to list available inventory kits or access kit details for quoting, job planning, or inventory management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_INVENTORY_SUPPLIESRetrieves a paginated list of inventory supplies from Ascora, with pricing and stock information when available. Supports page and page-size selection.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of records per page, between 1 and 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_JOBRetrieves details of a specific job by its unique identifier. Returns comprehensive job information including job number, name, status, customer details, dates, and other job-specific data. Use this when you need to fetch detailed information about a particular job in the Ascora system.

Input Parameters

string
required
The unique identifier of the job. Accepts both numeric IDs (e.g., ‘1’) and UUID format (e.g., ‘00000000-0000-0000-0000-000000000001’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_JOBSRetrieves a paginated list of jobs from Ascora with optional filtering by job type, status, secondary status, and date range. Returns job details including job number, name, status, customer information, and assignment details. Use this when you need to list, search, or monitor jobs in the Ascora system.

Input Parameters

integer
Page number for pagination (1-based).
string
Filter jobs created on or before this date (ISO 8601 date, YYYY-MM-DD).
string
Filter by job type, e.g., ‘Installation’ or ‘Service’.
integer
Number of jobs per page, between 1 and 1000.
string
Filter by main job status, e.g., ‘Open’, ‘Closed’.
string
Filter jobs created on or after this date (ISO 8601 date, YYYY-MM-DD).
string
Filter by secondary status of the job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_QUOTE_LABOUR_ROLESRetrieves Ascora labour roles available for use in quotes, including their hourly rates. Use this to list roles and rates for quotation purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_QUOTESRetrieves a paginated list of quotes from Ascora with optional filtering by status, date range, or customer. Returns quote details including quote number, customer information, status, creation date, and total amount. Use this when you need to list, search, or monitor quotes in the Ascora system.

Input Parameters

integer
Page number for pagination (1-based).
string
Filter by quote status, e.g., ‘Draft’, ‘Sent’, ‘Accepted’, ‘Declined’.
string
Filter quotes created on or before this date (ISO 8601 date, YYYY-MM-DD).
integer
Number of quotes per page, between 1 and 1000.
string
Filter quotes created on or after this date (ISO 8601 date, YYYY-MM-DD).
string
Filter by customer ID to retrieve quotes for a specific customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_QUOTE_STANDARD_SECTIONSRetrieves standard sections that can be used in quotes. Returns a list of pre-configured standard sections that can be included in quotations. This is a read-only operation that requires authentication via API key. Use when you need to list available standard sections for quote generation or to verify what sections exist in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_QUOTE_STANDARD_STAGESRetrieves standard stages that can be used in quotes for progress tracking. Use this when you need to list available quote stages, display progress tracking options, or reference standard stages for quote management. Returns all configured standard stages in the Ascora system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_SUPPLIERTool to retrieve details of a specific supplier by ID. Use when you need to fetch supplier information including contact details, address, and business information.

Input Parameters

string
required
The unique identifier (UUID) of the supplier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_SUPPLIER_INVOICESRetrieves a paginated list of supplier invoices from Ascora, including invoice number, supplier name, dates, amounts, and status when returned.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of supplier invoices per page, between 1 and 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_GET_SUPPLIERSRetrieves a paginated list of suppliers from Ascora, with details such as name, contact information, address, ABN, and activity status when returned.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of records per page, between 1 and 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_SEARCH_JOBSSearch for jobs by various criteria including job number, customer, or address. Use this when you need to find specific jobs based on identifiers or search terms rather than filtering by status or type.

Input Parameters

integer
Page number for pagination (1-based).
string
Search for jobs by address. Supports partial matching.
string
Search for jobs by customer name. Supports partial matching.
integer
Number of jobs per page, between 1 and 1000.
string
Search for a specific job by its job number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ASCORA_UPLOAD_ATTACHMENTTool to upload an attachment to an entity (quote, job, customer, etc.) in Ascora. Use when you need to attach files like documents, images, or plans to existing entities in the system.

Input Parameters

object
required
The file to upload as an attachment.
string
required
The unique identifier (UUID/GUID format) of the entity to attach the file to. Must be a valid UUID from the Ascora system.
string ("Customer" | "Job" | "Quote" | "Enquiry" | "Invoice" | "PurchaseOrder" | "Asset")
required
The type of entity to attach the file to. Must be one of: Customer, Job, Quote, Enquiry, Invoice, PurchaseOrder, or Asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not