# Ascora

Ascora is a cloud-based field service management software designed to streamline operations for service-based businesses, offering features such as job scheduling, invoicing, customer management, and mobile access.

- **Category:** crm
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 23
- **Triggers:** 0
- **Slug:** `ASCORA`
- **Version:** 20260307_00

## Tools

### Create Note

**Slug:** `ASCORA_CREATE_NOTE`

Creates a note on an entity (customer, job, quote, etc.) in Ascora. Use this when you need to add comments, updates, or documentation to any entity in the system. Requires a valid entity ID from the Ascora system.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or Update Contact

**Slug:** `ASCORA_CREATE_OR_UPDATE_CONTACT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Email` | string | No | The email address of the contact |
| `Phone` | string | No | The phone number of the contact |
| `LastName` | string | No | The last name of the contact |
| `FaxNumber` | string | No | The fax number of the contact |
| `FirstName` | string | No | The first name of the contact |
| `customerId` | string | Yes | The unique identifier of the customer to associate the contact with (UUID format) |
| `MobileNumber` | string | No | The mobile number of the contact |
| `DefaultContact` | boolean | No | Whether this is the default contact for the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or Update Customer

**Slug:** `ASCORA_CREATE_OR_UPDATE_CUSTOMER`

Tool to create a new customer or update an existing customer in Ascora. Use when you need to add a new customer with company name and optional contact details, address information (street and postal), and communication preferences. If the customer already exists, their details will be updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `CompanyName` | string | Yes | Company name for the customer (required) |
| `PhoneNumber` | string | No | Phone number of the customer |
| `PostalLine1` | string | No | Postal address line 1 |
| `PostalLine2` | string | No | Postal address line 2 |
| `PostalState` | string | No | Postal state |
| `StreetLine1` | string | No | Street address line 1 |
| `StreetLine2` | string | No | Street address line 2 (e.g., unit or suite number) |
| `CustomerName` | string | No | Customer display name (defaults to CompanyName if not provided) |
| `EmailAddress` | string | No | Email address of the customer |
| `MobileNumber` | string | No | Mobile number of the customer |
| `PostalSuburb` | string | No | Postal suburb |
| `StreetSuburb` | string | No | Street suburb |
| `PostalCountry` | string | No | Postal country |
| `StreetCountry` | string | No | Street country |
| `PostalPostcode` | string | No | Postal postcode |
| `StreetPostcode` | string | No | Street postcode |
| `ContactLastName` | string | No | Last name of the contact person |
| `ContactFirstName` | string | No | First name of the contact person |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or Update Supplier

**Slug:** `ASCORA_CREATE_OR_UPDATE_SUPPLIER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | The supplier's fax number |
| `Name` | string | Yes | The name of the supplier |
| `notes` | string | No | Additional notes about the supplier |
| `phone` | string | No | The supplier's phone number |
| `mobile` | string | No | The supplier's mobile number |
| `supplierId` | string | No | The unique identifier for the supplier. Required when updating an existing supplier, omit when creating a new supplier. |
| `postalLine1` | string | No | Postal address line 1 |
| `postalLine2` | string | No | Postal address line 2 |
| `postalState` | string | No | Postal address state |
| `streetLine1` | string | No | Street address line 1 |
| `streetLine2` | string | No | Street address line 2 |
| `streetState` | string | No | Street address state |
| `emailAddress` | string | No | The supplier's email address |
| `postalSuburb` | string | No | Postal address suburb |
| `streetSuburb` | string | No | Street address suburb |
| `businessNumber` | string | No | The supplier's business number (ABN/ACN) |
| `expenseAccount` | string | No | The expense account code for this supplier |
| `postalPostcode` | string | No | Postal address postcode |
| `streetPostcode` | string | No | Street address postcode |
| `supplierNumber` | string | No | The supplier's reference number |
| `contactLastName` | string | No | The last name of the contact person |
| `contactFirstName` | string | No | The first name of the contact person |
| `invoiceDueDaysType` | integer | No | The number of days for invoice due date calculation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Quotation

**Slug:** `ASCORA_CREATE_QUOTATION`

Creates a new quotation/enquiry in Ascora for a customer. Use this tool when you need to submit a quote request with customer details (name, email, contact info), optional address information, work description, and custom fields. Returns a unique entity ID for the created enquiry that can be used to track or reference the quotation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Customer's email address |
| `phone` | string | No | Customer's landline phone number |
| `mobile` | string | No | Customer's mobile phone number |
| `lastName` | string | Yes | Customer's last name |
| `firstName` | string | Yes | Customer's first name |
| `companyName` | string | Yes | Name of the customer's company |
| `addressLine1` | string | No | First line of the address, e.g., street and number |
| `addressLine2` | string | No | Second line of the address, e.g., unit or suite |
| `addressState` | string | No | State or territory of the address, e.g., 'WA', 'NSW' |
| `customFields` | array | No | List of custom field name/value pairs to include with the request |
| `addressSuburb` | string | No | Suburb or city of the address |
| `addressCountry` | string | No | Country of the address |
| `addressPostcode` | string | No | Postal code for the address |
| `enquiryDescription` | string | No | Description of the quote request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `ASCORA_DELETE_CUSTOMER`

Tool to delete a specific customer by ID. Use when you need to remove a customer after confirming its existence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | Unique identifier of the customer to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact

**Slug:** `ASCORA_GET_CONTACT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The unique identifier (UUID) of the contact to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `ASCORA_GET_CUSTOMER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | string | Yes | The unique identifier (UUID) of the customer to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers

**Slug:** `ASCORA_GET_CUSTOMERS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Categories

