Developers
ProxCore Platform API
One authenticated endpoint for the whole ProxCore platform — customers, sales, finance, operations, support, HR and integrations — usable from AI assistants (Model Context Protocol) or any HTTP client speaking JSON-RPC 2.0.
Overview
The API is exposed at https://proxcore.app/mcp. Every request is a JSON-RPC 2.0 message sent with POST. The function reference below is generated directly from the same registry the server executes, so it always matches what is implemented.
What a specific key can call is the intersection of: the modules your company has active and paid for, the live permissions of the staff user the key acts on behalf of, and the functions an administrator granted to that key. Call tools/list to see a key's exact effective functions.
API access requires the MCP Server (AI Integration) add-on. Only company administrators can create, edit or rotate keys (Settings → MCP / AI Access).
Authentication
Send the key as a bearer token over HTTPS. Keys start with pcm_live_, are shown once at creation, and can be revoked or rotated at any time. Never put keys in URLs, prompts, documents or logs.
Authorization: Bearer pcm_live_xxxxxxxxxxxxxxxxConnect an MCP-compatible AI client:
{
"mcpServers": {
"proxcore": {
"url": "https://proxcore.app/mcp",
"headers": { "Authorization": "Bearer <your ProxCore API key>" }
}
}
}Protocol & methods
Supported methods: initialize, ping, tools/list, tools/call, resources/list and resources/read (uri proxcore://agent-guide returns the key's effective guide with full JSON schemas). GET /mcp returns an unauthenticated discovery banner.
curl -X POST https://proxcore.app/mcp \
-H "Authorization: Bearer $PROXCORE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"my-client","version":"1.0"}}}'List the functions available to your key:
{"jsonrpc":"2.0","id":2,"method":"tools/list"}Call a read function. Lists accept search, limit (1–100, default 25), offset and, where the record has them, status, stage, priority, customerId and projectId filters.
{"jsonrpc":"2.0","id":3,"method":"tools/call",
"params":{"name":"list_customers","arguments":{"search":"acme","limit":25,"offset":0}}}Responses return the data both as text and as structuredContent:
{"jsonrpc":"2.0","id":3,"result":{
"content":[{"type":"text","text":"{...}"}],
"structuredContent":{"items":[...],"count":25,"limit":25,"offset":0},
"isError":false}}Writes & idempotency
Every create, update, delete, send or post call must include confirm: true and a unique operationId (12–120 characters: letters, numbers, underscore, hyphen). Retrying with the same operationId and identical arguments returns the original receipt instead of repeating the action; reusing it with different arguments is rejected.
{"jsonrpc":"2.0","id":4,"method":"tools/call",
"params":{"name":"create_invoice","arguments":{
"confirm":true,
"operationId":"inv-2026-acme-0001",
"data":{"title":"Consulting","customerId":"<customer id>",
"lineItems":[{"description":"Advisory hours","quantity":10,"unitPrice":950}]}}}}Financial documents (invoices, quotes, proposals, contracts, credit notes, bills, journals) can only be edited or deleted while in draft. Sending and posting are separate permissions. Payments are recorded receipts, not gateway charges. Dates must be ISO 8601 with a timezone. Money always stays in each record's own currency. Unknown properties are rejected.
Access model
- Tenant modules: functions for modules your company has not activated are never listed.
- Delegated user: each key acts as one staff member and can never exceed their live permissions or record scope (all, team or own records).
- Function grants: keys only get the functions selected for them; there are no wildcard grants. A read-only lock blocks every write.
- Financial visibility: money fields are omitted (never zeroed) unless both the user and the key have financial access for that module.
- Admin-level functions (journals, automations, integration status, payment gateways) require the delegated user to be an administrator or manager.
- Cross-tenant IDs and inaccessible related records are always rejected. Keys cannot manage users, permissions, billing, credentials or other keys.
Limits & errors
- Rate limit per key (default 60 operations/minute, configurable 1–1000). Exceeding it returns HTTP
429with aRetry-Afterheader. - Batches of 1–20 JSON-RPC messages; request bodies up to 256 KiB (HTTP
413above that). - HTTP
401: missing, invalid, revoked or expired key, or inactive delegated user. HTTP403: the MCP Server add-on is not active. - JSON-RPC errors:
-32700parse error,-32600invalid request,-32601method not found,-32602invalid params. - Validation and permission failures come back as a
tools/callresult withisError: true. Correct the input rather than retrying.
Current limitations
- No payment allocation, voids, reversals or refunds via the API — perform these in the application.
- No headless PDF/document export.
- Automations and chatbot flows: metadata only; execution and graph publishing are not exposed.
- Password vault: metadata only, never credentials. Integrations: connection status only.
- Each resource returns the documented field set below, not every internal column. Not every sub-resource has write functions.
Function reference
Grouped by module. Each function lists its required permission and arguments.
Sales
Customer Management
CRM10 functionsReturned fields
idcreatedAtupdatedAtcustomerCodecompanyNametradingNamecustomerTypestatusindustryemailphonewebsitecitystatecountryvatNumberregistrationNodefaultPaymentTermscreditLimitpreferredCurrencyaccountManagerIdtags
Create fields
companyNametradingNamecustomerTypestatusindustryemailphonewebsiteaddresscitystatecountrypostalCodevatNumberregistrationNodefaultPaymentTermscreditLimitpreferredCurrencyaccountManagerIdtagsnotesfirstNamelastName
archive_customerwritepermission: delete
Archive/deactivate customer without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_contactwritepermission: create
create contact within an accessible customer. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.firstName | string | yes | length 0–20000 |
data.lastName | string | yes | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.mobile | string | no | length 0–20000 |
data.role | string | no | length 0–20000 |
data.title | string | no | length 1–20000 |
data.department | string | no | length 0–20000 |
data.contactType | string | no | length 0–20000 |
data.isPrimary | boolean | no | |
data.isBilling | boolean | no | |
data.isWhatsAppContact | boolean | no |
create_customerwritepermission: create
create customer using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.companyName | string | yes | length 1–20000 |
data.tradingName | string | no | length 0–20000 |
data.customerType | string | no | length 0–20000 |
data.status | string | no | length 0–20000 |
data.industry | string | no | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.city | string | no | length 0–20000 |
data.state | string | no | length 0–20000 |
data.country | string | no | length 0–20000 |
data.postalCode | string | no | length 0–20000 |
data.vatNumber | string | no | length 0–20000 |
data.registrationNo | string | no | length 0–20000 |
data.defaultPaymentTerms | string | no | length 0–20000 |
data.creditLimit | number | no | range 0–1000000000000 |
data.preferredCurrency | string | no | length 0–20000 |
data.accountManagerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.firstName | string | no | length 1–20000 |
data.lastName | string | no | length 1–20000 |
delete_contactwritepermission: delete
delete contact within an accessible customer. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_contactreadpermission: view
Get one contact; both parentId and child id must match.
| Argument | Type | Required | Notes |
|---|---|---|---|
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_customerreadpermission: view
Get an accessible customer by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_contactsreadpermission: view
List contacts under an accessible customer. parentId is the customer id.
| Argument | Type | Required | Notes |
|---|---|---|---|
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
list_customersreadpermission: view
List accessible customers. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | string | no | length 0–20000 |
update_contactwritepermission: update
update contact within an accessible customer. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.firstName | string | no | length 0–20000 |
data.lastName | string | no | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.mobile | string | no | length 0–20000 |
data.role | string | no | length 0–20000 |
data.title | string | no | length 1–20000 |
data.department | string | no | length 0–20000 |
data.contactType | string | no | length 0–20000 |
data.isPrimary | boolean | no | |
data.isBilling | boolean | no | |
data.isWhatsAppContact | boolean | no |
update_customerwritepermission: update
update customer using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.companyName | string | no | length 1–20000 |
data.tradingName | string | no | length 0–20000 |
data.customerType | string | no | length 0–20000 |
data.status | string | no | length 0–20000 |
data.industry | string | no | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.city | string | no | length 0–20000 |
data.state | string | no | length 0–20000 |
data.country | string | no | length 0–20000 |
data.postalCode | string | no | length 0–20000 |
data.vatNumber | string | no | length 0–20000 |
data.registrationNo | string | no | length 0–20000 |
data.defaultPaymentTerms | string | no | length 0–20000 |
data.creditLimit | number | no | range 0–1000000000000 |
data.preferredCurrency | string | no | length 0–20000 |
data.accountManagerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.firstName | string | no | length 1–20000 |
data.lastName | string | no | length 1–20000 |
Lead Pipeline
LEADS5 functionsReturned fields
idcreatedAtupdatedAtcompanyNamecontactNamecontactEmailcontactPhonesourcestagevaluescoreratinggradeprobabilityindustryjobTitlewebsitecurrencyassignedToIdteamIdcustomerIdexpectedCloseDatelastContactedAtnextFollowUpAtconvertedAt
Create fields
companyNamecontactNamecontactEmailcontactPhonesourcevaluenotesassignedToIdteamIdcurrencyjobTitlewebsiteindustry
Update fields
companyNamecontactNamecontactEmailcontactPhonesourcestagevaluenotesassignedToIdteamIdcurrencyjobTitlewebsiteindustryexpectedCloseDatenextFollowUpAtisArchived
archive_leadwritepermission: delete
Archive/deactivate lead without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_leadwritepermission: create
create lead using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.companyName | string | yes | length 1–20000 |
data.contactName | string | yes | length 0–20000 |
data.contactEmail | string | no | length 0–20000 |
data.contactPhone | string | no | length 0–20000 |
data.source | string | no | length 0–20000 |
data.value | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.assignedToId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.teamId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.jobTitle | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.industry | string | no | length 0–20000 |
get_leadreadpermission: view
Get an accessible lead by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_leadsreadpermission: view
List accessible leads. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
stage | enum: NEW | CONTACTED | QUALIFIED | PROPOSAL_SENT | NEGOTIATION | WON | LOST | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_leadwritepermission: update
update lead using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.companyName | string | no | length 1–20000 |
data.contactName | string | no | length 0–20000 |
data.contactEmail | string | no | length 0–20000 |
data.contactPhone | string | no | length 0–20000 |
data.source | string | no | length 0–20000 |
data.stage | enum: NEW | CONTACTED | QUALIFIED | PROPOSAL_SENT | NEGOTIATION | WON | LOST | no | |
data.value | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.assignedToId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.teamId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.jobTitle | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.industry | string | no | length 0–20000 |
data.expectedCloseDate | string (date-time) | no | length 0–40 |
data.nextFollowUpAt | string (date-time) | no | length 0–40 |
data.isArchived | boolean | no |
Advanced Leads
LEADS_ADVANCED4 functionsReturned fields
idcreatedAtupdatedAtnameisDefaultisActive
Returned fields
idcreatedAtupdatedAtpipelineIdnamesortOrderprobabilitytypecolorrottingDays
get_pipelinereadpermission: view
Get an accessible pipeline by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_pipeline_stagereadpermission: view
Get an accessible pipeline_stage by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_pipeline_stagesreadpermission: view
List accessible pipeline_stages. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
list_pipelinesreadpermission: view
List accessible pipelines. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
Quotes
QUOTING6 functionsReturned fields
idcreatedAtupdatedAtquoteNumbertitlestatusvalidUntilsubtotaltaxAmountdiscounttotalcurrencyrevisioncustomerIdleadIdsentAtacceptedAt
Create fields
titlecustomerIdcurrencytaxRatediscountnotesleadIdtermsvalidUntil
Update fields
titlecustomerIdtaxRatediscountnotesleadIdtermsvalidUntil
create_quotewritepermission: createfinancial access
create quote using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.validUntil | string (date-time) | no | length 0–40 |
data.lineItems | array<object> | yes | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no |
delete_quotewritepermission: deletefinancial access
delete quote using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_quotereadpermission: view
Get an accessible quote by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_quotesreadpermission: view
List accessible quotes. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | SENT | VIEWED | ACCEPTED | REJECTED | EXPIRED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
send_quote_emailwritepermission: sendfinancial access
Send quote to an explicitly selected saved contact. Existing workflow may also send configured customer WhatsApp notifications (invoice is email-only). Returns submission status, not proof of delivery.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
email | string | yes | length 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
update_quotewritepermission: updatefinancial access
update quote using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.validUntil | string (date-time) | no | length 0–40 |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no |
Proposals
PROPOSALS6 functionsReturned fields
idcreatedAtupdatedAtproposalNumbertitlestatussummaryvalidUntilcustomerIdleadIdcurrencysubtotaltaxAmountdiscounttotalsentAtacceptedAt
Create fields
titlecustomerIdcurrencytaxRatediscountsummaryvalidUntilleadId
Update fields
titlecustomerIdtaxRatediscountsummaryvalidUntilleadId
create_proposalwritepermission: createfinancial access
create proposal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.summary | string | no | length 0–20000 |
data.validUntil | string (date-time) | no | length 0–40 |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no | |
data.sections | array<object> | no | items 0–50 |
data.sections[].title | string | yes | length 0–20000 |
data.sections[].content | string | yes | length 0–20000 |
data.sections[].sectionType | enum: text | pricing | no |
delete_proposalwritepermission: deletefinancial access
delete proposal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_proposalreadpermission: view
Get an accessible proposal by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_proposalsreadpermission: view
List accessible proposals. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | REVIEW | SENT | VIEWED | ACCEPTED | REJECTED | EXPIRED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
send_proposal_emailwritepermission: sendfinancial access
Send proposal to an explicitly selected saved contact. Existing workflow may also send configured customer WhatsApp notifications (invoice is email-only). Returns submission status, not proof of delivery.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
email | string | yes | length 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
update_proposalwritepermission: updatefinancial access
update proposal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.summary | string | no | length 0–20000 |
data.validUntil | string (date-time) | no | length 0–40 |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no | |
data.sections | array<object> | no | items 0–50 |
data.sections[].title | string | yes | length 0–20000 |
data.sections[].content | string | yes | length 0–20000 |
data.sections[].sectionType | enum: text | pricing | no |
Product Catalog
CATALOG5 functionsReturned fields
idcreatedAtupdatedAtnameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdtrackInventorystockOnHandreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDaysisActive
Create fields
nameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDays
Update fields
nameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDaysisActive
archive_itemwritepermission: deletefinancial access
Archive/deactivate item without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_itemwritepermission: createfinancial access
create item using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.sku | string | no | length 0–20000 |
data.description | string | no | length 0–20000 |
data.longDescription | string | no | length 0–20000 |
data.type | enum: SERVICE | DIGITAL | PHYSICAL | no | |
data.unitPrice | number | no | range 0–1000000000000 |
data.costPrice | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.unit | string | no | length 0–20000 |
data.taxRateId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.groupId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.reorderLevel | number | no | range 0–∞ |
data.reorderQty | number | no | range 0–∞ |
data.supplierId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.supplierItemCode | string | no | length 0–20000 |
data.leadTimeDays | integer | no |
get_itemreadpermission: view
Get an accessible item by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_itemsreadpermission: view
List accessible items. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
update_itemwritepermission: updatefinancial access
update item using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.sku | string | no | length 0–20000 |
data.description | string | no | length 0–20000 |
data.longDescription | string | no | length 0–20000 |
data.type | enum: SERVICE | DIGITAL | PHYSICAL | no | |
data.unitPrice | number | no | range 0–1000000000000 |
data.costPrice | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.unit | string | no | length 0–20000 |
data.taxRateId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.groupId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.reorderLevel | number | no | range 0–∞ |
data.reorderQty | number | no | range 0–∞ |
data.supplierId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.supplierItemCode | string | no | length 0–20000 |
data.leadTimeDays | integer | no | |
data.isActive | boolean | no |
Finance
Invoicing
INVOICING17 functionsReturned fields
idcreatedAtupdatedAtinvoiceNumbertitlestatusissueDatedueDatesubtotaltaxAmountdiscounttotalamountPaidcurrencybaseCurrencybaseTotalcustomerIdprojectIdsentAtpaidAt
Create fields
titlecustomerIdcurrencytaxRatediscountnotesprojectIdtermsdueDateissueDatediscountType
Returned fields
idcreatedAtupdatedAttitlefrequencystartDateendDatenextGenerateAtlastGeneratedAtisActiveautoSendsubtotaltaxAmountdiscounttotalcurrencycustomerIdprojectIdgeneratedCount
Create fields
titlecustomerIdcurrencytaxRatediscountnotesfrequencystartDateendDateprojectIdtermspaymentTermDaysdiscountType
Update fields
titlecustomerIdcurrencytaxRatediscountnotesfrequencystartDateendDateprojectIdtermspaymentTermDaysdiscountTypeisActive
Returned fields
idcreatedAtupdatedAtcreditNoteNumbertitlestatusissueDatereasonsubtotaltaxAmountdiscounttotalamountAppliedcurrencybaseCurrencybaseTotalcustomerIdprojectIdinvoiceId
Create fields
titlecustomerIdcurrencytaxRatediscountnotesprojectIdinvoiceIdtermsreasonissueDatediscountType
archive_recurring_invoicewritepermission: deletefinancial access
Archive/deactivate recurring_invoice without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_credit_notewritepermission: createfinancial access
create credit_note using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.customerId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.invoiceId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.reason | string | no | length 0–20000 |
data.issueDate | string (date-time) | no | length 0–40 |
data.discountType | enum: fixed | percentage | no | |
data.lineItems | array<object> | yes | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_invoicewritepermission: createfinancial access
create invoice using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.customerId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.dueDate | string (date-time) | no | length 0–40 |
data.issueDate | string (date-time) | no | length 0–40 |
data.discountType | enum: fixed | percentage | no | |
data.lineItems | array<object> | yes | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no |
create_recurring_invoicewritepermission: createfinancial access
create recurring_invoice using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.frequency | enum: WEEKLY | BIWEEKLY | MONTHLY | QUARTERLY | BIANNUALLY | YEARLY | no | |
data.startDate | string (date-time) | yes | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.paymentTermDays | integer | no | range 0–∞ |
data.discountType | enum: fixed | percentage | no | |
data.lineItems | array<object> | yes | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
delete_credit_notewritepermission: deletefinancial access
delete credit_note using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
delete_invoicewritepermission: deletefinancial access
delete invoice using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_credit_notereadpermission: view
Get an accessible credit_note by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_invoicereadpermission: view
Get an accessible invoice by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_recurring_invoicereadpermission: view
Get an accessible recurring_invoice by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_credit_notesreadpermission: view
List accessible credit_notes. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | ISSUED | PARTIALLY_APPLIED | APPLIED | VOID | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_invoicesreadpermission: view
List accessible invoices. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | SENT | VIEWED | PARTIALLY_PAID | PAID | OVERDUE | CANCELLED | REFUNDED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_recurring_invoicesreadpermission: view
List accessible recurring_invoices. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
send_credit_note_emailwritepermission: sendfinancial access
Send credit_note to an explicitly selected saved contact. Existing workflow may also send configured customer WhatsApp notifications (invoice is email-only). Returns submission status, not proof of delivery.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
email | string | yes | length 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
send_invoice_emailwritepermission: sendfinancial access
Send invoice to an explicitly selected saved contact. Existing workflow may also send configured customer WhatsApp notifications (invoice is email-only). Returns submission status, not proof of delivery.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
email | string | yes | length 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
update_credit_notewritepermission: updatefinancial access
update credit_note using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.invoiceId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.reason | string | no | length 0–20000 |
data.issueDate | string (date-time) | no | length 0–40 |
data.discountType | enum: fixed | percentage | no | |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_invoicewritepermission: updatefinancial access
update invoice using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.dueDate | string (date-time) | no | length 0–40 |
data.issueDate | string (date-time) | no | length 0–40 |
data.discountType | enum: fixed | percentage | no | |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].discount | number | no | range 0–1000000000000 |
data.lineItems[].discountType | enum: fixed | percentage | no | |
data.lineItems[].groupName | string | no | length 0–20000 |
data.lineItems[].isOptional | boolean | no |
update_recurring_invoicewritepermission: updatefinancial access
update recurring_invoice using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.currency | string | no | length 0–20000 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.notes | string | no | length 0–20000 |
data.frequency | enum: WEEKLY | BIWEEKLY | MONTHLY | QUARTERLY | BIANNUALLY | YEARLY | no | |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.terms | string | no | length 0–20000 |
data.paymentTermDays | integer | no | range 0–∞ |
data.discountType | enum: fixed | percentage | no | |
data.isActive | boolean | no | |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
Expenses
EXPENSES10 functionsReturned fields
idcreatedAtupdatedAtbillNumbersupplierReferencetitlecategoryvendorstatusissueDatedueDatesubtotaltaxAmountdiscounttotalamountPaidcurrencysupplierIdprojectIdledgerAccountId
Create fields
titlesupplierReferencecategoryvendorissueDatedueDatetaxRatediscountdiscountTypecurrencysupplierIdprojectIdledgerAccountIdnotesterms
Returned fields
idcreatedAtupdatedAtnamecodecontactNameemailphonewebsiteaddressnotesisActivetaxNumbercurrency
Create fields
namecodecontactNameemailphonewebsiteaddressnotestaxNumbercurrency
Update fields
namecodecontactNameemailphonewebsiteaddressnotestaxNumbercurrencyisActive
archive_supplierwritepermission: delete
Archive/deactivate supplier without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_billwritepermission: createfinancial access
create bill using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.supplierReference | string | no | length 0–20000 |
data.category | string | no | length 0–20000 |
data.vendor | string | no | length 0–20000 |
data.issueDate | string (date-time) | no | length 0–40 |
data.dueDate | string (date-time) | no | length 0–40 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.discountType | enum: fixed | percentage | no | |
data.currency | string | no | length 0–20000 |
data.supplierId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.notes | string | no | length 0–20000 |
data.terms | string | no | length 0–20000 |
data.lineItems | array<object> | yes | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_supplierwritepermission: create
create supplier using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.code | string | no | length 0–20000 |
data.contactName | string | no | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.taxNumber | string | no | length 0–20000 |
data.currency | string | no | length 0–20000 |
delete_billwritepermission: deletefinancial access
delete bill using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_billreadpermission: view
Get an accessible bill by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_supplierreadpermission: view
Get an accessible supplier by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_billsreadpermission: view
List accessible bills. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | AWAITING_PAYMENT | PARTIALLY_PAID | PAID | OVERDUE | VOID | no | |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_suppliersreadpermission: view
List accessible suppliers. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
update_billwritepermission: updatefinancial access
update bill using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.supplierReference | string | no | length 0–20000 |
data.category | string | no | length 0–20000 |
data.vendor | string | no | length 0–20000 |
data.issueDate | string (date-time) | no | length 0–40 |
data.dueDate | string (date-time) | no | length 0–40 |
data.taxRate | number | no | range 0–100 |
data.discount | number | no | range 0–1000000000000 |
data.discountType | enum: fixed | percentage | no | |
data.currency | string | no | length 0–20000 |
data.supplierId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.notes | string | no | length 0–20000 |
data.terms | string | no | length 0–20000 |
data.lineItems | array<object> | no | items 1–100 |
data.lineItems[].description | string | yes | length 1–20000 |
data.lineItems[].details | string | no | length 0–20000 |
data.lineItems[].quantity | number | yes | range 0.000001–1000000000 |
data.lineItems[].unitPrice | number | yes | range 0–1000000000000 |
data.lineItems[].ledgerAccountId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_supplierwritepermission: update
update supplier using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.code | string | no | length 0–20000 |
data.contactName | string | no | length 0–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.website | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.taxNumber | string | no | length 0–20000 |
data.currency | string | no | length 0–20000 |
data.isActive | boolean | no |
Payments
PAYMENTS4 functionsReturned fields
idcreatedAtupdatedAtpaymentNumberamounttypemethodreferencenotespaymentDatecurrencybaseCurrencybaseAmountunallocatedcustomerIdcreatedById
Create fields
amounttypemethodreferencenotespaymentDatecurrencycustomerId
create_paymentwritepermission: createfinancial access
create payment using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.amount | number | yes | range 0–1000000000000 |
data.type | enum: CUSTOMER_PAYMENT | REFUND | CREDIT_NOTE | no | |
data.method | string | no | length 0–20000 |
data.reference | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.paymentDate | string (date-time) | no | length 0–40 |
data.currency | string | no | length 0–20000 |
data.customerId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_paymentreadpermission: view
Get an accessible payment by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_payment_gateway_statusreadpermission: viewadmin/manager user
Read non-secret gateway connection status for enabled payment add-ons. No credentials, charges, refunds or provider calls.
No arguments.
list_paymentsreadpermission: view
List accessible payments. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Accounting
ACCOUNTING10 functionsReturned fields
idcreatedAtupdatedAtentryNumberdatereferencenarrationstatussourcetotalDebittotalCreditcurrencypostedAt
Create fields
datereferencenarrationcurrency
Returned fields
idcreatedAtupdatedAtcodenametypecategorydescriptionisControlAccountisDefaultSalesisDefaultPurchaseisActivesortOrder
Create fields
codenametypecategorydescription
Update fields
namecategorydescriptionisActive
create_journalwritepermission: createfinancial accessadmin/manager user
create journal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.date | string (date-time) | no | length 0–40 |
data.reference | string | no | length 0–20000 |
data.narration | string | no | length 0–20000 |
data.currency | string | no | length 0–20000 |
data.lines | array<object> | yes | items 1–100 |
data.lines[].ledgerAccountId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.lines[].description | string | no | length 0–20000 |
data.lines[].debit | number | yes | range 0–1000000000000 |
data.lines[].credit | number | yes | range 0–1000000000000 |
create_ledger_accountwritepermission: createfinancial access
create ledger_account using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.code | string | yes | length 0–20000 |
data.name | string | yes | length 1–20000 |
data.type | enum: ASSET | LIABILITY | EQUITY | INCOME | EXPENSE | yes | |
data.category | string | no | length 0–20000 |
data.description | string | no | length 0–20000 |
delete_journalwritepermission: deletefinancial accessadmin/manager user
delete journal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_journalreadpermission: viewadmin/manager user
Get an accessible journal by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_ledger_accountreadpermission: view
Get an accessible ledger_account by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_journalsreadpermission: viewadmin/manager user
List accessible journals. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | POSTED | VOID | no |
list_ledger_accountsreadpermission: view
List accessible ledger_accounts. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
post_journalwritepermission: postfinancial accessadmin/manager user
Post a balanced draft journal using the existing accounting workflow. Posted entries cannot be edited or deleted by MCP.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_journalwritepermission: updatefinancial accessadmin/manager user
update journal using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.date | string (date-time) | no | length 0–40 |
data.reference | string | no | length 0–20000 |
data.narration | string | no | length 0–20000 |
data.currency | string | no | length 0–20000 |
data.lines | array<object> | no | items 1–100 |
data.lines[].ledgerAccountId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.lines[].description | string | no | length 0–20000 |
data.lines[].debit | number | yes | range 0–1000000000000 |
data.lines[].credit | number | yes | range 0–1000000000000 |
update_ledger_accountwritepermission: updatefinancial access
update ledger_account using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.category | string | no | length 0–20000 |
data.description | string | no | length 0–20000 |
data.isActive | boolean | no |
Operations
Project Management
PROJECTS10 functionsReturned fields
idcreatedAtupdatedAtprojectCodenamedescriptionstatuspriorityhealthcategorystartDateendDatebudgetestimatedHourscurrencytagscustomerIdmanagerId
Create fields
namedescriptionstatuspriorityhealthcategorystartDateendDatebudgetestimatedHourscurrencytagscustomerIdmanagerId
archive_projectwritepermission: delete
Archive/deactivate project without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_projectwritepermission: create
create project using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.status | enum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLED | no | |
data.priority | enum: LOW | MEDIUM | HIGH | CRITICAL | no | |
data.health | enum: ON_TRACK | AT_RISK | BEHIND | COMPLETED | no | |
data.category | string | no | length 0–20000 |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.budget | number | no | range 0–1000000000000 |
data.estimatedHours | number | no | range 0–∞ |
data.currency | string | no | length 0–20000 |
data.tags | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.managerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_project_taskwritepermission: create
create project_task within an accessible project. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.status | enum: BACKLOG | TODO | IN_PROGRESS | IN_REVIEW | DONE | no | |
data.priority | enum: LOW | MEDIUM | HIGH | URGENT | no | |
data.startDate | string (date-time) | no | length 0–40 |
data.dueDate | string (date-time) | no | length 0–40 |
data.assigneeId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.estimatedHours | number | no | range 0–1000000 |
data.labels | string | no | length 0–20000 |
data.sortOrder | integer | no |
delete_project_taskwritepermission: delete
delete project_task within an accessible project. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_projectreadpermission: view
Get an accessible project by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_project_taskreadpermission: view
Get one project_task; both parentId and child id must match.
| Argument | Type | Required | Notes |
|---|---|---|---|
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_project_tasksreadpermission: view
List project_tasks under an accessible project. parentId is the project id.
| Argument | Type | Required | Notes |
|---|---|---|---|
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
list_projectsreadpermission: view
List accessible projects. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLED | no | |
priority | enum: LOW | MEDIUM | HIGH | CRITICAL | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_projectwritepermission: update
update project using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.status | enum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLED | no | |
data.priority | enum: LOW | MEDIUM | HIGH | CRITICAL | no | |
data.health | enum: ON_TRACK | AT_RISK | BEHIND | COMPLETED | no | |
data.category | string | no | length 0–20000 |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.budget | number | no | range 0–1000000000000 |
data.estimatedHours | number | no | range 0–∞ |
data.currency | string | no | length 0–20000 |
data.tags | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.managerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_project_taskwritepermission: update
update project_task within an accessible project. parentId is the parent record id. Standard activity/assignment notifications may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
parentId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.status | enum: BACKLOG | TODO | IN_PROGRESS | IN_REVIEW | DONE | no | |
data.priority | enum: LOW | MEDIUM | HIGH | URGENT | no | |
data.startDate | string (date-time) | no | length 0–40 |
data.dueDate | string (date-time) | no | length 0–40 |
data.assigneeId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.estimatedHours | number | no | range 0–1000000 |
data.labels | string | no | length 0–20000 |
data.sortOrder | integer | no |
Time Tracking
TIME_TRACKING5 functionsReturned fields
idcreatedAtupdatedAtdescriptionstartTimeendTimedurationbillablehourlyRateprojectIdtaskIduserId
Create fields
descriptionstartTimeendTimedurationbillablehourlyRateprojectIdtaskId
create_time_entrywritepermission: create
create time_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.description | string | no | length 0–20000 |
data.startTime | string (date-time) | yes | length 0–40 |
data.endTime | string (date-time) | no | length 0–40 |
data.duration | integer | no | range 0–∞ |
data.billable | boolean | no | |
data.hourlyRate | number | no | range 0–1000000000000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.taskId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
delete_time_entrywritepermission: delete
delete time_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_time_entryreadpermission: view
Get an accessible time_entry by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_time_entriesreadpermission: view
List accessible time_entries. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_time_entrywritepermission: update
update time_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.description | string | no | length 0–20000 |
data.startTime | string (date-time) | no | length 0–40 |
data.endTime | string (date-time) | no | length 0–40 |
data.duration | integer | no | range 0–∞ |
data.billable | boolean | no | |
data.hourlyRate | number | no | range 0–1000000000000 |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.taskId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Calendar
CALENDAR5 functionsReturned fields
idcreatedAtupdatedAttitledescriptiontypestartDateendDateallDaylocationcolorcustomerIdleadIdprojectIdcreatedById
Create fields
titledescriptiontypestartDateendDateallDaylocationcolorcustomerIdleadIdprojectId
create_eventwritepermission: create
create event using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.type | enum: MEETING | CALL | FOLLOW_UP | DEADLINE | REMINDER | OTHER | no | |
data.startDate | string (date-time) | yes | length 0–40 |
data.endDate | string (date-time) | yes | length 0–40 |
data.allDay | boolean | no | |
data.location | string | no | length 0–20000 |
data.color | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
delete_eventwritepermission: delete
delete event using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_eventreadpermission: view
Get an accessible event by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_eventsreadpermission: view
List accessible events. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_eventwritepermission: update
update event using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.type | enum: MEETING | CALL | FOLLOW_UP | DEADLINE | REMINDER | OTHER | no | |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.allDay | boolean | no | |
data.location | string | no | length 0–20000 |
data.color | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.leadId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Contracts
CONTRACTS7 functionsReturned fields
idcreatedAtupdatedAtcontractNumbertitledescriptiontypestatusvaluecurrencybillingCyclestartDateendDaterenewalDateautoRenewrenewalPeriodDaysrenewalNoticeDaystermsspecialConditionscancellationTermspaymentTermscustomerIdprojectIdownerIdsigningMode
Create fields
titledescriptiontypevaluecurrencybillingCyclestartDateendDaterenewalDateautoRenewrenewalPeriodDaysrenewalNoticeDaystermsspecialConditionscancellationTermspaymentTermscustomerIdprojectIdownerIdnotes
Update fields
titledescriptiontypevaluecurrencybillingCyclestartDateendDaterenewalDateautoRenewrenewalPeriodDaysrenewalNoticeDaystermsspecialConditionscancellationTermspaymentTermscustomerIdprojectIdownerIdnotesbodyHtmlsigningMode
add_contract_signerwritepermission: update
Add an external signer to a draft contract; does not sign or send the contract.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
name | string | yes | length 1–20000 |
email | string | yes | length 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
title | string | no | length 0–20000 |
create_contractwritepermission: createfinancial access
create contract using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.type | enum: SERVICE_AGREEMENT | SLA_CONTRACT | MAINTENANCE | SUBSCRIPTION | PROJECT_BASED | RETAINER | NDA | CONSULTING | LICENSING | OTHER | no | |
data.value | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.billingCycle | string | no | length 0–20000 |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.renewalDate | string (date-time) | no | length 0–40 |
data.autoRenew | boolean | no | |
data.renewalPeriodDays | integer | no | range 0–∞ |
data.renewalNoticeDays | integer | no | range 0–∞ |
data.terms | string | no | length 0–20000 |
data.specialConditions | string | no | length 0–20000 |
data.cancellationTerms | string | no | length 0–20000 |
data.paymentTerms | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ownerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.notes | string | no | length 0–20000 |
delete_contractwritepermission: deletefinancial access
delete contract using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_contractreadpermission: view
Get an accessible contract by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_contractsreadpermission: view
List accessible contracts. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | PENDING_APPROVAL | PENDING_SIGNATURE | PARTIALLY_SIGNED | ACTIVE | ON_HOLD | EXPIRING_SOON | EXPIRED | RENEWED | CANCELLED | TERMINATED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
send_contract_for_signaturewritepermission: sendfinancial access
Send a contract to its configured signers. IMPORTANT: existing internal signers with saved signatures are automatically signed. Requires approval permission AND explicit consent to applying internal signatures.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
confirmInternalSignatures | true (constant) | yes |
update_contractwritepermission: updatefinancial access
update contract using the application's existing workflow. Draft records only. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.type | enum: SERVICE_AGREEMENT | SLA_CONTRACT | MAINTENANCE | SUBSCRIPTION | PROJECT_BASED | RETAINER | NDA | CONSULTING | LICENSING | OTHER | no | |
data.value | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.billingCycle | string | no | length 0–20000 |
data.startDate | string (date-time) | no | length 0–40 |
data.endDate | string (date-time) | no | length 0–40 |
data.renewalDate | string (date-time) | no | length 0–40 |
data.autoRenew | boolean | no | |
data.renewalPeriodDays | integer | no | range 0–∞ |
data.renewalNoticeDays | integer | no | range 0–∞ |
data.terms | string | no | length 0–20000 |
data.specialConditions | string | no | length 0–20000 |
data.cancellationTerms | string | no | length 0–20000 |
data.paymentTerms | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.ownerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.notes | string | no | length 0–20000 |
data.bodyHtml | string | no | length 0–20000 |
data.signingMode | enum: PARALLEL | SEQUENTIAL | no |
Inventory
INVENTORY8 functionsReturned fields
idcreatedAtupdatedAtnamecodeaddressisDefaultisActive
Create fields
namecodeaddressisDefault
Update fields
namecodeaddressisDefaultisActive
Returned fields
idcreatedAtupdatedAttypequantitycostPerUnittotalCostreferencenotesitemIdlocationIdsupplierIdperformedById
Create fields
typequantitycostPerUnitreferencenotesitemIdlocationIdsupplierId
archive_stock_locationwritepermission: delete
Archive/deactivate stock_location without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_stock_locationwritepermission: create
create stock_location using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.code | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.isDefault | true (constant) | no | Set this location as the default; the prior default is unset. |
create_stock_movementwritepermission: createfinancial access
create stock_movement using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.type | enum: RECEIVED | SOLD | ADJUSTED | RETURNED | TRANSFERRED_IN | TRANSFERRED_OUT | WRITTEN_OFF | INITIAL | yes | |
data.quantity | number | yes | |
data.costPerUnit | number | no | range 0–1000000000000 |
data.reference | string | no | length 0–20000 |
data.notes | string | no | length 0–20000 |
data.itemId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.locationId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.supplierId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_stock_locationreadpermission: view
Get an accessible stock_location by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_stock_movementreadpermission: view
Get an accessible stock_movement by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_stock_locationsreadpermission: view
List accessible stock_locations. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
list_stock_movementsreadpermission: view
List accessible stock_movements. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
update_stock_locationwritepermission: update
update stock_location using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.code | string | no | length 0–20000 |
data.address | string | no | length 0–20000 |
data.isDefault | true (constant) | no | Set this location as the default; the prior default is unset. |
data.isActive | boolean | no |
Support
Support Desk
TICKETS5 functionsReturned fields
idcreatedAtupdatedAtticketNumbersubjectdescriptionstatusprioritychannelcustomerIdcontactNamecontactEmailcontactPhoneassignedToIdteamIddepartmentIdcategoryIdslaDueAtslaBreachedfirstResponseAtprojectId
Create fields
subjectdescriptionprioritychannelcustomerIdcontactNamecontactEmailcontactPhoneassignedToIdteamIddepartmentIdcategoryIdprojectIdtags
Update fields
subjectdescriptionpriorityteamIddepartmentIdcategoryIdtags
create_ticketwritepermission: create
create ticket using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.subject | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.priority | enum: LOW | MEDIUM | HIGH | URGENT | CRITICAL | no | |
data.channel | enum: MANUAL | EMAIL | WEB_FORM | WHATSAPP | PHONE | PORTAL | SOCIAL_MEDIA | no | |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.contactName | string | no | length 0–20000 |
data.contactEmail | string | no | length 0–20000 |
data.contactPhone | string | no | length 0–20000 |
data.assignedToId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.teamId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.departmentId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.categoryId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
get_ticketreadpermission: view
Get an accessible ticket by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_ticketsreadpermission: view
List accessible tickets. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: OPEN | IN_PROGRESS | WAITING_ON_CUSTOMER | WAITING_ON_THIRD_PARTY | RESOLVED | CLOSED | CANCELLED | no | |
priority | enum: LOW | MEDIUM | HIGH | URGENT | CRITICAL | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
projectId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
set_ticket_statuswritepermission: update
Change ticket status through its audited workflow; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
status | enum: OPEN | IN_PROGRESS | WAITING_ON_CUSTOMER | WAITING_ON_THIRD_PARTY | RESOLVED | CLOSED | CANCELLED | yes |
update_ticketwritepermission: update
update ticket using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.subject | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.priority | enum: LOW | MEDIUM | HIGH | URGENT | CRITICAL | no | |
data.teamId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.departmentId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.categoryId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
Knowledge Base
KNOWLEDGE_BASE10 functionsReturned fields
idcreatedAtupdatedAttitleslugcontentexcerptstatusvisibilityisPinnedtagsspaceIdcategoryIdauthorIdpublishedAt
Create fields
titlecontentexcerptvisibilityspaceIdcategoryIdtagsisPinned
Update fields
titlecontentexcerptvisibilitycategoryIdtagsisPinned
Returned fields
idcreatedAtupdatedAtnameslugdescriptioniconcolorsortOrderisActive
Create fields
namedescriptioniconcolorsortOrder
Update fields
namedescriptioniconcolorisActive
archive_knowledge_spacewritepermission: delete
Archive/deactivate knowledge_space without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_articlewritepermission: create
create article using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.content | string | no | length 0–20000 |
data.excerpt | string | no | length 0–20000 |
data.visibility | enum: INTERNAL | PORTAL | PUBLIC | no | |
data.spaceId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.categoryId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
data.isPinned | boolean | no |
create_knowledge_spacewritepermission: create
create knowledge_space using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.icon | string | no | length 0–20000 |
data.color | string | no | length 0–20000 |
data.sortOrder | integer | no |
delete_articlewritepermission: delete
delete article using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_articlereadpermission: view
Get an accessible article by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_knowledge_spacereadpermission: view
Get an accessible knowledge_space by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_articlesreadpermission: view
List accessible articles. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | PUBLISHED | ARCHIVED | no |
list_knowledge_spacesreadpermission: view
List accessible knowledge_spaces. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
update_articlewritepermission: update
update article using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.content | string | no | length 0–20000 |
data.excerpt | string | no | length 0–20000 |
data.visibility | enum: INTERNAL | PORTAL | PUBLIC | no | |
data.categoryId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.tags | string | no | length 0–20000 |
data.isPinned | boolean | no |
update_knowledge_spacewritepermission: update
update knowledge_space using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.icon | string | no | length 0–20000 |
data.color | string | no | length 0–20000 |
data.isActive | boolean | no |
Human Resources
HR & Team
HR5 functionsReturned fields
idcreatedAtupdatedAtemployeeCodefirstNamelastNameemailphoneemploymentTypestatusjoinDatesalarycurrencydepartmentIdpositionIdmanagerIduserId
Create fields
firstNamelastNameemailphoneemploymentTypestatusjoinDatesalarycurrencydepartmentIdpositionIdmanagerId
archive_employeewritepermission: deletefinancial access
Archive/deactivate employee without removing its history. Requires delete and update permissions.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
create_employeewritepermission: createfinancial access
create employee using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.firstName | string | yes | length 1–20000 |
data.lastName | string | yes | length 1–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.employmentType | enum: FULL_TIME | PART_TIME | CONTRACT | INTERN | FREELANCE | no | |
data.status | enum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNED | no | |
data.joinDate | string (date-time) | no | length 0–40 |
data.salary | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.departmentId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.positionId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.managerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_employeereadpermission: view
Get an accessible employee by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_employeesreadpermission: view
List accessible employees. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNED | no |
update_employeewritepermission: updatefinancial access
update employee using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.firstName | string | no | length 1–20000 |
data.lastName | string | no | length 1–20000 |
data.email | string | no | length 0–20000 |
data.phone | string | no | length 0–20000 |
data.employmentType | enum: FULL_TIME | PART_TIME | CONTRACT | INTERN | FREELANCE | no | |
data.status | enum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNED | no | |
data.joinDate | string (date-time) | no | length 0–40 |
data.salary | number | no | range 0–1000000000000 |
data.currency | string | no | length 0–20000 |
data.departmentId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.positionId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data.managerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Security
Password Vault
VAULT5 functionsReturned fields
idcreatedAtupdatedAttitlecategoryusernameurlcustomerIdcreatedById
Create fields
titlecategoryusernameurlcustomerId
create_vault_entrywritepermission: create
create vault_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.title | string | yes | length 1–20000 |
data.category | enum: HOSTING | DOMAIN_REGISTRAR | EMAIL | CPANEL | FTP | DATABASE | API_KEY | SSL | DNS | CLOUD | VPN | OTHER | no | |
data.username | string | no | length 0–20000 |
data.url | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
delete_vault_entrywritepermission: delete
delete vault_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_vault_entryreadpermission: view
Get an accessible vault_entry by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_vault_entriesreadpermission: view
List accessible vault_entries. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_vault_entrywritepermission: update
update vault_entry using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.title | string | no | length 1–20000 |
data.category | enum: HOSTING | DOMAIN_REGISTRAR | EMAIL | CPANEL | FTP | DATABASE | API_KEY | SSL | DNS | CLOUD | VPN | OTHER | no | |
data.username | string | no | length 0–20000 |
data.url | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Asset Management
ASSETS5 functionsReturned fields
idcreatedAtupdatedAtnameassetTypestatusprovideraccountRefcostrecurringCostbillingCyclepurchaseDateexpiryDaterenewalDateautoRenewcustomerIdmanagedById
Create fields
nameassetTypestatusprovideraccountRefcostrecurringCostbillingCyclepurchaseDateexpiryDaterenewalDateautoRenewnotescustomerId
create_assetwritepermission: create
create asset using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.assetType | enum: DOMAIN | SERVER | SSL_CERTIFICATE | HOSTING | LICENSE | SOFTWARE | HARDWARE | SUBSCRIPTION | OTHER | yes | |
data.status | enum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDING | no | |
data.provider | string | no | length 0–20000 |
data.accountRef | string | no | length 0–20000 |
data.cost | number | no | range 0–1000000000000 |
data.recurringCost | number | no | range 0–1000000000000 |
data.billingCycle | string | no | length 0–20000 |
data.purchaseDate | string (date-time) | no | length 0–40 |
data.expiryDate | string (date-time) | no | length 0–40 |
data.renewalDate | string (date-time) | no | length 0–40 |
data.autoRenew | boolean | no | |
data.notes | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
delete_assetwritepermission: delete
delete asset using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_assetreadpermission: view
Get an accessible asset by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_assetsreadpermission: view
List accessible assets. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDING | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_assetwritepermission: update
update asset using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.assetType | enum: DOMAIN | SERVER | SSL_CERTIFICATE | HOSTING | LICENSE | SOFTWARE | HARDWARE | SUBSCRIPTION | OTHER | no | |
data.status | enum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDING | no | |
data.provider | string | no | length 0–20000 |
data.accountRef | string | no | length 0–20000 |
data.cost | number | no | range 0–1000000000000 |
data.recurringCost | number | no | range 0–1000000000000 |
data.billingCycle | string | no | length 0–20000 |
data.purchaseDate | string (date-time) | no | length 0–40 |
data.expiryDate | string (date-time) | no | length 0–40 |
data.renewalDate | string (date-time) | no | length 0–40 |
data.autoRenew | boolean | no | |
data.notes | string | no | length 0–20000 |
data.customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Automation
Automations
AUTOMATIONS5 functionsReturned fields
idcreatedAtupdatedAtnamedescriptiontriggerTypeisActiveexecutionCountlastExecutedAtdelayMinutesmaxExecutions
Create fields
namedescriptiontriggerTypedelayMinutesmaxExecutions
Update fields
namedescriptiondelayMinutesmaxExecutions
create_automationwritepermission: createadmin/manager user
create automation using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.triggerType | enum: LEAD_CREATED | LEAD_STAGE_CHANGED | LEAD_SCORE_CHANGED | CUSTOMER_CREATED | CUSTOMER_STATUS_CHANGED | TICKET_CREATED | TICKET_STATUS_CHANGED | TICKET_PRIORITY_CHANGED | INVOICE_CREATED | INVOICE_STATUS_CHANGED | INVOICE_OVERDUE | QUOTE_CREATED | QUOTE_STATUS_CHANGED | QUOTE_ACCEPTED | … | yes | |
data.delayMinutes | integer | no | range 0–∞ |
data.maxExecutions | integer | no |
delete_automationwritepermission: deleteadmin/manager user
delete automation using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_automationreadpermission: viewadmin/manager user
Get an accessible automation by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_automationsreadpermission: viewadmin/manager user
List accessible automations. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
update_automationwritepermission: updateadmin/manager user
update automation using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
data.delayMinutes | integer | no | range 0–∞ |
data.maxExecutions | integer | no |
Chatbot Flows
CHATBOT_FLOWS5 functionsReturned fields
idcreatedAtupdatedAtnamedescriptiontypestatustriggerOnNewConversationisDefaulttotalSessionscompletedSessions
Create fields
namedescriptiontype
Update fields
namedescription
create_chatbot_flowwritepermission: create
create chatbot_flow using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
data | object | yes | |
data.name | string | yes | length 1–20000 |
data.description | string | no | length 0–20000 |
data.type | enum: LEAD_CAPTURE | SUPPORT | SALES | ONBOARDING | SURVEY | CUSTOM | no |
delete_chatbot_flowwritepermission: delete
delete chatbot_flow using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
get_chatbot_flowreadpermission: view
Get an accessible chatbot_flow by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_chatbot_flowsreadpermission: view
List accessible chatbot_flows. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DRAFT | ACTIVE | PAUSED | ARCHIVED | no |
update_chatbot_flowwritepermission: update
update chatbot_flow using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.name | string | no | length 1–20000 |
data.description | string | no | length 0–20000 |
Integrations
WhatsApp Business
WHATSAPP5 functionsReturned fields
idcreatedAtupdatedAtcontactPhonecontactNamecustomerIdcontactIdassignedToIdstatuslastMessageAtunreadCount
get_whatsapp_conversationreadpermission: view
Get an accessible whatsapp_conversation by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_whatsapp_conversationsreadpermission: view
List accessible whatsapp_conversations. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: OPEN | CLOSED | ARCHIVED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_whatsapp_messagesreadpermission: view
Read messages in one accessible conversation. Media storage paths and provider credentials are excluded.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
send_whatsapp_messagewritepermission: send
Send text to the saved recipient of an accessible WhatsApp conversation. Uses the existing provider; subject to its messaging window. No arbitrary recipient override.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
message | string | yes | length 1–4096 |
update_whatsapp_conversationwritepermission: update
update whatsapp_conversation using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.status | enum: OPEN | CLOSED | ARCHIVED | no | |
data.assignedToId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
Call Log
CALL_LOG4 functionsReturned fields
idcreatedAtupdatedAtdirectionstatusfromNumbertoNumberdurationisVoicemailnotesdispositioncustomerIdcontactIduserIdstartedAtendedAt
get_callreadpermission: view
Get an accessible call by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_callsreadpermission: view
List accessible calls. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: INITIATED | RINGING | IN_PROGRESS | COMPLETED | BUSY | NO_ANSWER | FAILED | CANCELED | no | |
customerId | string | no | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
start_phone_bridge_callwritepermission: create
Place a Twilio phone-bridge call to a saved customer phone. First rings the delegated staff member's profile phone, then connects the customer. NOT autonomous AI voice; may incur provider charges.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
customerId | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
update_callwritepermission: update
update call using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.
| Argument | Type | Required | Notes |
|---|---|---|---|
confirm | true (constant) | yes | Set true only after the human has authorized this action and its side effects. |
operationId | string | yes | length 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action. |
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
data | object | yes | |
data.notes | string | no | length 0–20000 |
data.disposition | enum: NO_DISPOSITION | ANSWERED | LEFT_VOICEMAIL | NO_ANSWER | BUSY | WRONG_NUMBER | FOLLOW_UP_NEEDED | RESOLVED | ESCALATED | no |
Sage Business Cloud Accounting
SAGE_SYNC2 functionsReturned fields
idcreatedAtupdatedAtstatusregionbusinessNamelastSyncAtconnectedAt
get_sage_connectionreadpermission: viewadmin/manager user
Get an accessible sage_connection by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_sage_connectionsreadpermission: viewadmin/manager user
List accessible sage_connections. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DISCONNECTED | CONNECTED | EXPIRED | ERROR | no |
Sage X3
SAGE_X32 functionsReturned fields
idcreatedAtupdatedAtstatuscompanyCodesiteCodedefaultCurrencylastSyncAtlastTestedAtconnectedAt
get_sage_x3_connectionreadpermission: viewadmin/manager user
Get an accessible sage_x3_connection by id. Never returns credentials or signing tokens.
| Argument | Type | Required | Notes |
|---|---|---|---|
id | string | yes | length 1–160 · pattern ^[A-Za-z0-9_-]+$ |
list_sage_x3_connectionsreadpermission: viewadmin/manager user
List accessible sage_x3_connections. Returns bounded pagination; monetary fields require financial access.
| Argument | Type | Required | Notes |
|---|---|---|---|
search | string | no | length 0–200 |
limit | integer | no | range 1–100 |
offset | integer | no | range 0–100000 |
status | enum: DISCONNECTED | CONNECTED | EXPIRED | ERROR | no |
Analytics
Reports & Analytics
REPORTS1 functionsget_sales_reportreadpermission: viewfinancial access
Scoped invoice totals grouped by record currency and status. Never combines different currencies. Requires both Reports and Invoicing financial access.
No arguments.