Skip to main content

Tools

The server has 51 tools. You do not call them yourself: the AI app picks them from your request. This list helps you know what to ask for and read what the app is doing.

Every customer tool takes customer_number. The Group column is the customer's AI access group the tool needs (see Before you start). Tools marked change need Read and write for that group, the change permission on your connection, and Manage Customer Config.

Context​

ToolWhat it doesGroup
list_my_customersCustomers you may configure through the AI app, with the AI access per group.none
get_customer_overviewRegion, AI access, sections with item counts and relations, the 35 implementation steps, workflow versions, maintenance, recent changes.Configuration
set_implementation_stepRecord your decision on an implementation step: done, not applicable, blocked with a reason, or open. changeConfiguration
get_maintenance_statusOpen and scheduled maintenance for the platform and the customer.none

Read configuration​

ToolWhat it doesGroup
list_config_itemsThe items of one section, with their config_item_id.Configuration
get_config_itemOne item in the export shape (summary or full).Configuration
find_referencesWhich items mention a given item, with the path of each mention.Configuration
get_section_referenceWhat a section holds, how it relates to other sections, and the consultant guide's notes for it.Configuration
export_configExport sections or items in the import file format.Configuration
get_change_historyChanges from the Change History, filtered by item, type or date.Configuration
compare_configCompare with another customer or with an export file.Configuration
get_catalogReference lists: expression fields and functions, invoice fields, workflow step types, scheduler task types, list view columns, AI models, templates, receiving domains.Configuration
get_templateThe body of a global or partner template (capture, file format, email).Configuration

Change sets​

ToolWhat it doesGroup
propose_changesPropose items to create, change or delete, and workflow version actions. changePer section
get_changesetA change set with its diff, validation and result.Per section
list_changesetsChange sets on a customer, newest first.Per section
apply_changesetApply a change set after you approved it. changePer section
discard_changesetDrop a proposed change set.Per section
revert_changesetPropose the inverse of an applied change set. changePer section
copy_configCopy sections or items from another customer as a change set. changePer section
validate_importTurn an export file into a change set. changePer section
initialise_from_templateCopy the template tenant's configuration as a change set. changeConfiguration

Testers​

Testers save nothing. Those marked with a change set id also test the configuration as it is in a proposed change set.

ToolWhat it doesGroup
find_test_invoicesInvoices to test with: number, supplier, status, amount, date. No document content.Configuration
test_expressionEvaluate an expression against an invoice.Configuration
test_ruleRun an enrichment or validation rule against an invoice. Change set id.Configuration
test_workflow_stepWhich transition of a workflow step matches an invoice. Change set id.Configuration
test_capture_rulesWhich capture template and AI models a document gets, and why. Change set id.Configuration
test_file_formatParse a sample file with an inbound file format. Change set id.Configuration
ai_analyze_file_formatLet the platform's AI propose a file format mapping for a sample file. Takes 15 to 60 seconds and has an AI cost.Configuration
render_email_templateRender an email template with sample data.Configuration
send_test_emailSend a rendered email template to your own address. At most 5 per 10 minutes. changeOperations
preview_pdf_templateRender a PDF template against a sample invoice.Configuration

Operations​

ToolWhat it doesGroup
trigger_scheduler_taskRun a scheduler task now. A real run. changeOperations
get_scheduler_historyRecent runs of a scheduler task.Operations
get_task_outputWhat a connector run printed, secrets masked.Operations
manage_maintenanceCustomer maintenance windows and weekly schedules. Two-step. changeOperations
browse_cdnFiles on the customer's CDN host.Operations
manage_cdnUpload, move or delete CDN files. Two-step. changeOperations

Users and access​

ToolWhat it doesGroup
list_usersCustomer portal users.Users and access
manage_userCreate, change, deactivate or invite a user. Two-step. changeUsers and access
list_user_groupsUser groups with members, rights and organizations.Users and access
manage_user_groupCreate, change or delete a user group. Two-step. changeUsers and access
list_api_usersAPI users of the Customer API. Keys are never shown.Users and access
manage_api_userCreate, change or delete an API user. Two-step. changeUsers and access
list_webhooksWebhook subscriptions and recent deliveries.Users and access
manage_webhookCreate, change, delete, test or replay a webhook. Two-step. changeUsers and access
list_sso_configsSAML single sign-on configurations. Read only.Users and access
list_partner_accountsSupplier Integration Access accounts and keys (prefix and last 4 characters).Users and access
manage_partner_accountCreate or revoke accounts and keys, notification addresses, invitations. Two-step. changeUsers and access

Excel​

ToolWhat it doesGroup
excel_exportExport organizations, suppliers, data tables, users, groups, processing teams or rule sets as rows.Per entity
excel_importCheck, then import, the same entities. Two-step; needs the Excel import permission. changePer entity

Organizations, suppliers and data tables are Master data; users, groups and processing teams are Users and access; rule sets are Configuration. Supplier bank account changes are refused: they are made in the portal.