**Slug:** `ASCORA_GET_INVENTORY_CATEGORIES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Kits

**Slug:** `ASCORA_GET_INVENTORY_KITS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Supplies

**Slug:** `ASCORA_GET_INVENTORY_SUPPLIES`

Retrieves all inventory supplies with pricing and stock information from Ascora. Returns a paginated list of supply items. Use this when you need to list available inventory supplies or access supply details including pricing and stock levels.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job

**Slug:** `ASCORA_GET_JOB`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the job. Accepts both numeric IDs (e.g., '1') and UUID format (e.g., '00000000-0000-0000-0000-000000000001'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jobs

**Slug:** `ASCORA_GET_JOBS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `endDate` | string | No | Filter jobs created on or before this date (ISO 8601 date, YYYY-MM-DD). |
| `jobType` | string | No | Filter by job type, e.g., 'Installation' or 'Service'. |
| `pageSize` | integer | No | Number of jobs per page, between 1 and 1000. |
| `jobStatus` | string | No | Filter by main job status, e.g., 'Open', 'Closed'. |
| `startDate` | string | No | Filter jobs created on or after this date (ISO 8601 date, YYYY-MM-DD). |
| `secondaryStatus` | string | No | Filter by secondary status of the job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote Labour Roles

**Slug:** `ASCORA_GET_QUOTE_LABOUR_ROLES`

Retrieves labour roles available for use in quotes from Ascora. Use this when you need to list available labour roles with their hourly rates for quotation purposes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quotes

**Slug:** `ASCORA_GET_QUOTES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `status` | string | No | Filter by quote status, e.g., 'Draft', 'Sent', 'Accepted', 'Declined'. |
| `endDate` | string | No | Filter quotes created on or before this date (ISO 8601 date, YYYY-MM-DD). |
| `pageSize` | integer | No | Number of quotes per page, between 1 and 1000. |
| `startDate` | string | No | Filter quotes created on or after this date (ISO 8601 date, YYYY-MM-DD). |
| `customerId` | string | No | Filter by customer ID to retrieve quotes for a specific customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote Standard Sections

**Slug:** `ASCORA_GET_QUOTE_STANDARD_SECTIONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quote Standard Stages

**Slug:** `ASCORA_GET_QUOTE_STANDARD_STAGES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supplier

**Slug:** `ASCORA_GET_SUPPLIER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (UUID) of the supplier to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supplier Invoices

**Slug:** `ASCORA_GET_SUPPLIER_INVOICES`

Retrieves supplier invoices from Ascora with optional pagination. Returns invoice details including invoice number, supplier name, dates, amounts, and status. Use this when you need to list, search, or monitor supplier invoices in the Ascora system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `pageSize` | integer | No | Number of supplier invoices per page, between 1 and 1000. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Suppliers

**Slug:** `ASCORA_GET_SUPPLIERS`

Retrieves a list of suppliers from the Ascora system. Returns supplier details including name, contact information (email, phone), address details, ABN, and activity status. Use this when you need to list or search for suppliers in the Ascora system.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Jobs

**Slug:** `ASCORA_SEARCH_JOBS`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `address` | string | No | Search for jobs by address. Supports partial matching. |
| `customer` | string | No | Search for jobs by customer name. Supports partial matching. |
| `pageSize` | integer | No | Number of jobs per page, between 1 and 1000. |
| `jobNumber` | string | No | Search for a specific job by its job number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Attachment

**Slug:** `ASCORA_UPLOAD_ATTACHMENT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | The file to upload as an attachment. Alternatively, use 'local_file_path' instead. |
| `entity_id` | string | Yes | The unique identifier (UUID/GUID format) of the entity to attach the file to. Must be a valid UUID from the Ascora system. |
| `entity_type` | string ("Customer" | "Job" | "Quote" | "Enquiry" | "Invoice" | "PurchaseOrder" | "Asset") | Yes | The type of entity to attach the file to. Must be one of: Customer, Job, Quote, Enquiry, Invoice, PurchaseOrder, or Asset. |
| `local_file_path` | string | No | Absolute path to a local file to upload as the attachment. If provided, the action will read raw bytes from this path instead of the file reference. Useful for testing or when the file is available locally. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |