AXITRAQ Administrator Guide¶
Version: 1.0 Last Updated: 2026-09-21 Applies to: AXITRAQ Platform (axitraq.app)
Introduction¶
This guide is for administrators and company owners who manage an AXITRAQ account. It covers everything you need to configure, secure, and maintain your organisation on the platform — from setting up your company and offices through to managing users, permissions, notifications, and billing.
Whether you are onboarding your team for the first time or fine-tuning your configuration months into using the platform, this manual provides step-by-step procedures for every administrative task available to you.
Who Should Read This Guide¶
- Company Owners — the person who created the AXITRAQ account and holds full administrative control.
- Account owners and managers — the account owner (
owner) has every permission. A manager follows the permission matrix. A company may name a User Type "Admin"; that name is a label on a base level of manager, operator, or viewer. There is noadminlogin class. - IT or Operations Managers — staff responsible for security policy, 2FA enforcement, and platform configuration.
How to Use This Guide¶
Each section is self-contained. Use the table of contents below to jump directly to the task you need. Procedures are written as numbered steps you can follow in order. Tips and best practices are called out where relevant.
Table of Contents¶
- Company Management
- Offices and Branches
- Departments
- Access Management
- User Types and Custom Roles
- Permissions
- Two-Factor Authentication (2FA)
- Notification Settings
- System Settings
- Subscription and Billing (Accounts)
- Audit Logging
- Security Best Practices
- Menu Settings
- Grok Bot connector
1. Company Management¶
Your company profile is the foundation of your AXITRAQ account. It stores your business details, contact information, timezone, and asset prefix configuration.
Location: Manage > Company (/base/manage/company/)
Viewing Company Details¶
The company page displays:
| Field | Description |
|---|---|
| Company Name | Registered business name |
| Trading Name | Name your business trades under (if different) |
| ABN | Australian Business Number |
| ACN | Australian Company Number |
| Domain | Your company's web domain |
| Primary company email address | |
| Phone | Primary company phone number |
| Website | Company website URL |
| Address | Registered business address |
| Owner / Contact | Name of the account owner or primary contact |
| Owner Email | Email address of the account owner |
| Owner Phone | Phone number of the account owner |
| Timezone | Timezone used for scheduling, alerts, and timestamps |
| Asset Prefix | Prefix applied to auto-generated asset codes (e.g., "AXT" produces AXT-0001, AXT-0002) |
| Current Plan | Your active subscription plan, shown as a badge |
| Status | Account status — Active or Inactive |
| Subscription Status | Current subscription standing |
| Billing Cycle | Monthly or Annual billing |
| Next Billing Date | Date of the next scheduled payment |
| Payment Method | Card or payment method on file |
Editing Company Details¶
- Navigate to Manage > Company.
- Click the Edit button, or go directly to
/base/manage/company/edit/. - Update any of the fields listed above.
- Click Save to apply your changes.
Tip: Set your Asset Prefix early. This prefix is used when AXITRAQ automatically generates asset codes for new assets. Changing it later will only affect newly created assets — existing asset codes remain unchanged.
Tip: Ensure your timezone is correct. It affects when scheduled notifications fire, how timestamps appear in reports, and when cron-based alerts (such as registration expiry checks) run relative to your local time.
2. Offices and Branches¶
Companies can have multiple offices or branches. Offices help you organise your operations by physical location and are referenced when assigning employees, assets, and departments.
Location: Manage > Company (/base/manage/company/)
Adding an Office¶
- Navigate to Manage > Company.
- Scroll to the Offices section.
- Click Add Office.
- Enter the office Name (e.g., "Sydney Head Office", "Brisbane Depot").
- Start typing the office Address Line 1 — Google's address suggestions will appear in a dropdown. Pick the matching result and AXITRAQ fills in Line 2, City, State, Postcode, Country and Latitude/Longitude automatically. If Google can't find the address you can keep typing and enter the details manually.
- Click Save.
Editing an Office¶
- In the Offices section, click Edit next to the office you want to modify.
- Update the name or address.
- Click Save.
Deleting an Office¶
- Click Delete next to the office.
- A confirmation prompt will appear to prevent accidental deletion.
- Confirm the deletion.
Tip: Before deleting an office, check whether any employees, assets, or departments are still assigned to it. Reassign them first to avoid orphaned records.
3. Departments¶
Departments allow you to organise your workforce and assets into logical groups. AXITRAQ supports hierarchical departments, so you can nest sub-departments under parent departments to reflect your organisational structure.
Location: Settings → Offices & Departments (/base/manage/settings/?tab=offices). The sidebar item Departments opens that same page.
Department Fields¶
| Field | Description |
|---|---|
| Name | Department name (e.g., "Maintenance", "Fleet Operations") |
| Code | Short code for internal reference |
| Description | Optional description of the department's function |
| Status | Active or Inactive |
| Parent Department | Optional — select a parent to create a hierarchy |
Creating a Department¶
- Navigate to Settings → Offices & Departments (or the sidebar item Departments).
- Click Add Department.
- Fill in the Name, Code, and Description.
- If this is a sub-department, select a Parent Department from the dropdown.
- Set the status to Active.
- Click Save.
Editing a Department¶
- Click Edit next to the department in the list.
- Make your changes.
- Click Save.
Deleting a Department¶
- Click Delete next to the department.
- Confirm the deletion in the prompt.
All create, update, and delete operations on departments are recorded in the audit log.
Plan Quotas¶
Your subscription plan limits the number of departments you can create. If you reach your limit, the platform will display a message indicating your current count, the plan limit, and a prompt to upgrade. Check your plan's department allowance under Accounts → AXITRAQ → Services.
Tip: Use the hierarchical structure to keep your department list manageable. For example, rather than creating "Maintenance — Sydney" and "Maintenance — Brisbane" as separate top-level departments, create a "Maintenance" parent and nest location-specific departments beneath it.
4. Access Management¶
Every login on AXITRAQ is bound to an employee or contractor record — the person and the login are one and the same. The Access screen is a quick view of every person in your company who has a working login, with their permissions, status, last sign-in, and 2FA state.
Location: Manage > Access (/base/manage/users/)
Email is the login identity¶
Each person logs in with their email address. The system keeps email and username synchronised automatically, so there is only ever one identifier to remember. If a person's email changes, update it on their employee record and they will use the new address from the next sign-in.
Access List¶
| Column | Description |
|---|---|
| Name | The person's name (clicks through to their employee/contractor record) |
| Email (Username) | The address they sign in with |
| User Type | Displayed as a role badge (e.g., "Admin", "Fleet Manager") |
| Status | Active, Locked, or Inactive |
| Last Login | Date and time of the most recent sign-in |
| 2FA | "On" or "Off" |
| Actions | Permissions and Edit |
Granting Access (adding a new person + login)¶
Because logins are inseparable from employee/contractor records, the workflow always starts with the person:
- Add the person under Manage > Employees (or Manage > Contractors for external workers).
- Open their record and select the User Account tab.
- Click Create Login Account, enter the password, choose user type and permissions.
- Save. They can now sign in with their email address.
The Access screen will then show them in the list automatically.
Editing a User¶
From the Access screen, click the person's name (or the Edit button) — this opens their employee or contractor edit page directly on the User Account tab, where you can change password, role, status, 2FA, default landing section, and trusted devices.
Locking and Unlocking Users¶
To temporarily prevent a user from logging in without deleting their account:
- Edit the user.
- Change the Status to Locked.
- Save.
The user will be unable to log in until an administrator changes their status back to Active. Locked users retain all their data, permissions, and history.
Deactivating a User¶
To permanently remove a user's access:
- Edit the user.
- Change the Status to Inactive.
- Save.
Inactive users cannot log in and do not count towards your plan's user quota.
Tip: Prefer locking over deactivating when the situation is temporary (e.g., an employee on extended leave). Deactivate accounts only when the person has permanently left the organisation.
5. User Types and Custom Roles¶
AXITRAQ provides a flexible role system with built-in user classes and the ability to create unlimited custom roles.
Built-In User Classes¶
| Class | Scope | Access |
|---|---|---|
owner |
Single company | Full access to all sections automatically. The account holder. |
manager |
Single company | Access determined by permissions assigned per person. |
operator |
Single company | Designed for field workers using the Mobile App or tablet app. |
viewer |
Single company | Read-only base level. Access still follows the permission matrix. |
Owner users always have access to every section of the platform. Their permissions cannot be restricted.
Creating Custom Roles¶
Custom roles let you define named positions (e.g., "Fleet Manager", "Warehouse Lead", "Site Supervisor") with pre-configured default permissions.
- Navigate to Manage > Settings.
- Open the User Types tab.
- Click Add Role.
- Enter the role Name and Description.
- Select a Base Permission Level — this determines which permissions are turned on by default when a user is assigned this role.
- Configure the default permissions for each section.
- Click Save.
Applying Default Permissions¶
After creating or updating a custom role, you can push its default permissions to all users currently assigned that role:
- Open the role in Settings > User Types.
- Click Apply Defaults.
- All users with this role will have their permissions updated to match the role's default set.
Tip: Use custom roles to standardise access across your organisation. When a new Fleet Manager starts, assign them the "Fleet Manager" role and their permissions are already configured.
6. Permissions¶
Permissions control which sections of the platform a person can see and interact with. The account owner always has full access. Managers, operators, and viewers follow this matrix. A User Type named Admin does not bypass it.
Location: Manage → Access → Permissions (/base/manage/users/permissions/?id=X). The same screen is linked from the person's User Account tab. Settings → User Types stores the default matrix for a role; Apply Defaults copies it onto people who have that type. The sidebar item is Access, not Users. Both names in older notes point at /base/manage/users/.
How Permissions Work¶
For manager, operator, and viewer logins, each section has View, Create, Edit, and Delete. When View is off, the sidebar item is hidden and the URL is blocked.
Available Permission Sections¶
| Section Key | Controls Access To |
|---|---|
dashboard |
Main dashboard and widgets |
audit |
Audit app interface |
manage.assets |
Assets |
manage.parts |
Parts & Materials (including who can delete an item's photos — controlled by the Delete right) |
manage.employees |
Employee management |
manage.contractors |
Contractor management |
manage.clients |
Client management |
manage.checklists |
Checklists and forms |
manage.labels |
Labels and QR codes |
manage.inspections |
Inspections |
manage.registration |
Registration and compliance |
manage.timesheets |
Timesheets |
manage.jobs |
Jobs, scheduling, calendar views, and templates |
manage.quotes |
Quotes & Estimations (list, editor, templates, quote settings). View/Create/Edit/Delete control access, new quotes, editing, and soft-delete |
manage.trips |
Navigation — Trips (route builder, assignments, NHVR advisory). Distinct from Menu Settings (manage.navigation) |
manage.manuals |
Manuals & Documents hub (List/Folders views, nested folders, multi-entity SDS/manuals) — see Manuals and Documents |
manage.qualifications |
Qualifications matrix |
manage.reports |
Reports and analytics |
manage.orders |
Label shop orders |
manage.purchase_orders |
Purchase orders |
manage.users |
User management |
manage.notifications |
Notification settings |
manage.messaging |
Messaging and SMS |
manage.sticky_notes |
Sticky Notes (web header notes, share, and the Communication register). View / Create / Edit / Delete control the register, the header pen, changing a note, and soft-delete |
manage.settings |
System settings |
app |
Mobile app |
Setting Permissions for a User¶
- Navigate to Manage → Access.
- Click Permissions next to the person.
- On the Web Access tab, toggle each section's View / Create / Edit / Delete rights.
- On the Dashboard Widgets tab, tick which dashboard widgets this login may add and view (grouped as Overview, Operations, Inventory, Financial, Messaging).
- Use the Purchase and Mobile tabs for purchase targets and Operations App capabilities.
- Click Save on the tab you edited.
The sidebar dynamically updates to show only the sections the user has permission to access. Users will not see navigation items for sections they cannot access. Widgets they are not granted do not appear in the dashboard widget picker and will not load data.
Dashboard Widget Permissions
Each widget has its own view toggle (for example dashboard.widget.fuel_overview). Owners always see every widget. Restrict financial or cost widgets for Managers/Supervisors who should not see business-sensitive figures, even if they can still open Assets or Jobs.
Jobs Permission
The Jobs module now has its own dedicated permission (manage.jobs), separate from Employees. Users need the Jobs permission to access the Jobs list, calendar, and scheduling features. Existing users who had the Employees permission were granted the Jobs permission when the two were split.
Tip: Start with the minimum permissions a user needs to do their job, then add more as required. This follows the principle of least privilege and keeps your platform secure.
Tip: When multiple users share the same responsibilities, use custom roles (see Section 5) to apply a consistent permission set rather than configuring each user individually.
7. Two-Factor Authentication (2FA)¶
AXITRAQ supports two-factor authentication using the TOTP standard (RFC 6238). 2FA adds a critical layer of security by requiring a time-based 6-digit code in addition to the password at login.
Supported Authenticator Methods¶
| Method | Description |
|---|---|
| AXITRAQ Mobile App | The AXITRAQ app itself acts as the authenticator. Enrollment is automatic via API — no QR code scanning needed. |
| External Authenticator | Google Authenticator, Authy, Microsoft Authenticator, or any TOTP-compatible app. Enrollment uses a QR code. |
Both methods produce the same 6-digit codes and are fully interchangeable from the platform's perspective.
Enforcing 2FA for a User¶
- Open the person from Manage → Access (or from Employees / Contractors) and use the User Account tab.
- Enable the Require 2FA checkbox.
- Save.
When 2FA is required: - The account owner and every manager are sent to the 2FA setup page on every web login until they enrol. There is no Admin login class. - Anyone else is sent there only when Require 2FA is ticked on their User Account. - The user must enrol with either the AXITRAQ app or an external authenticator before they can proceed.
How Users Enrol in 2FA¶
Users self-enrol from My Account > Two-Factor Auth:
- Click Enable Two-Factor Authentication.
- Choose a method — AXITRAQ App or External Authenticator.
- AXITRAQ App path: Open the AXITRAQ mobile app and refresh the Home Screen. The app detects the pending enrollment and displays a 6-digit code. Enter the code on the web form.
- External Authenticator path: Scan the displayed QR code with the authenticator app. Enter the 6-digit code shown in the authenticator.
- Upon successful verification, 2FA is activated and 8 backup codes are displayed. These are shown once only — the user must save them securely.
Resetting 2FA for a User¶
If a user loses access to their authenticator and their backup codes:
- Open the person from Manage → Access and use the User Account tab.
- Click Reset 2FA.
- This deletes the user's 2FA enrollment and clears the requirement.
- The user will need to re-enrol on their next login if 2FA is still required by policy.
Backup Codes¶
Each user receives 8 single-use backup codes when they enrol in 2FA. These codes can be used in place of the 6-digit authenticator code if the user cannot access their authenticator. Backup codes can be regenerated from My Account > Two-Factor Auth (requires a current TOTP code to regenerate).
Trusted Devices¶
Users can mark a browser as "trusted" during 2FA verification. Trusted devices bypass the 2FA prompt on subsequent logins.
- Users can view and revoke their trusted devices from My Account > Trusted Devices.
- Administrators can view and revoke a user's trusted devices from the user's edit page.
Tip: Enforce 2FA for all admin, owner, and manager-level users as a minimum. Consider enforcing it organisation-wide for maximum security.
Tip: Remind users to store their backup codes in a secure location (password manager, printed copy in a safe). If they lose both their authenticator and backup codes, only an administrator can reset their 2FA.
8. Notification Settings¶
AXITRAQ provides a configurable notification system that alerts the right people about important events. Administrators control which notification types are active and how they are delivered.
Location: Manage > Notifications (/base/manage/notifications/)
Notification Types¶
| Type | Description |
|---|---|
| Maintenance Request | New maintenance requests submitted and status updates on existing ones |
| Maintenance Overdue | Maintenance requests that have passed their due date without resolution |
| Timesheet Submitted | An employee has submitted a timesheet for approval |
| Timesheet Approved | A timesheet has been approved or rejected |
| Inspection Due | A scheduled inspection is approaching its due date |
| Inspection Failed | An inspection has returned a fail result |
| Registration Expiry | An asset's registration is approaching its expiry date |
| Qualification Expiry | An employee's qualification or licence is approaching its expiry date |
| Checklist Submitted | A pre-start or post-stop checklist has been submitted |
| Asset Status Change | An asset's status has been changed (e.g., from Active to Out of Service) |
Delivery Channels¶
Each notification type can be delivered through one or more channels:
| Channel | Description |
|---|---|
| Sent to the user's registered email address using branded AXITRAQ templates | |
| In-App | Appears in the notification feed on the dashboard and as a badge on the sidebar bell icon |
| SMS | Sent via Twilio to the user's mobile number. Only available if SMS is enabled for your company. |
Configuring Notification Preferences¶
- Navigate to Manage > Notifications.
- For each notification type, toggle the desired delivery channels on or off.
- Save your changes.
Users can also adjust their own notification preferences from their account settings, within the boundaries set by the administrator.
Tip: Enable email notifications for critical alerts like Registration Expiry and Qualification Expiry. These are time-sensitive compliance items that should not be missed.
Tip: If your company uses Twilio SMS, reserve SMS notifications for genuinely urgent items (Inspection Failed, Maintenance Overdue). Overusing SMS can lead to alert fatigue and increased costs.
9. System Settings¶
The Settings page provides company-wide configuration options in a left-hand menu (Company, Operations, Communication, Access, Data) so you do not need to scroll a top tab bar. Click a section to open it. Asset Fields, Encryption, and Email open their own pages. ?tab= links still work. Preferences keeps its JOBS / PAYROLL / REGION / ASSETS inner tabs.
Location: Manage > Settings (/base/manage/settings/)
Settings Tabs Overview¶
| Tab | Purpose |
|---|---|
| General | About AXITRAQ, Account Owner transfer/assign |
| Employment | Awards, Superannuation Funds, Tax Categories |
| Preferences | Sub-tabs: JOBS (default working hours, job time increments), PAYROLL (pay period and start of week), REGION (timezone, units of measure, distance & odometer), and ASSETS (which Rate Card methods appear, and which extra columns the Assets list shows) |
| Offices & Departments | Offices, branches, and departments |
| Job Types | Custom job type management |
| Reward Rules | Employee reward point configuration |
| Billing & Invoicing | Invoice prefix / next number, tax & payment defaults, and Invoice Templates (four page roles: Single / First / Middle / Last — each with its own background PDF and field layout; hide or add fields per page). Used by the Jobs schedule Invoice tab |
| User Types | Custom role names and their default permissions |
| API Keys | REST API keys, plus Reckon, Xero, Zoho Books, and MYOB (coming soon). A company can connect only one accounting system. Xero, Zoho Books and MYOB offer Request Access. Reckon is available when AXITRAQ has switched it on for the company. Other accounts see the fields greyed out and can request access. |
| Menu Settings | Sidebar labels, icons, order, and hidden items. Shown when you can edit navigation. Also at /base/manage/navigation/ |
| Support Access | Time-boxed grants for AXITRAQ staff. The account owner can always open this and grant access. Support Access view can read the history. Support Access edit can grant, approve, deny, and revoke. |
| Data Export | Owner-only data export and erasure requests |
These open their own page from the Settings menu, not a panel inside the tab list:
| Page | Purpose |
|---|---|
| Asset Fields | Asset categories and which fields each category shows |
| Company mailbox for Accounts inbox (IMAP receive + SMTP send). Host, port, and encryption are entered per account | |
| Grok Bot | Allow each person to connect their own Grok Bot. Settings > Grok Bot |
| Encryption | Encryption settings for sensitive documents |
| System Info | Platform version and storage (platform admin only) |
Email (Accounts inbox)¶
Location: Settings → Email (/base/manage/settings/email.php)
Anyone with Settings access can add, test, and save mailbox credentials (Owner, Manager, or a user granted Settings). Use this when the Owner is not the person who configures IT.
- Open Settings → Email.
- Under Accounts inbox, choose a provider preset if it helps (cPanel / NS3 is the default for mailboxes hosted on our cPanel servers). You can still edit every host, port, and encryption field.
- Enter the email address, IMAP and SMTP host/port/encryption, usernames, and passwords. Typical cPanel values:
- IMAP
mail.yourdomain.com.auport 993 SSL, or port 143 STARTTLS - SMTP
mail.yourdomain.com.auport 465 SSL, or port 587 STARTTLS - Username is usually the full email address
- Click Test IMAP and Test SMTP (these run from the AXITRAQ servers, not your browser).
- Tick Enable polling and Save Accounts inbox.
AXITRAQ then checks the mailbox every few minutes. A PDF is scanned only when it is an invoice, credit note, delivery docket, or statement and it clearly names this account: the company name, trading name, an active or inactive quote brand (for example Smith Plumbing), or the company ABN. Anything else stays under Accounts → Email Inbox → Processed NA and is not sent to Vendor Invoices. That includes emails with no invoice PDF, remittances, and invoices billed to another business. Those other-business invoices are highlighted orange, and the row shows who they were billed to when the PDF says so. Preview on a Processed NA row that has a PDF opens the file from the mailbox so you can read it before deciding. Process as invoice on a Processed NA row sends that PDF to Vendor Invoices anyway — use it when the bill is yours but the business name was not detected. A message that only has a view-invoice link (no file) stays under Needs PDF, except a public MYOB PayDirect link: that page is opened and each invoice PDF is saved as its own vendor invoice. A link that asks for a login still stays under Needs PDF. On Processed NA, Needs PDF, and Failed, Archive hides an email from that list (or Archive all clears the list). The message stays stored so the mailbox poll does not import it again. Restore it from Archived. When a message has an accepted PDF that names this account, the file goes to Accounts → Vendor Invoices → Pending Review and the email moves to Email Inbox → Completed, highlighted green so you can see it landed. A statement of account PDF is kept under Vendor Invoices → Statements (not Pending Review) and is not treated as a bill. Images (.jpg, .png) and other attachments are not treated as invoices. OCR also reads a Customer PO on the PDF (or PO-YYYY-NNNNN in the email subject) and links the invoice to an open AXITRAQ purchase order and its job when the match is unique. Supplier contacts, account details, balances, and price lists are on Accounts → Vendors (the same register as Parts & Materials).
Passwords are stored encrypted and are never shown again. Leave the password fields blank when saving other changes to keep the current password.
Send invoices and Client messaging mailboxes are reserved for a later release.
Reckon Accounts Hosted¶
Location: Settings → API Keys → Reckon
Only an Owner or Manager can run this wizard. It connects AXITRAQ to Reckon Accounts Hosted (the streamed desktop product — not Reckon One, and not a file that only lives on an office PC). Complete the steps in order. You can save Hosted UserID and file details before Connect is available.
- Confirm you have a Reckon Accounts Hosted subscription and can sign in at hosted.reckon.com.
- Open Control Panel → Manage Users and copy the blue UserID. It looks like
1234567-1. This is not the username you type every day. - Launch Accounts, open the company file, and create a company-file user named AXITRAQ with Full Access and a password (Company → Users → Set Up Users and Passwords → Set Up Users). This password is separate from your Hosted website login.
- Switch the file to Multi-user, close it, and log off the Hosted / AppStream session. Reckon refuses the API if a desktop session is still holding the file.
- In AXITRAQ, enter the Hosted UserID, the Q: file path from Ctrl+1 (Product Information) — for example
Q:\Your Company Pty Ltd.QBW— plus the AXITRAQ file username and password. Click Save Hosted UserID and file details. - When Connect is enabled, click Connect Reckon. Sign in at Reckon Identity with the Hosted UserID from step 2 and approve access.
- Stay logged off Hosted, then click Test connection. AXITRAQ refreshes the token, checks Heartbeat, lists your company files, and runs a CompanyQuery against the saved Q: path. After the first live sync, this page also shows the mapped default income / COGS / AP account names.
Once connected, live Reckon writes run only when someone clicks them — nothing is sent automatically:
- Clients — a Reckon column (next to Status) plus Sync on the list and on the client Details tab. Sync uses the linked Reckon card. A client with no link uses an existing Reckon card of the same name, and a new card is created only when Reckon has none. Client cards can be loaded from the Reckon file so sales invoices do not create a second card.
- Job Modal → Invoice — Create Invoice (after Preview) writes the sale to Reckon with customer tax code GST and the AXITRAQ line descriptions. Reckon’s invoice number and exact tax/total are copied onto the AXITRAQ invoice and PDF (same pattern as Zoho Books). The invoice then appears under Accounts → Sales Invoices → Invoiced and can be downloaded there or from the Job Modal Invoice list. Preview PDF and Save Draft Invoice & Download stay local. If Reckon fails, AXITRAQ still saves a local draft so you can retry.
- Accounts → Vendor Invoices → Approved — Sync creates the vendor in Reckon if missing (ABN, address, contact), adds catalogue parts as Non-inventory items (part number, description, purchase cost), then posts the bill. Success moves it to Synced. APPROVED only queues; a failed Sync stays Approved.
Stay logged off Hosted while Sync or Create Invoice runs. Sales invoices use customer tax code GST; AXITRAQ copies Reckon’s tax and total so the PDF matches the file.
Tip: Keep Hosted logged off when you expect bills to go through. You can still use Accounts during the day — log off again afterwards.
Account Owner¶
Each company has one Account Owner seat. Transfer or assign it under Settings → General → Account Owner (password confirmation required). Administrators who signed up on behalf of the business see an Assign an Account Owner banner until this is completed. Do not demote the Owner from an employee User Account tab — use transfer instead.
Preferences¶
Open Settings > Preferences. Four sub-tabs organise company defaults:
JOBS¶
| Setting | Purpose |
|---|---|
| Default Working Hours | Default daily start and finish times used when scheduling multi-day jobs |
| Job Time Increments | Minute steps (15 or 30) for Start/End date & time pickers on new and edit job |
| On-Call / Roster Label | Name shown on the Jobs Schedule for all-day roster blocks (default On-Call) |
| On-Call Period Types | Optional clock windows and labour labels. A roster can link to a type so timesheet start times in that window are labelled (and optionally charged after-hours). Rosters with no type stay visual-only |
PAYROLL¶
| Setting | Purpose |
|---|---|
| Pay Period | Weekly, Fortnightly, or Monthly. Used by Timesheets summary, WW Bank period, Hours Bank, Summary PDF, and Detail PDF |
| Start of Week | First weekday of the pay week (Monday–Sunday). Example: weekly starting Wednesday runs Wednesday through the following Tuesday |
| Fortnight start date | Any date that is the first day of a known fortnight (snapped to Start of Week) |
| Month starts on day | Day of month a monthly period starts (1–28) |
The page shows a live preview of the current period. Until a company saves this, the default is weekly Monday to Sunday.
REGION¶
| Setting | Purpose |
|---|---|
| Timezone | Account timezone for scheduling, timestamps, reports, and notifications |
| Units of Measure | Which units appear in dropdowns across the account |
| Distance & Odometer | Default distance unit (km or miles); individual assets can override |
ASSETS¶
| Setting | Purpose |
|---|---|
| Asset Rate Card | Which billing methods appear on an asset: Standard Period & Rate, Usage Allowance & Overage, Drill / Shot Types, and Equipment rental (daily, weekly, monthly). Drill stays available for a company that already uses it until you turn it off. Equipment rental stays hidden until you turn it on. Turning a method off does not change assets that already use it. |
| New asset defaults | Category and department pre-selected on Add Asset. Leave them blank and Add Asset stays as it is today. Existing assets are not changed. |
| Asset list columns | Extra columns on the Assets list: Location, Last Used, Hours, Rego Due, and your own asset fields (under Your asset fields). Tick Show to display a field, click its heading on the Assets list to sort, and use the new filter for a dropdown, text or number field. The same shown fields appear on the Asset Book asset picker. Code, Name, Category, Department, Status, Linked and Photo stay. |
Employment Configuration¶
The Employment tab manages three types of records used across employee profiles:
Awards¶
Awards represent employment awards or agreements that apply to your workforce (e.g., "Building and Construction General Award").
- Open Settings > Employment.
- In the Awards section, click Add Award.
- Enter the award Name, Code, and Description.
- Click Save.
Awards can be assigned to individual employees on their profile page. Edit or delete existing awards from the same section.
Superannuation Funds¶
Track the superannuation funds your employees contribute to.
- In the Superfunds section, click Add Superfund.
- Enter the fund Name, USI (Unique Superannuation Identifier), and ABN.
- Click Save.
Tax Categories¶
Define tax categories for payroll classification.
- In the Tax Categories section, click Add Tax Category.
- Enter the category Name, Code, and Description.
- Click Save.
Tip: Configure your awards, superfunds, and tax categories before onboarding employees. This ensures the correct options are available when setting up employee profiles and avoids having to go back and update records later.
API Keys¶
If your organisation integrates AXITRAQ with external systems (payroll, ERP, custom tools), you can create REST API keys from the API Keys tab.
- Open Settings > API Keys.
- Click Create API Key.
- Assign scopes to the key (e.g.,
assets:read,employees:read,timesheets:read,reports:read). - Set an optional expiry date and rate limit.
- Save the key. The full key is displayed once — copy and store it securely.
API keys authenticate via Bearer token or X-API-Key header. Full API documentation is available at /api/v1/docs.
The same page has tabs for Reckon, Xero, Zoho Books, and MYOB. A company can connect only one of them. Xero and Zoho Books show Request Access. MYOB says coming soon and also has Request Access. If Reckon is already connected, the other tabs say so and do not offer a second system. When Reckon is already switched on, the other tabs say so and do not offer a second system. Accounts that are not switched on see the Reckon fields greyed out and can request access. The older Reckon address still opens the Reckon tab.
Tip: Create separate API keys for each integration with only the scopes it needs. This limits the impact if a key is compromised. Revoke keys immediately when an integration is decommissioned.
Encryption Settings¶
AXITRAQ supports customer-level encryption for sensitive documents. The Encryption tab allows you to manage which document types are encrypted at rest.
Default encrypted document types include licences, certificates, qualifications, identification documents, and signatures. Encryption is transparent — files are encrypted on upload and decrypted on download with no action required from users.
10. Subscription and Billing¶
Your subscription determines the resources available to your organisation — how many users, assets, departments, and other entities you can create.
Viewing Your Subscription¶
Your current plan and billing details are displayed under Accounts → AXITRAQ → Services:
- Current Plan — the plan name stored for the company. The public catalogue is Starter, Basic, Standard, Premium, and Custom
- Billing Cycle — Monthly or Annual
- Next Billing Date — when your next payment is due
- Payment Method — the card or payment method on file
- Subscription Status — Active, Trial, Suspended, Cancelled, or Expired
Plan Quotas¶
Each plan defines limits for key resources:
| Resource | Starter | Basic | Standard | Premium | Custom |
|---|---|---|---|---|---|
| Monthly | $29 | $49 | $99 | $199 | From $199, then per extra unit |
| Offices | 1 | 1 | 2 | 4 | Premium floor, then overage |
| Departments | 1 | 2 | 5 | 8 | Premium floor, then overage |
| Managers | 1 | 2 | 4 | 8 | Premium floor, then overage |
| Employees | 10 | 20 | 40 | 80 | Premium floor, then overage |
| Contractors | 5 | 10 | 20 | 40 | Premium floor, then overage |
| Assets | 100 | 250 | 750 | 1,500 | Premium floor, then overage |
| Parts | 400 | 800 | 1,400 | 2,800 | Premium floor, then overage |
Starter has no trial. Basic, Standard, Premium, and Custom include a 30-day trial. Change Plan on Accounts → AXITRAQ lists the public plans by the name stored for each plan. Custom starts at the Premium quantities and adds a charge for each unit above that floor.
When you reach a quota limit, the platform displays a clear message showing your current count, the plan limit, and a prompt to upgrade.
Updating Your Payment Method¶
The card is changed under Accounts → AXITRAQ → Wallet, on Payment Card, with Update Credit Card or Add Credit Card. Plan and billing dates are on Accounts → AXITRAQ → Services. Company → Edit does not hold the tenant card form.
Changing Your Plan¶
- On the Company page, click Change Plan.
- A plan comparison modal displays available plans and their quotas.
- Select your desired plan.
- Confirm the change.
Plan changes take effect immediately. If upgrading, the new quotas are available right away. If downgrading, ensure your current usage is within the new plan's limits first.
Cancelling Your Subscription¶
- On the Company page, click Cancel Subscription.
- A confirmation prompt explains what will happen.
- Confirm the cancellation.
After cancellation, your account remains accessible until the end of the current billing period. You can reactivate at any time before it expires.
Invoice History¶
Invoice history is available on the Company page. You can view and download every past tax invoice — subscription, SMS wallet top-ups, line rentals and one-off supply orders — with amounts and payment dates.
Tip: Annual billing saves 15% compared to monthly billing. If you are committed to using AXITRAQ long-term, switching to annual billing reduces your costs.
11. Audit Logging¶
AXITRAQ maintains a comprehensive audit trail of administrative actions. Every significant change is logged with the action type, the user who performed it, a timestamp, and a description of what changed.
What Is Logged¶
- User account creation, updates, and deactivation
- Permission changes
- Department creation, updates, and deletion
- Company detail changes
- Settings modifications
- 2FA enrollment and resets
- Login attempts (successful and failed)
- Asset, employee, and contractor record changes
Viewing the Audit Log¶
The audit log is accessible from Manage > Audit (requires the audit permission). Entries include:
| Field | Description |
|---|---|
| Timestamp | When the action occurred |
| User | Who performed the action |
| Action | The type of action (create, update, delete, login, etc.) |
| Description | A detailed summary of what changed |
| User Agent | The browser or device used |
Tip: Review the audit log periodically for unexpected activity — particularly failed login attempts, permission changes, and user account modifications. This is a key part of maintaining your platform's security posture.
12. Security Best Practices¶
Maintaining a secure AXITRAQ environment is a shared responsibility between the platform and your organisation. The following recommendations will help you protect your account and data.
User Account Security¶
- Enforce 2FA for all privileged users. At minimum, all admin, owner, and manager-class users should have 2FA enabled. Consider enforcing it organisation-wide.
- Use strong, unique passwords. AXITRAQ enforces password complexity requirements, but remind users not to reuse passwords from other services.
- Deactivate accounts promptly. When someone leaves your organisation, deactivate their user account immediately. Do not wait — an active account for a departed employee is a security risk.
- Review trusted devices. Periodically audit the trusted devices list for your users. Revoke any devices that are no longer in use or recognised.
Permission Management¶
- Apply the principle of least privilege. Grant each user only the permissions they need to perform their role. Start minimal and add permissions as needed.
- Use custom roles for consistency. Define roles for common positions and apply them using the User Types feature. This prevents permission drift between users with the same responsibilities.
- Audit permissions regularly. At least quarterly, review user permissions to ensure they still align with each person's current role. People change roles, and permissions should change with them.
Monitoring and Response¶
- Review the audit log. Check for unusual patterns — failed logins from unexpected locations, after-hours permission changes, or bulk record modifications.
- Act on failed login alerts. Multiple failed login attempts for a single user may indicate a brute-force attack. AXITRAQ rate-limits login attempts (10 per 15 minutes), but you should still investigate persistent failures.
- Keep notification channels active. Ensure critical notifications (maintenance overdue, inspection failed, registration expiry) are reaching the right people. Missed alerts can lead to compliance gaps.
Data Protection¶
- Enable document encryption. Use the customer-level encryption feature (Settings > Encryption) for sensitive documents like licences, certifications, and identification records.
- Limit API key scope. When creating API keys for integrations, grant only the scopes the integration requires. Set expiry dates and revoke unused keys.
- Back up your backup codes. Remind all 2FA-enabled users to store their backup codes securely. Lost backup codes combined with a lost authenticator will require an administrator to reset 2FA access.
Quick Reference¶
Key URLs¶
| Page | URL |
|---|---|
| Company Management | /base/manage/company/ |
| Edit Company | /base/manage/company/edit/ |
| Departments | /base/manage/settings/?tab=offices (sidebar Departments redirects here) |
| User List | /base/manage/users/ |
| Add User | /base/manage/users/add/ |
| Edit User | /base/manage/users/edit/?id=X |
| User Permissions | /base/manage/users/permissions/?id=X |
| Notifications | /base/manage/notifications/ |
| Settings | /base/manage/settings/ |
| Reckon Accounts Hosted | /base/manage/settings/?tab=apikeys&sub=reckon |
| My Account | /base/account/ |
| API Documentation | /api/v1/docs |
User Class Summary¶
| Class | Full Access | Permissions Configurable | Typical Use |
|---|---|---|---|
| Owner | Yes | No (always full) | Account holder |
| Manager | No | Yes | Department heads, supervisors |
| Operator | No | Yes | Field workers, drivers, operators |
| Viewer | No | Yes | Read-only base level |
Notification Type Reference¶
| Type Key | Trigger |
|---|---|
maintenance_request |
New request or status update |
maintenance_overdue |
Request past due date |
timesheet_submitted |
Employee submits timesheet |
timesheet_approved |
Timesheet approved or rejected |
inspection_due |
Upcoming scheduled inspection |
inspection_failed |
Inspection result is fail |
rego_expiry |
Registration approaching expiry |
qualification_expiry |
Qualification approaching expiry |
checklist_submitted |
Pre-start checklist submitted |
asset_status_change |
Asset status changed |
13. Menu Settings¶
Menu Settings lets you customise the main web sidebar — rename items (full and short labels), change icons, set colours, reorder, hide things you don't use, and add company-wide external links. It lives on the Settings page under the Menu Settings tab (Administration → Settings → Menu Settings). This is separate from the Navigation → Trips module.
Three Scopes¶
| Scope | Who Can Edit | Who Sees the Change |
|---|---|---|
| Company-wide default | Owners and Super Users (or anyone you grant the Menu Settings (company-wide default) permission) |
Every user in the company — unless they have a personal override |
| My personal customisation | Any user with the Menu Settings (personal) permission (granted by default to all existing users) |
Only that user |
| Specific user | Owners, Super Users, and Managers who can edit company-wide menus or User Management | Only the selected login — written as their personal override |
A user's personal customisation sits on top of the company default, which sits on top of the platform default — exactly like CSS cascading. Reset at either layer falls back to the layer beneath.
Use Specific user when you want to arrange one employee's sidebar from your own login (for example setting up an operator menu without signing in as them). Search or pick the login, edit the live preview, then Save changes. That writes their personal menu only — it does not change company-wide or your own menu. Users who already have a personal menu show (customised) in the list. Reset on that scope clears their personal override so they inherit the company default again.
What You Can Customise¶
For each item (click the item in the live preview to open the editor modal):
- Label — rename "Timesheets" to "Time Clock", "Jobs" to "Work Orders", etc. When the menu is collapsed, items show as icons only (hover for the full name).
- Background colour — bubble-style palette of preset colours, or transparent.
- Icon — pick from a grid of the platform's real icons (including the QR icon for QR Register).
- Text & icon colour (advanced) — set a foreground colour so the glyph and label always have contrast against the background.
- Coloured button style (advanced) — when ticked, the background colour wraps the whole row as a rounded pill (matches the Monday/ClickUp style).
- Hide from sidebar (advanced) — remove from sidebar without losing permission access.
For each section:
- Rename full title and short title (short title appears when the menu is collapsed), hide, reorder.
- Delete (custom sections only — platform sections always exist if they have visible items).
- Create new custom sections (drag items into them).
For admins only:
- + Add Custom Link — add a company-wide URL (e.g. your intranet, SharePoint, internal wiki) to any section. URLs must start with
http://orhttps://.
How to Use the Editor¶
- Go to Settings → Menu Settings.
- If you're an admin, pick the scope at the top: My personal (just you), Company-wide (everyone), or Specific user (one login — then choose them from the list).
- Click any item in the live preview to open the Edit menu item modal. Edit label/colour/icon, then click Save changes on the modal. Click outside the modal or press Esc to cancel.
- Click any section title to open the Edit section modal — rename full/short titles, hide, or (for custom sections) delete.
- Drag items by their right-side handle (⋮⋮) to reorder within a section or move between sections. Drag the section handle to reorder whole sections.
- Click "+ Add custom link" (admins only) under a section to add an external URL.
- Click "+ Add Section" in the preview header to create a new custom section.
- When you're happy with the layout, click Save changes at the top to persist. Reload any other page to see the new sidebar in action.
- To undo: click Reset at the top — wipes the current scope's customisation and falls back to the layer beneath.
Permission Safety¶
Hidden items, renamed items, and customisations never grant access. If a user does not have permission to view, say, Timesheets, no amount of renaming or repositioning will surface the Timesheets item in their sidebar. The permission filter runs server-side on every page load.
Granting the Editor Permission¶
For non-admin users:
- Open Users, click Permissions next to the user.
- Toggle Menu Settings (personal) to grant access to the personal editor.
- Toggle Menu Settings (company-wide default) if you want them to be able to change the company-wide sidebar (use sparingly — this affects every user).
- Managers who can edit User Management (or company-wide Menu Settings) can also use Specific user to arrange another login's sidebar.
- Save.
Tips¶
- Use colour-coded icons to group related functions visually. For example: green for HR (Timesheets, Employees), orange for Operations (Jobs, Inspections), blue for Admin.
- If your team only uses 5–6 features, customise the company-wide default to hide the rest. Users still have permission, but the sidebar becomes laser-focused.
- Keep short section titles short (about 4–10 characters) so they stay readable in the collapsed rail.
- Custom links are great for company intranets, third-party tools (Xero, Slack, etc.), or internal documentation.
14. Grok Bot connector¶
The Grok Bot connector lets a person use their own Grok Bot, on an individual plan or their own seat on a team, to read and file records in this company. The bot acts as that person's login. It can only open the sections they already have in Web Access.
AXITRAQ turns the connector on for the company. Until that switch is on, nobody in the company can connect a bot.
Location: Settings > Grok Bot (/base/manage/settings/grok.php). The account owner and a manager can open it. Undo and Redo stay with the account owner.
Allow a person¶
- Open Grok Bot in Settings.
- Choose Allow next to the owner, a manager, or an employee who should connect a bot.
- That person opens Account > Grok Bot, creates a token, and copies it once. The token stays at the top of that tab because it is renewed every 90 days. Under it, Select your Grok Bot team lists the specialist bots: AXITRAQ Connect, AXITRAQ Jobs, AXITRAQ Quotes, and AXITRAQ Parts & Materials.
-
They add the connector in their own Grok Bot:
-
URL:
https://axitraq.app/api/grok/v1/index.php - Header:
Authorization: Bearerand the token
The token is for that person only. Do not put it in a shared team bot. Remove on the Settings page revokes their grant and their token. Creating a new token replaces the previous one.
Notes and PDF files the bot files are drafts. The bot receives a confirm id and must send it back before the draft is marked confirmed. list_drafts and get_draft return the full note, so the bot can check what it filed and see a repeat. Times include the timezone offset. A draft id that is missing says it was not found for this login. The Settings page lists recent calls and drafts. Calls record the person, the tool, and the record. They do not store the conversation.
The bot can also create a job and update one that already exists, using the same Web Access as that person. On a job it can set the title, description, notes, client, department or branch, job type, colour, start and finish, site address, location, assets, and status Pending or Active. Search departments and job_types for those ids. Send the time as start or start_date, and finish, end, or end_date, in company local time. Send only one of those names. A date on its own is midnight. A timezone offset on the way in is refused, and the finish must be later than the start. A date that is not a real day is refused, and so is a time that does not exist when daylight saving starts. On a new job that refusal does not say nothing was changed. On an existing job, finish can be sent on its own, and a start that would pass the finish is refused. The job comes back with start_date and end_date, and a stored time includes the company timezone offset. A field that is not part of a job is refused. Location longer than 255 characters is refused. address_id copies the street and suburb into location, such as 12 Main Street, Ballarat, and copies the full address into the site address. The address label, such as Primary or Office, is left out of location. When that address has no street and no suburb, location stays as it is. Sending location as well sets that text. employees can be a list of ids, or a list of id, supervisor, and can_purchase. employee_ids is the same name for that list, and sending both is refused. Inside one person, send only one of id and employee_id, and only one of supervisor and role. add_employee_ids adds people. remove_employee_ids removes them from a job that already exists. People left out of those lists stay, and they keep supervisor and can purchase. A person added this way is a worker and cannot purchase. Sending employee_ids together with add or remove is refused. employee_ids on its own still replaces the whole crew. add_asset_ids adds assets. remove_asset_ids removes them from a job that already exists. An employee can be assigned as a worker, as supervisor, and as able to purchase. A person added to the crew gets the same New job assigned alert in the Operations App as when they are assigned on the Jobs screen. Someone already on the crew is not alerted again. Get a job to see its crew, assets, and that client's saved addresses. Sending the employee or asset list replaces the whole list. Completing or cancelling a job stays on the Jobs screen. Start and finish cannot move once someone has clocked time on the job. get, update_job, draft_note, and attach_file need the record id as a whole number. A missing id, 105abc, or 105.7 is refused. A whole number that is not in this company is not found.
The bot can create a client with create_client, using the same Clients access as that person. A business needs a business name. A person needs a first name and a last name. Send client_type as business or person. A person is stored as individual. It can set the trading name, ABN, ACN, status (Active, Inactive, or Archived), default job colour, notes, payment terms, payment method, and payment notes. Addresses and contacts can be lists, with the same fields as an update. A client can have five addresses and five contacts in total. A flat street, phone, mobile, and email on create still works when those lists are not sent. Sending both is refused, and a field that is not part of a client is refused. Inside one address or contact, send only one name for the same field, such as street or line1. The first address is the default. Get that client afterwards to see the saved address and contact, including each contact's address id, then use the new client id when creating a job. Client search can filter status as active, inactive, or archived.
The bot can update that client with update_client when the person can edit Clients. Pass the client id as a whole number and only the fields that should change. A missing or mixed id, such as 69abc, is refused. A field name that is not part of a client update is refused, and the error names where it sits, such as addresses[0].zzz. These are the same address and contact records shown on the client screen. Status can be Active, Inactive, or Archived. An address or contact is updated only when its id is sent, and only the fields sent on that entry change. An entry with no id is added. An entry is removed only when that entry has delete set to true and its id. Deleting the default address is allowed. The remaining address with the lowest id becomes the default. If it was the only address, the client has none. An empty address or contact list is refused, and entries left out of the list stay as they are. Adding an address or contact that would take the client past five is refused. A new address is the default only when the client has no address yet. The first new contact is the primary contact only when the client has no contact yet. A client name change does not rename that client on jobs already saved. Pass the same client id on update_job to refresh the name on a job.
The bot can build a quote when that person can view Quotes. Create or edit can start a quote, a template, a copy, a quote from a template, or a quote from a job. Edit can change every header field, stages, labour, assets, and parts, choose whether each note prints, upload a vendor quote and read it, and change quote settings: terms, categories, types, PDF margins, and PDF brands, including letterhead page 1 and continuation page 2 and after. Delete removes the quote from the list and keeps the row. The bot will not edit or delete a quote that has already been converted to a job. convert_quote needs the quote accepted, finalised, and assigned to a client. The quote screen's Convert to Job button does not require Accepted. The bot cannot email a quote. Search quotes with template true lists templates. quote_preview describes the PDF layout, and can return the preview or the stored finalised PDF. A vendor quote does not change part prices in the catalogue. Add a client with create_client, then set that client on the quote. finalise_quote issues the number and stores the PDF. convert_quote creates a job.
A GET to the connector, and whoami, return each tool name with a short schema. release is the image tag that is running. version stays 1. whoami also returns entity_access and the Web Access permissions, including Timesheets (manage.timesheets). Employees, departments, and job types use the Jobs permission (manage.jobs). Vendors and part categories use the Parts permission. Timesheet reads use Timesheets. Search takes entity, q, limit (1 to 50), and either offset or page. It returns rows, total, limit, and offset. Any other search argument is refused. company_id, user_id, tenant_id, and company are refused on every tool. The company and the person come from the token. A blank category is null in both search and get.
The bot can manage Parts and Materials when that person can view, create, or edit Parts. Search parts, vendors, part_categories, and part_subcategories. Get a part to see its item code, scan code, name, category id and name, sub-category id and name, item type, unit, reorder level, stock on hand, stock alerts, cost price, sell price, fuel transfer markup, category markup, status, vendor, linked assets, linked items, description, notes, and photo ids. Prices are on the part get and on the vendor price list so they can be managed. Search does not include prices. Prices are not added to jobs or clients.
item_code is the code you choose. It must be unique in the company, and a blank code is allowed. A duplicate is refused and nothing is saved. part_code is the scan code AXITRAQ assigns. New items, from the screen or the bot, receive PT- plus the id. Older items may already have the item code stored as the scan code as well. The bot cannot set part_code.
create_part needs a name. It can set the item code, description, notes, category, sub-category, item type (part, material, both, or fuel), unit, reorder level, cost price, sell price, status, vendor, assets, and stock alerts. Category and sub-category accept an id or a name, and the name must already exist. Use create_part_category or create_part_subcategory first. An unknown category is refused and nothing is saved. archive_part sets the item to discontinued. update_part can also set archive to true or status discontinued. There is no delete tool.
update_part changes only the fields that are sent. The id is a whole number. asset_ids replaces the asset list, and an empty list clears it. vendor_id sets the preferred vendor. 0 clears that choice and leaves any extra vendor links in place. Changing the category clears the sub-category unless a new one is sent. markup_pct on the part is the fuel transfer markup, and it is accepted only when the item type is fuel. Stock alerts use stock_alerts true or false, stock_alert_channels (in_app, email, sms, messaging), and stock_alert_recipients as admin, management, or custom with employee ids from search.
Linked items are the same physical part bought under more than one item code. link_parts links them, with the id as the primary. unlink_part removes one. set_linked_part_primary chooses the primary. Get shows them as linked_items.
add_part_image adds a JPEG, PNG, or WebP. Send filename and content_base64. The image must be 8 MB or smaller.
create_part_category adds a category name. update_part_category renames it. The rename follows through to items, sub-categories, and the category markup that used the old name. delete true removes the name from the list and leaves the text already stored on items. Sub-categories use create_part_subcategory with category and name, and update_part_subcategory to rename or delete. A sub-category stays under the category it was created in.
set_category_markup sets the category MU% used when a client sell price is worked out. Leave client_id out, or send 0, for the company default. A client id sets that client's override. delete true removes that markup row.
create_vendor needs a name. That name is the business name on the supplier list. trading_name is the trading name. invoice_names holds the legal names printed on invoices, one per line. update_vendor changes only the fields sent. The fields match the vendor screen: trading name, legal names, ABN, head-office phone and mobile (contact_phone, ho_phone, ho_mobile, or phone and mobile), website, address (address_line1 or address), city, state, postcode, country, three branch contacts with a role on each, the branch address, notes, and status active or inactive. The head-office contact has no role. An ABN must be 11 digits and is stored as XX XXX XXX XXX. State is ACT, NSW, NT, QLD, SA, TAS, VIC, or WA. Account contact, payment terms, and payment method are returned. Account number, credit limit, BPAY, and bank details can be saved and are not returned. payment_account_set says whether any of those are stored. Inactive is how a vendor is archived. The bot does not mark vendor invoices paid.
update_vendor_prices sets sell prices for parts already on that vendor's price list. Each item has part_id and sell_price, or markup_pct instead of a sell price. If both are sent, the sell price is saved. Markup is worked out from the last buy price from that vendor, or from the part's cost price when there is no buy yet, and only the sell price is stored. A part that is not linked to the vendor is refused. Set the vendor on the part first.
The bot can manage Assets when that person can view, create, or edit Assets. Search assets, asset_categories, checklist_templates, and form_templates. Search assets returns the asset code, name, status, category and category id, registration number, next due date, and whether that date is current, due soon, or overdue. The same due word is due and rego_due. q matches part of a name, code, serial number, category, or registration. Search can filter by category, status, and registration due. rego_within_days is a whole number from 0 to 365. Search does not include purchase price. Job search by asset_id returns no rows when that asset is not in the company. A job start time is returned with the company timezone offset. Get an asset to manage it. The read includes the fields on the asset screen, including purchase price and current value, registration, hour meter, odometer, fuel on hand and recent fuel use, recent start and stop, jobs the asset is on, who can operate or maintain it, checklists, forms, documents, photos, features, barcodes, and the scan code AXITRAQ assigned. qr_code is the scan code. qr_url is the link in the QR. Meter readings and measurements are decimal strings. Money is a decimal string. Timestamps use the company timezone from whoami. Fuel reads do not include cost. Registration card numbers are not accepted and are not returned.
create_asset needs a name and a category that already exists. Search asset_categories, or use create_asset_category. Send the category name or category_id. An unknown category is refused and nothing is saved. update_asset_category renames a category, and the new name follows onto assets that use it. Asset categories are not nested. archive_asset_category sets it inactive so new assets cannot use it. Assets already on that name stay there. Get a category to see its built-in fields, its custom_fields, and the sections a field can sit in. create_asset_field adds a custom field. field_type is text, textarea, number, date, select, or checkbox. A dropdown needs options. help_text is optional. is_required is true or false. section is basic, identifiers, usage, navigator, location, financial, other, or blank to leave the field under Custom Fields. update_asset_field changes only the settings sent. status inactive hides the field and keeps values already saved. remove_asset_field takes it off the forms and keeps those values. The field stays on the category and on the asset, marked removed, so the saved value can still be read. set_asset_category_fields shows, hides, requires, or relabels the built-in fields for that category, and changes sort order only when sort_order is sent. Hiding a built-in field keeps any value already stored. A hidden field cannot be written, and a hidden serial number is left out of search. Asset code, name, category, and status always stay on the form. A custom field cannot use a built-in field's name, or the name of a removed field. A built-in field cannot be relabelled to a name already used by another built-in field or a custom field. Dropdown choices cannot repeat. A choice list or a field type cannot drop a saved value. The refusal names that value and the asset. Changing a checkbox to another type is refused while a value is saved. asset_code and qr_code are assigned. Do not send them. A new asset receives the next code. A deleted asset's code is not used again. A new asset receives a pool scan code, the same way the screen does. update_asset changes only the fields sent. archive_asset sets the asset to decommissioned and unmounts assets that were mounted on it. Those assets stay in the company. There is no delete tool.
set_asset_registration changes only the registration fields sent. payment_method must be Card, EFT, BPAY, Direct Debit, Bank Transfer, Credit Card, Direct Deposit, Cash, Cheque, or Other. A card number is refused. grant_asset_access and revoke_asset_access match the access list: operate, inspect, maintain, or admin. Revoke keeps the row. Granting that person and type again adds a new row, and the revoked row keeps its grant date and notes. Get lists current access and the revoked rows under access_history. assign_asset_checklist and unassign_asset_checklist attach a checklist to this asset. Search checklist_templates for the id. A checklist that already applies to every asset is left as it is. assign_asset_form and unassign_asset_form make a form available on this asset without changing where else that form is used. Search form_templates for the id. add_asset_document attaches a document. remove_asset_document removes it. add_asset_image adds a JPEG, PNG, or WebP. remove_asset_image removes it. add_asset_feature adds a mounted feature. remove_asset_feature removes it. record_asset_reading stores a dated hour or odometer reading. The current meter changes only when that reading is the newest. Setting the current meter on update_asset also stores a reading, so an older reading does not replace it. Clearing the odometer stores an "Odometer cleared" reading, and a later backdated reading does not fill it back in. A blank hour meter is refused and the hours stay as they are. Hours go to 9999999.9 and the odometer to 999999999.9. recent_use includes the reading notes. add_asset_document, add_asset_image, and add_asset_feature each return the item that was added. Removing one that is already removed says so and changes nothing. link_asset_job puts the asset on a job, or removes it when unlink is true. unlink is true or false. update_job can also add_asset_ids or remove_asset_ids. An empty list is refused. set_asset_barcode attaches a barcode that must be unique in the company. asset_label returns a one-up PDF with the asset code, name, QR, and barcode of the scan code.
Rate-card billing, designed label sheets, and document QR codes stay on the asset screen. Get lists maintenance schedules, including paused and completed, with the last and next due date, hours, and kilometres. It also includes recent service, the parts used on that service, inspections, associated parts, the latest 15 checklist submissions, and the latest 10 form submissions. A submission includes its note and the answers that failed or carry a note. A blank note does not set has_issue. has_issue marks a failed, rejected, or noted submission. asset_service_history pages the full service record. scheduled_date is the stored date and time with the company timezone offset. A date with no time is midnight. asset_meter_readings pages every stored hour and odometer reading, including fuel purchases that captured a meter, without fuel cost. Rows that share a time are ordered by id. A fuel purchase with no meter is left out. recent_use is the latest 20 of those readings. asset_submissions pages every checklist and form for the asset and returns each answer. Its limit is 1 to 20. Service scheduled_date is the stored date and time with the company timezone offset. A date with no time is midnight. Fuel period_end includes the offset. Service cost is included. Fuel price is not. The person on an inspection checklist is the employee, or that employee's login. When the checklist has no person, it uses the inspector on the matching inspection. Search pages every asset with limit and offset. Custom fields for the category are sent as custom_fields, a list of field_id and value. A number must be from -999999999999999 to 999999999999999 with up to 8 decimal places. It is checked from the digits that were sent, stored as that decimal, and returned as text. A date must be a real YYYY-MM-DD, a dropdown must match a choice exactly, and a checkbox is true, false, or null to clear it. The same field_id cannot be sent twice. A required custom field must be sent when the asset is created, and again when an existing asset moves into that category. A required built-in field is checked the same way. Sending custom_fields on an update keeps the values that were not sent. A checkbox comes back as true, false, or null when it was never set. The asset code is issued only after the asset is saved.
The bot can read Timesheets when that person can view Timesheets. whoami shows that permission and timesheets under entity_access. search_timesheets lists date, employee, job, asset, start, stop, break, hours, type, status, payroll approval, and the job-manager check. An employee id has to be someone employee search lists. A deleted or platform account is not found, the same as employee get. get_timesheet is one entry, including notes, parts, adjustments, and start and stop location. The location says at the job, near the job, not at the job, or no job location, and the distance. Coordinates are included only when the reading is at or near the job, and only to 4 decimal places. Off-site readings do not include coordinates. Approval times include the company timezone offset. timesheet_summary is the pay-period summary, with daily span, breaks, clocked hours, hours by type, WW Bank, and payable hours. pending_timesheets is a count on that summary, not its own tool. It counts submitted entries in the period. ww_bank gives hours lodged, hours drawn, and the accepted bank balance for each employee, plus the ledger. timesheet_requests is Requests and Notifications for the last 90 days, and this login's timesheet bell items. These tools do not submit, approve, reject, or adjust.
A field that is too long names the field and the maximum. A value of the wrong kind says it must be text, or names the allowed range. Units are each, box, pack, set, metre, m, cm, mm, inch, ft, yard, kg, g, tonne, lb, litre, ml, gallon, and m3.
Job and client saves, from the bot or from the screen, are kept for 14 days. The account owner opens Grok Bot in Settings and uses Undo to step that record back one save, while it still matches. Redo puts that save back. A job that already has clocked time keeps its start and finish. A client that is already on a job, quote, or invoice stays. Sent mail and payments are not undone.
Switching the connector on¶
The company switch is not on Settings > Grok Bot. Ask AXITRAQ at support@axitraq.com.au to turn the connector on for the company. Until that switch is on, the Settings page says the connector is off and nobody can create a token.
Who can be allowed¶
Allow is offered for an active login whose class is owner, manager, operator, or viewer. A contractor who has a login of one of those classes can be allowed. A person with no login is not on the list. An SMS-only contact who has never been given a user account cannot be allowed. An inactive login is shown as Inactive and has no Allow button.
Account > Grok Bot appears only after that person is allowed. They create a token, copy it once, and paste it into their own Grok Bot (an individual plan, or their own seat on a team). One person per token. Do not put a token in a shared team bot.
Tokens last 90 days. Renew from Account > Grok Bot. Replace token revokes the previous token. There is one live token per person. Remove on Settings > Grok Bot revokes the grant and the token.
A locked, inactive, or deleted login cannot use a token. The connector also refuses the call when the company switch is off, the grant has been removed, or the token is revoked or past 90 days.
The connector allows 120 calls a minute from one IP address, and 60 calls a minute on one token.
Notes and files¶
draft_note files a note as a draft. Send entity (required), id (the record id), and body (1 to 8000 characters). Confirm the draft before it is saved.
attach_file attaches a PDF draft, up to 6 MB. It is not used for part photos. Send entity (required), id, filename (the PDF name), and content_base64 (the PDF bytes).
confirm_draft marks a draft confirmed. list_drafts and get_draft return the note so the bot can check what it filed.
Tools¶
whoami lists the person's name, Web Access, and every tool. A GET to the connector returns the same tool list with short argument notes. release is the image that is running.
| Group | Tools |
|---|---|
| Sign-in and search | whoami, search, get |
| Jobs | create_job, update_job |
| Clients | create_client, update_client |
| Drafts | draft_note, attach_file, confirm_draft, list_drafts, get_draft |
| Parts | create_part, update_part, archive_part, add_part_image, link_parts, unlink_part, set_linked_part_primary, create_part_category, update_part_category, create_part_subcategory, update_part_subcategory, set_category_markup, create_vendor, update_vendor, update_vendor_prices |
| Assets | create_asset, update_asset, archive_asset, set_asset_registration, grant_asset_access, revoke_asset_access, assign_asset_checklist, unassign_asset_checklist, assign_asset_form, unassign_asset_form, add_asset_document, add_asset_image, add_asset_feature, remove_asset_document, remove_asset_image, remove_asset_feature, set_asset_barcode, asset_label, create_asset_category, update_asset_category, archive_asset_category, create_asset_field, update_asset_field, remove_asset_field, set_asset_category_fields, record_asset_reading, link_asset_job, asset_service_history, asset_meter_readings, asset_submissions |
| Timesheets (read only) | search_timesheets, get_timesheet, timesheet_summary, ww_bank, timesheet_requests. pending_timesheets is a count returned by timesheet_summary, not a separate tool. |
| Quotes | get_quote, create_quote, update_quote, duplicate_quote, quote_from_template, quote_from_job, delete_quote, add_quote_stage, update_quote_stage, delete_quote_stage, save_quote_line, delete_quote_line, move_quote_line, reorder_quote_lines, refresh_quote_prices, set_quote_status, finalise_quote, convert_quote_preview, convert_quote, quote_preview, quote_clash, upload_vendor_quote, read_vendor_quote, save_vendor_quote_line, load_vendor_quote, apply_vendor_quote, quote_settings, update_quote_settings, save_quote_category, save_quote_type, create_quote_brand, update_quote_brand, set_default_quote_brand, archive_quote_brand, upload_quote_stationery, remove_quote_stationery |
What the bot cannot do¶
- Jobs — complete or cancel a job, delete a job, fill forms, add materials, approve labour, or create a client invoice. Status on a job can be Pending or Active only. Crew ids are people in the company, including a contractor stored as a person. An id that is not a person is refused. Job numbers are assigned as
JOB-plus a sequence. There is no job-number setting. - Quotes — email a quote, or mark Accepted, Rejected, or Expired on the quote screen. That screen has no Accept or Reject buttons. Without a Grok Bot the badge stays where finalise left it, and Convert to Job still runs from Draft or Issued.
convert_quoteneeds the quote accepted and finalised. A converted quote cannot be edited or deleted by the bot.quote_from_jobis the same action as From past job on the quote screen. - Assets — create or edit checklist templates, form templates, maintenance schedules, service intervals, or alerts. It can assign a checklist or form that already exists. It cannot set the asset code or the scan code, and it cannot restore a deleted asset.
archive_assetsets the asset to Decommissioned. - Parts — move stock, create a purchase order, process a vendor invoice, import a CSV, or build an Item Builder assembly. Archiving an item sets it to Discontinued. There is no delete tool.
- Timesheets — submit, approve, reject, or adjust. The timesheet tools are read-only.
Troubleshooting¶
| What you see | What it means |
|---|---|
401 authentication_required |
Send Authorization: Bearer and the AXITRAQ token. |
401 invalid_token |
The token is unknown, expired, revoked, or the company connector is off. Create a new token on Account > Grok Bot. |
403 not_permitted |
This login cannot be used, or Web Access does not allow that tool. Check Allow on Settings > Grok Bot and the person's rights on Manage → Access → Permissions. |
| Grok Bot tab missing on Account | That person has not been allowed, or AXITRAQ has not switched the connector on. |
| Token stopped overnight | The login was locked, set inactive, or deleted, or the 90 days ran out. |
Getting Help¶
If you need assistance with any administrative task:
- Dash AI Assistant — available 24/7 within the platform. Click the Dash icon to ask questions and get instant, context-aware answers about any AXITRAQ feature. For Manuals folders and List/Folders view, ask Dash while on Manage → Manuals & Documents.
- Priority Human Support — available on Premium and Custom plans. Dash can escalate your question to a human support agent with full context preserved.
- Knowledge Base — browse the full documentation at wiki.axitraq.com, including Manuals and Documents.
AXITRAQ Administrator Guide -- Aditech Pty Ltd -- 2026 This document is maintained as part of the AXITRAQ platform documentation and serves as a knowledge base for the Dash AI assistant.