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.

166 functions27 modules33 resourcesMCP protocol 2024-11-05

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_xxxxxxxxxxxxxxxx

Connect 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 429 with a Retry-After header.
  • Batches of 1–20 JSON-RPC messages; request bodies up to 256 KiB (HTTP 413 above that).
  • HTTP 401: missing, invalid, revoked or expired key, or inactive delegated user. HTTP 403: the MCP Server add-on is not active.
  • JSON-RPC errors: -32700 parse error, -32600 invalid request, -32601 method not found, -32602 invalid params.
  • Validation and permission failures come back as a tools/call result with isError: 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 functions
customerno hard delete

Returned fields

idcreatedAtupdatedAtcustomerCodecompanyNametradingNamecustomerTypestatusindustryemailphonewebsitecitystatecountryvatNumberregistrationNodefaultPaymentTermscreditLimitpreferredCurrencyaccountManagerIdtags

Create fields

companyNametradingNamecustomerTypestatusindustryemailphonewebsiteaddresscitystatecountrypostalCodevatNumberregistrationNodefaultPaymentTermscreditLimitpreferredCurrencyaccountManagerIdtagsnotesfirstNamelastName

archive_customerwritepermission: delete

Archive/deactivate customer without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.firstNamestringyeslength 0–20000
data.lastNamestringyeslength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.mobilestringnolength 0–20000
data.rolestringnolength 0–20000
data.titlestringnolength 1–20000
data.departmentstringnolength 0–20000
data.contactTypestringnolength 0–20000
data.isPrimarybooleanno
data.isBillingbooleanno
data.isWhatsAppContactbooleanno
create_customerwritepermission: create

create customer using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.companyNamestringyeslength 1–20000
data.tradingNamestringnolength 0–20000
data.customerTypestringnolength 0–20000
data.statusstringnolength 0–20000
data.industrystringnolength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.websitestringnolength 0–20000
data.addressstringnolength 0–20000
data.citystringnolength 0–20000
data.statestringnolength 0–20000
data.countrystringnolength 0–20000
data.postalCodestringnolength 0–20000
data.vatNumberstringnolength 0–20000
data.registrationNostringnolength 0–20000
data.defaultPaymentTermsstringnolength 0–20000
data.creditLimitnumbernorange 0–1000000000000
data.preferredCurrencystringnolength 0–20000
data.accountManagerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000
data.notesstringnolength 0–20000
data.firstNamestringnolength 1–20000
data.lastNamestringnolength 1–20000
delete_contactwritepermission: delete

delete contact within an accessible customer. parentId is the parent record id. Standard activity/assignment notifications may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_contactreadpermission: view

Get one contact; both parentId and child id must match.

ArgumentTypeRequiredNotes
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_customerreadpermission: view

Get an accessible customer by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_contactsreadpermission: view

List contacts under an accessible customer. parentId is the customer id.

ArgumentTypeRequiredNotes
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
limitintegernorange 1–100
offsetintegernorange 0–100000
list_customersreadpermission: view

List accessible customers. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusstringnolength 0–20000
update_contactwritepermission: update

update contact within an accessible customer. parentId is the parent record id. Standard activity/assignment notifications may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.firstNamestringnolength 0–20000
data.lastNamestringnolength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.mobilestringnolength 0–20000
data.rolestringnolength 0–20000
data.titlestringnolength 1–20000
data.departmentstringnolength 0–20000
data.contactTypestringnolength 0–20000
data.isPrimarybooleanno
data.isBillingbooleanno
data.isWhatsAppContactbooleanno
update_customerwritepermission: update

update customer using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.companyNamestringnolength 1–20000
data.tradingNamestringnolength 0–20000
data.customerTypestringnolength 0–20000
data.statusstringnolength 0–20000
data.industrystringnolength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.websitestringnolength 0–20000
data.addressstringnolength 0–20000
data.citystringnolength 0–20000
data.statestringnolength 0–20000
data.countrystringnolength 0–20000
data.postalCodestringnolength 0–20000
data.vatNumberstringnolength 0–20000
data.registrationNostringnolength 0–20000
data.defaultPaymentTermsstringnolength 0–20000
data.creditLimitnumbernorange 0–1000000000000
data.preferredCurrencystringnolength 0–20000
data.accountManagerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000
data.notesstringnolength 0–20000
data.firstNamestringnolength 1–20000
data.lastNamestringnolength 1–20000

Lead Pipeline

LEADS5 functions
leadno hard delete

Returned fields

idcreatedAtupdatedAtcompanyNamecontactNamecontactEmailcontactPhonesourcestagevaluescoreratinggradeprobabilityindustryjobTitlewebsitecurrencyassignedToIdteamIdcustomerIdexpectedCloseDatelastContactedAtnextFollowUpAtconvertedAt

Create fields

companyNamecontactNamecontactEmailcontactPhonesourcevaluenotesassignedToIdteamIdcurrencyjobTitlewebsiteindustry

Update fields

companyNamecontactNamecontactEmailcontactPhonesourcestagevaluenotesassignedToIdteamIdcurrencyjobTitlewebsiteindustryexpectedCloseDatenextFollowUpAtisArchived

archive_leadwritepermission: delete

Archive/deactivate lead without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.companyNamestringyeslength 1–20000
data.contactNamestringyeslength 0–20000
data.contactEmailstringnolength 0–20000
data.contactPhonestringnolength 0–20000
data.sourcestringnolength 0–20000
data.valuenumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.assignedToIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.teamIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.jobTitlestringnolength 0–20000
data.websitestringnolength 0–20000
data.industrystringnolength 0–20000
get_leadreadpermission: view

Get an accessible lead by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_leadsreadpermission: view

List accessible leads. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
stageenum: NEW | CONTACTED | QUALIFIED | PROPOSAL_SENT | NEGOTIATION | WON | LOSTno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.companyNamestringnolength 1–20000
data.contactNamestringnolength 0–20000
data.contactEmailstringnolength 0–20000
data.contactPhonestringnolength 0–20000
data.sourcestringnolength 0–20000
data.stageenum: NEW | CONTACTED | QUALIFIED | PROPOSAL_SENT | NEGOTIATION | WON | LOSTno
data.valuenumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.assignedToIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.teamIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.jobTitlestringnolength 0–20000
data.websitestringnolength 0–20000
data.industrystringnolength 0–20000
data.expectedCloseDatestring (date-time)nolength 0–40
data.nextFollowUpAtstring (date-time)nolength 0–40
data.isArchivedbooleanno

Advanced Leads

LEADS_ADVANCED4 functions
pipeline

Returned fields

idcreatedAtupdatedAtnameisDefaultisActive

pipeline_stage

Returned fields

idcreatedAtupdatedAtpipelineIdnamesortOrderprobabilitytypecolorrottingDays

get_pipelinereadpermission: view

Get an accessible pipeline by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_pipeline_stagereadpermission: view

Get an accessible pipeline_stage by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_pipeline_stagesreadpermission: view

List accessible pipeline_stages. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
list_pipelinesreadpermission: view

List accessible pipelines. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000

Quotes

QUOTING6 functions
quoteedit/delete drafts onlymoney fields need financial access

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.validUntilstring (date-time)nolength 0–40
data.lineItemsarray<object>yesitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno
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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_quotereadpermission: view

Get an accessible quote by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_quotesreadpermission: view

List accessible quotes. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | SENT | VIEWED | ACCEPTED | REJECTED | EXPIREDno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
emailstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.validUntilstring (date-time)nolength 0–40
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno

Proposals

PROPOSALS6 functions
proposaledit/delete drafts onlymoney fields need financial access

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.summarystringnolength 0–20000
data.validUntilstring (date-time)nolength 0–40
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno
data.sectionsarray<object>noitems 0–50
data.sections[].titlestringyeslength 0–20000
data.sections[].contentstringyeslength 0–20000
data.sections[].sectionTypeenum: text | pricingno
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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_proposalreadpermission: view

Get an accessible proposal by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_proposalsreadpermission: view

List accessible proposals. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | REVIEW | SENT | VIEWED | ACCEPTED | REJECTED | EXPIREDno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
emailstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.summarystringnolength 0–20000
data.validUntilstring (date-time)nolength 0–40
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno
data.sectionsarray<object>noitems 0–50
data.sections[].titlestringyeslength 0–20000
data.sections[].contentstringyeslength 0–20000
data.sections[].sectionTypeenum: text | pricingno

Product Catalog

CATALOG5 functions
itemno hard deletemoney fields need financial access

Returned fields

idcreatedAtupdatedAtnameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdtrackInventorystockOnHandreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDaysisActive

Create fields

nameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDays

Update fields

nameskudescriptionlongDescriptiontypeunitPricecostPricecurrencyunittaxRateIdledgerAccountIdgroupIdreorderLevelreorderQtysupplierIdsupplierItemCodeleadTimeDaysisActive

archive_itemwritepermission: deletefinancial access

Archive/deactivate item without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.skustringnolength 0–20000
data.descriptionstringnolength 0–20000
data.longDescriptionstringnolength 0–20000
data.typeenum: SERVICE | DIGITAL | PHYSICALno
data.unitPricenumbernorange 0–1000000000000
data.costPricenumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.unitstringnolength 0–20000
data.taxRateIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ledgerAccountIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.groupIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.reorderLevelnumbernorange 0–∞
data.reorderQtynumbernorange 0–∞
data.supplierIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.supplierItemCodestringnolength 0–20000
data.leadTimeDaysintegerno
get_itemreadpermission: view

Get an accessible item by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_itemsreadpermission: view

List accessible items. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.skustringnolength 0–20000
data.descriptionstringnolength 0–20000
data.longDescriptionstringnolength 0–20000
data.typeenum: SERVICE | DIGITAL | PHYSICALno
data.unitPricenumbernorange 0–1000000000000
data.costPricenumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.unitstringnolength 0–20000
data.taxRateIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ledgerAccountIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.groupIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.reorderLevelnumbernorange 0–∞
data.reorderQtynumbernorange 0–∞
data.supplierIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.supplierItemCodestringnolength 0–20000
data.leadTimeDaysintegerno
data.isActivebooleanno

Finance

Invoicing

INVOICING17 functions
invoiceedit/delete drafts onlymoney fields need financial access

Returned fields

idcreatedAtupdatedAtinvoiceNumbertitlestatusissueDatedueDatesubtotaltaxAmountdiscounttotalamountPaidcurrencybaseCurrencybaseTotalcustomerIdprojectIdsentAtpaidAt

Create fields

titlecustomerIdcurrencytaxRatediscountnotesprojectIdtermsdueDateissueDatediscountType

recurring_invoiceno hard deletemoney fields need financial access

Returned fields

idcreatedAtupdatedAttitlefrequencystartDateendDatenextGenerateAtlastGeneratedAtisActiveautoSendsubtotaltaxAmountdiscounttotalcurrencycustomerIdprojectIdgeneratedCount

Create fields

titlecustomerIdcurrencytaxRatediscountnotesfrequencystartDateendDateprojectIdtermspaymentTermDaysdiscountType

Update fields

titlecustomerIdcurrencytaxRatediscountnotesfrequencystartDateendDateprojectIdtermspaymentTermDaysdiscountTypeisActive

credit_noteedit/delete drafts onlymoney fields need financial access

Returned fields

idcreatedAtupdatedAtcreditNoteNumbertitlestatusissueDatereasonsubtotaltaxAmountdiscounttotalamountAppliedcurrencybaseCurrencybaseTotalcustomerIdprojectIdinvoiceId

Create fields

titlecustomerIdcurrencytaxRatediscountnotesprojectIdinvoiceIdtermsreasonissueDatediscountType

archive_recurring_invoicewritepermission: deletefinancial access

Archive/deactivate recurring_invoice without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.customerIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.invoiceIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.reasonstringnolength 0–20000
data.issueDatestring (date-time)nolength 0–40
data.discountTypeenum: fixed | percentageno
data.lineItemsarray<object>yesitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].ledgerAccountIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.customerIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.dueDatestring (date-time)nolength 0–40
data.issueDatestring (date-time)nolength 0–40
data.discountTypeenum: fixed | percentageno
data.lineItemsarray<object>yesitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno
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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.frequencyenum: WEEKLY | BIWEEKLY | MONTHLY | QUARTERLY | BIANNUALLY | YEARLYno
data.startDatestring (date-time)yeslength 0–40
data.endDatestring (date-time)nolength 0–40
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.paymentTermDaysintegernorange 0–∞
data.discountTypeenum: fixed | percentageno
data.lineItemsarray<object>yesitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_credit_notereadpermission: view

Get an accessible credit_note by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_invoicereadpermission: view

Get an accessible invoice by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_recurring_invoicereadpermission: view

Get an accessible recurring_invoice by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_credit_notesreadpermission: view

List accessible credit_notes. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | ISSUED | PARTIALLY_APPLIED | APPLIED | VOIDno
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_invoicesreadpermission: view

List accessible invoices. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | SENT | VIEWED | PARTIALLY_PAID | PAID | OVERDUE | CANCELLED | REFUNDEDno
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_recurring_invoicesreadpermission: view

List accessible recurring_invoices. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
emailstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
emailstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.invoiceIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.reasonstringnolength 0–20000
data.issueDatestring (date-time)nolength 0–40
data.discountTypeenum: fixed | percentageno
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].ledgerAccountIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.dueDatestring (date-time)nolength 0–40
data.issueDatestring (date-time)nolength 0–40
data.discountTypeenum: fixed | percentageno
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].discountnumbernorange 0–1000000000000
data.lineItems[].discountTypeenum: fixed | percentageno
data.lineItems[].groupNamestringnolength 0–20000
data.lineItems[].isOptionalbooleanno
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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.currencystringnolength 0–20000
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.notesstringnolength 0–20000
data.frequencyenum: WEEKLY | BIWEEKLY | MONTHLY | QUARTERLY | BIANNUALLY | YEARLYno
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.termsstringnolength 0–20000
data.paymentTermDaysintegernorange 0–∞
data.discountTypeenum: fixed | percentageno
data.isActivebooleanno
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000

Expenses

EXPENSES10 functions
billedit/delete drafts onlymoney fields need financial access

Returned fields

idcreatedAtupdatedAtbillNumbersupplierReferencetitlecategoryvendorstatusissueDatedueDatesubtotaltaxAmountdiscounttotalamountPaidcurrencysupplierIdprojectIdledgerAccountId

Create fields

titlesupplierReferencecategoryvendorissueDatedueDatetaxRatediscountdiscountTypecurrencysupplierIdprojectIdledgerAccountIdnotesterms

supplierno hard delete

Returned fields

idcreatedAtupdatedAtnamecodecontactNameemailphonewebsiteaddressnotesisActivetaxNumbercurrency

Create fields

namecodecontactNameemailphonewebsiteaddressnotestaxNumbercurrency

Update fields

namecodecontactNameemailphonewebsiteaddressnotestaxNumbercurrencyisActive

archive_supplierwritepermission: delete

Archive/deactivate supplier without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.supplierReferencestringnolength 0–20000
data.categorystringnolength 0–20000
data.vendorstringnolength 0–20000
data.issueDatestring (date-time)nolength 0–40
data.dueDatestring (date-time)nolength 0–40
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.discountTypeenum: fixed | percentageno
data.currencystringnolength 0–20000
data.supplierIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ledgerAccountIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.notesstringnolength 0–20000
data.termsstringnolength 0–20000
data.lineItemsarray<object>yesitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].ledgerAccountIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.codestringnolength 0–20000
data.contactNamestringnolength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.websitestringnolength 0–20000
data.addressstringnolength 0–20000
data.notesstringnolength 0–20000
data.taxNumberstringnolength 0–20000
data.currencystringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_billreadpermission: view

Get an accessible bill by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_supplierreadpermission: view

Get an accessible supplier by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_billsreadpermission: view

List accessible bills. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | AWAITING_PAYMENT | PARTIALLY_PAID | PAID | OVERDUE | VOIDno
projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_suppliersreadpermission: view

List accessible suppliers. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.supplierReferencestringnolength 0–20000
data.categorystringnolength 0–20000
data.vendorstringnolength 0–20000
data.issueDatestring (date-time)nolength 0–40
data.dueDatestring (date-time)nolength 0–40
data.taxRatenumbernorange 0–100
data.discountnumbernorange 0–1000000000000
data.discountTypeenum: fixed | percentageno
data.currencystringnolength 0–20000
data.supplierIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ledgerAccountIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.notesstringnolength 0–20000
data.termsstringnolength 0–20000
data.lineItemsarray<object>noitems 1–100
data.lineItems[].descriptionstringyeslength 1–20000
data.lineItems[].detailsstringnolength 0–20000
data.lineItems[].quantitynumberyesrange 0.000001–1000000000
data.lineItems[].unitPricenumberyesrange 0–1000000000000
data.lineItems[].ledgerAccountIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.codestringnolength 0–20000
data.contactNamestringnolength 0–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.websitestringnolength 0–20000
data.addressstringnolength 0–20000
data.notesstringnolength 0–20000
data.taxNumberstringnolength 0–20000
data.currencystringnolength 0–20000
data.isActivebooleanno

Payments

PAYMENTS4 functions
paymentno hard deletemoney fields need financial access

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.amountnumberyesrange 0–1000000000000
data.typeenum: CUSTOMER_PAYMENT | REFUND | CREDIT_NOTEno
data.methodstringnolength 0–20000
data.referencestringnolength 0–20000
data.notesstringnolength 0–20000
data.paymentDatestring (date-time)nolength 0–40
data.currencystringnolength 0–20000
data.customerIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_paymentreadpermission: view

Get an accessible payment by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 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.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Accounting

ACCOUNTING10 functions
journaledit/delete drafts onlymoney fields need financial accessadmin/manager user

Returned fields

idcreatedAtupdatedAtentryNumberdatereferencenarrationstatussourcetotalDebittotalCreditcurrencypostedAt

Create fields

datereferencenarrationcurrency

ledger_accountno hard deletemoney fields need financial access

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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.datestring (date-time)nolength 0–40
data.referencestringnolength 0–20000
data.narrationstringnolength 0–20000
data.currencystringnolength 0–20000
data.linesarray<object>yesitems 1–100
data.lines[].ledgerAccountIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.lines[].descriptionstringnolength 0–20000
data.lines[].debitnumberyesrange 0–1000000000000
data.lines[].creditnumberyesrange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.codestringyeslength 0–20000
data.namestringyeslength 1–20000
data.typeenum: ASSET | LIABILITY | EQUITY | INCOME | EXPENSEyes
data.categorystringnolength 0–20000
data.descriptionstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_journalreadpermission: viewadmin/manager user

Get an accessible journal by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_ledger_accountreadpermission: view

Get an accessible ledger_account by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_journalsreadpermission: viewadmin/manager user

List accessible journals. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | POSTED | VOIDno
list_ledger_accountsreadpermission: view

List accessible ledger_accounts. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.datestring (date-time)nolength 0–40
data.referencestringnolength 0–20000
data.narrationstringnolength 0–20000
data.currencystringnolength 0–20000
data.linesarray<object>noitems 1–100
data.lines[].ledgerAccountIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.lines[].descriptionstringnolength 0–20000
data.lines[].debitnumberyesrange 0–1000000000000
data.lines[].creditnumberyesrange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.categorystringnolength 0–20000
data.descriptionstringnolength 0–20000
data.isActivebooleanno

Operations

Project Management

PROJECTS10 functions
projectno hard delete

Returned fields

idcreatedAtupdatedAtprojectCodenamedescriptionstatuspriorityhealthcategorystartDateendDatebudgetestimatedHourscurrencytagscustomerIdmanagerId

Create fields

namedescriptionstatuspriorityhealthcategorystartDateendDatebudgetestimatedHourscurrencytagscustomerIdmanagerId

archive_projectwritepermission: delete

Archive/deactivate project without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.statusenum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLEDno
data.priorityenum: LOW | MEDIUM | HIGH | CRITICALno
data.healthenum: ON_TRACK | AT_RISK | BEHIND | COMPLETEDno
data.categorystringnolength 0–20000
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.budgetnumbernorange 0–1000000000000
data.estimatedHoursnumbernorange 0–∞
data.currencystringnolength 0–20000
data.tagsstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.managerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.statusenum: BACKLOG | TODO | IN_PROGRESS | IN_REVIEW | DONEno
data.priorityenum: LOW | MEDIUM | HIGH | URGENTno
data.startDatestring (date-time)nolength 0–40
data.dueDatestring (date-time)nolength 0–40
data.assigneeIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.estimatedHoursnumbernorange 0–1000000
data.labelsstringnolength 0–20000
data.sortOrderintegerno
delete_project_taskwritepermission: delete

delete project_task within an accessible project. parentId is the parent record id. Standard activity/assignment notifications may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_projectreadpermission: view

Get an accessible project by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_project_taskreadpermission: view

Get one project_task; both parentId and child id must match.

ArgumentTypeRequiredNotes
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_project_tasksreadpermission: view

List project_tasks under an accessible project. parentId is the project id.

ArgumentTypeRequiredNotes
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
limitintegernorange 1–100
offsetintegernorange 0–100000
list_projectsreadpermission: view

List accessible projects. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLEDno
priorityenum: LOW | MEDIUM | HIGH | CRITICALno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.statusenum: PLANNING | IN_PROGRESS | ON_HOLD | COMPLETED | CANCELLEDno
data.priorityenum: LOW | MEDIUM | HIGH | CRITICALno
data.healthenum: ON_TRACK | AT_RISK | BEHIND | COMPLETEDno
data.categorystringnolength 0–20000
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.budgetnumbernorange 0–1000000000000
data.estimatedHoursnumbernorange 0–∞
data.currencystringnolength 0–20000
data.tagsstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.managerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
parentIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.statusenum: BACKLOG | TODO | IN_PROGRESS | IN_REVIEW | DONEno
data.priorityenum: LOW | MEDIUM | HIGH | URGENTno
data.startDatestring (date-time)nolength 0–40
data.dueDatestring (date-time)nolength 0–40
data.assigneeIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.estimatedHoursnumbernorange 0–1000000
data.labelsstringnolength 0–20000
data.sortOrderintegerno

Time Tracking

TIME_TRACKING5 functions
time_entry

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.descriptionstringnolength 0–20000
data.startTimestring (date-time)yeslength 0–40
data.endTimestring (date-time)nolength 0–40
data.durationintegernorange 0–∞
data.billablebooleanno
data.hourlyRatenumbernorange 0–1000000000000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.taskIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_time_entryreadpermission: view

Get an accessible time_entry by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_time_entriesreadpermission: view

List accessible time_entries. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
projectIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.descriptionstringnolength 0–20000
data.startTimestring (date-time)nolength 0–40
data.endTimestring (date-time)nolength 0–40
data.durationintegernorange 0–∞
data.billablebooleanno
data.hourlyRatenumbernorange 0–1000000000000
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.taskIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Calendar

CALENDAR5 functions
event

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.typeenum: MEETING | CALL | FOLLOW_UP | DEADLINE | REMINDER | OTHERno
data.startDatestring (date-time)yeslength 0–40
data.endDatestring (date-time)yeslength 0–40
data.allDaybooleanno
data.locationstringnolength 0–20000
data.colorstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_eventreadpermission: view

Get an accessible event by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_eventsreadpermission: view

List accessible events. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.typeenum: MEETING | CALL | FOLLOW_UP | DEADLINE | REMINDER | OTHERno
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.allDaybooleanno
data.locationstringnolength 0–20000
data.colorstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.leadIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Contracts

CONTRACTS7 functions
contractedit/delete drafts onlymoney fields need financial access

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
namestringyeslength 1–20000
emailstringyeslength 3–254 · pattern ^[^\s@]+@[^\s@]+\.[^\s@]+$
titlestringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.typeenum: SERVICE_AGREEMENT | SLA_CONTRACT | MAINTENANCE | SUBSCRIPTION | PROJECT_BASED | RETAINER | NDA | CONSULTING | LICENSING | OTHERno
data.valuenumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.billingCyclestringnolength 0–20000
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.renewalDatestring (date-time)nolength 0–40
data.autoRenewbooleanno
data.renewalPeriodDaysintegernorange 0–∞
data.renewalNoticeDaysintegernorange 0–∞
data.termsstringnolength 0–20000
data.specialConditionsstringnolength 0–20000
data.cancellationTermsstringnolength 0–20000
data.paymentTermsstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ownerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.notesstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_contractreadpermission: view

Get an accessible contract by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_contractsreadpermission: view

List accessible contracts. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | PENDING_APPROVAL | PENDING_SIGNATURE | PARTIALLY_SIGNED | ACTIVE | ON_HOLD | EXPIRING_SOON | EXPIRED | RENEWED | CANCELLED | TERMINATEDno
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
confirmInternalSignaturestrue (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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.typeenum: SERVICE_AGREEMENT | SLA_CONTRACT | MAINTENANCE | SUBSCRIPTION | PROJECT_BASED | RETAINER | NDA | CONSULTING | LICENSING | OTHERno
data.valuenumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.billingCyclestringnolength 0–20000
data.startDatestring (date-time)nolength 0–40
data.endDatestring (date-time)nolength 0–40
data.renewalDatestring (date-time)nolength 0–40
data.autoRenewbooleanno
data.renewalPeriodDaysintegernorange 0–∞
data.renewalNoticeDaysintegernorange 0–∞
data.termsstringnolength 0–20000
data.specialConditionsstringnolength 0–20000
data.cancellationTermsstringnolength 0–20000
data.paymentTermsstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.ownerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.notesstringnolength 0–20000
data.bodyHtmlstringnolength 0–20000
data.signingModeenum: PARALLEL | SEQUENTIALno

Inventory

INVENTORY8 functions
stock_locationno hard delete

Returned fields

idcreatedAtupdatedAtnamecodeaddressisDefaultisActive

Create fields

namecodeaddressisDefault

Update fields

namecodeaddressisDefaultisActive

stock_movementno hard deletemoney fields need financial access

Returned fields

idcreatedAtupdatedAttypequantitycostPerUnittotalCostreferencenotesitemIdlocationIdsupplierIdperformedById

Create fields

typequantitycostPerUnitreferencenotesitemIdlocationIdsupplierId

archive_stock_locationwritepermission: delete

Archive/deactivate stock_location without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.codestringnolength 0–20000
data.addressstringnolength 0–20000
data.isDefaulttrue (constant)noSet 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.typeenum: RECEIVED | SOLD | ADJUSTED | RETURNED | TRANSFERRED_IN | TRANSFERRED_OUT | WRITTEN_OFF | INITIALyes
data.quantitynumberyes
data.costPerUnitnumbernorange 0–1000000000000
data.referencestringnolength 0–20000
data.notesstringnolength 0–20000
data.itemIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.locationIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.supplierIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_stock_locationreadpermission: view

Get an accessible stock_location by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_stock_movementreadpermission: view

Get an accessible stock_movement by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_stock_locationsreadpermission: view

List accessible stock_locations. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
list_stock_movementsreadpermission: view

List accessible stock_movements. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.codestringnolength 0–20000
data.addressstringnolength 0–20000
data.isDefaulttrue (constant)noSet this location as the default; the prior default is unset.
data.isActivebooleanno

Support

Support Desk

TICKETS5 functions
ticketno hard delete

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.subjectstringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.priorityenum: LOW | MEDIUM | HIGH | URGENT | CRITICALno
data.channelenum: MANUAL | EMAIL | WEB_FORM | WHATSAPP | PHONE | PORTAL | SOCIAL_MEDIAno
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.contactNamestringnolength 0–20000
data.contactEmailstringnolength 0–20000
data.contactPhonestringnolength 0–20000
data.assignedToIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.teamIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.departmentIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.categoryIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000
get_ticketreadpermission: view

Get an accessible ticket by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_ticketsreadpermission: view

List accessible tickets. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: OPEN | IN_PROGRESS | WAITING_ON_CUSTOMER | WAITING_ON_THIRD_PARTY | RESOLVED | CLOSED | CANCELLEDno
priorityenum: LOW | MEDIUM | HIGH | URGENT | CRITICALno
customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
projectIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
set_ticket_statuswritepermission: update

Change ticket status through its audited workflow; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
statusenum: OPEN | IN_PROGRESS | WAITING_ON_CUSTOMER | WAITING_ON_THIRD_PARTY | RESOLVED | CLOSED | CANCELLEDyes
update_ticketwritepermission: update

update ticket using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.subjectstringnolength 1–20000
data.descriptionstringnolength 0–20000
data.priorityenum: LOW | MEDIUM | HIGH | URGENT | CRITICALno
data.teamIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.departmentIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.categoryIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000

Knowledge Base

KNOWLEDGE_BASE10 functions
article

Returned fields

idcreatedAtupdatedAttitleslugcontentexcerptstatusvisibilityisPinnedtagsspaceIdcategoryIdauthorIdpublishedAt

Create fields

titlecontentexcerptvisibilityspaceIdcategoryIdtagsisPinned

Update fields

titlecontentexcerptvisibilitycategoryIdtagsisPinned

knowledge_spaceno hard delete

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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.contentstringnolength 0–20000
data.excerptstringnolength 0–20000
data.visibilityenum: INTERNAL | PORTAL | PUBLICno
data.spaceIdstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.categoryIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000
data.isPinnedbooleanno
create_knowledge_spacewritepermission: create

create knowledge_space using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.iconstringnolength 0–20000
data.colorstringnolength 0–20000
data.sortOrderintegerno
delete_articlewritepermission: delete

delete article using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_articlereadpermission: view

Get an accessible article by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_knowledge_spacereadpermission: view

Get an accessible knowledge_space by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_articlesreadpermission: view

List accessible articles. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | PUBLISHED | ARCHIVEDno
list_knowledge_spacesreadpermission: view

List accessible knowledge_spaces. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
update_articlewritepermission: update

update article using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.contentstringnolength 0–20000
data.excerptstringnolength 0–20000
data.visibilityenum: INTERNAL | PORTAL | PUBLICno
data.categoryIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.tagsstringnolength 0–20000
data.isPinnedbooleanno
update_knowledge_spacewritepermission: update

update knowledge_space using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.iconstringnolength 0–20000
data.colorstringnolength 0–20000
data.isActivebooleanno

Human Resources

HR & Team

HR5 functions
employeeno hard deletemoney fields need financial access

Returned fields

idcreatedAtupdatedAtemployeeCodefirstNamelastNameemailphoneemploymentTypestatusjoinDatesalarycurrencydepartmentIdpositionIdmanagerIduserId

Create fields

firstNamelastNameemailphoneemploymentTypestatusjoinDatesalarycurrencydepartmentIdpositionIdmanagerId

archive_employeewritepermission: deletefinancial access

Archive/deactivate employee without removing its history. Requires delete and update permissions.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.firstNamestringyeslength 1–20000
data.lastNamestringyeslength 1–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.employmentTypeenum: FULL_TIME | PART_TIME | CONTRACT | INTERN | FREELANCEno
data.statusenum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNEDno
data.joinDatestring (date-time)nolength 0–40
data.salarynumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.departmentIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.positionIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.managerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_employeereadpermission: view

Get an accessible employee by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_employeesreadpermission: view

List accessible employees. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNEDno
update_employeewritepermission: updatefinancial access

update employee using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.firstNamestringnolength 1–20000
data.lastNamestringnolength 1–20000
data.emailstringnolength 0–20000
data.phonestringnolength 0–20000
data.employmentTypeenum: FULL_TIME | PART_TIME | CONTRACT | INTERN | FREELANCEno
data.statusenum: ACTIVE | ON_LEAVE | SUSPENDED | PROBATION | TERMINATED | RESIGNEDno
data.joinDatestring (date-time)nolength 0–40
data.salarynumbernorange 0–1000000000000
data.currencystringnolength 0–20000
data.departmentIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.positionIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$
data.managerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Security

Password Vault

VAULT5 functions
vault_entry

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.titlestringyeslength 1–20000
data.categoryenum: HOSTING | DOMAIN_REGISTRAR | EMAIL | CPANEL | FTP | DATABASE | API_KEY | SSL | DNS | CLOUD | VPN | OTHERno
data.usernamestringnolength 0–20000
data.urlstringnolength 0–20000
data.customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_vault_entryreadpermission: view

Get an accessible vault_entry by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_vault_entriesreadpermission: view

List accessible vault_entries. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.titlestringnolength 1–20000
data.categoryenum: HOSTING | DOMAIN_REGISTRAR | EMAIL | CPANEL | FTP | DATABASE | API_KEY | SSL | DNS | CLOUD | VPN | OTHERno
data.usernamestringnolength 0–20000
data.urlstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Asset Management

ASSETS5 functions
asset

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.assetTypeenum: DOMAIN | SERVER | SSL_CERTIFICATE | HOSTING | LICENSE | SOFTWARE | HARDWARE | SUBSCRIPTION | OTHERyes
data.statusenum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDINGno
data.providerstringnolength 0–20000
data.accountRefstringnolength 0–20000
data.costnumbernorange 0–1000000000000
data.recurringCostnumbernorange 0–1000000000000
data.billingCyclestringnolength 0–20000
data.purchaseDatestring (date-time)nolength 0–40
data.expiryDatestring (date-time)nolength 0–40
data.renewalDatestring (date-time)nolength 0–40
data.autoRenewbooleanno
data.notesstringnolength 0–20000
data.customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_assetreadpermission: view

Get an accessible asset by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_assetsreadpermission: view

List accessible assets. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDINGno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.assetTypeenum: DOMAIN | SERVER | SSL_CERTIFICATE | HOSTING | LICENSE | SOFTWARE | HARDWARE | SUBSCRIPTION | OTHERno
data.statusenum: ACTIVE | EXPIRING_SOON | EXPIRED | DECOMMISSIONED | PENDINGno
data.providerstringnolength 0–20000
data.accountRefstringnolength 0–20000
data.costnumbernorange 0–1000000000000
data.recurringCostnumbernorange 0–1000000000000
data.billingCyclestringnolength 0–20000
data.purchaseDatestring (date-time)nolength 0–40
data.expiryDatestring (date-time)nolength 0–40
data.renewalDatestring (date-time)nolength 0–40
data.autoRenewbooleanno
data.notesstringnolength 0–20000
data.customerIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Automation

Automations

AUTOMATIONS5 functions
automationadmin/manager user

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.triggerTypeenum: 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.delayMinutesintegernorange 0–∞
data.maxExecutionsintegerno
delete_automationwritepermission: deleteadmin/manager user

delete automation using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_automationreadpermission: viewadmin/manager user

Get an accessible automation by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_automationsreadpermission: viewadmin/manager user

List accessible automations. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.descriptionstringnolength 0–20000
data.delayMinutesintegernorange 0–∞
data.maxExecutionsintegerno

Chatbot Flows

CHATBOT_FLOWS5 functions
chatbot_flow

Returned 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
dataobjectyes
data.namestringyeslength 1–20000
data.descriptionstringnolength 0–20000
data.typeenum: LEAD_CAPTURE | SUPPORT | SALES | ONBOARDING | SURVEY | CUSTOMno
delete_chatbot_flowwritepermission: delete

delete chatbot_flow using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
get_chatbot_flowreadpermission: view

Get an accessible chatbot_flow by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_chatbot_flowsreadpermission: view

List accessible chatbot_flows. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DRAFT | ACTIVE | PAUSED | ARCHIVEDno
update_chatbot_flowwritepermission: update

update chatbot_flow using the application's existing workflow. Requires explicit confirmation and operationId; configured notifications and automations may run.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.namestringnolength 1–20000
data.descriptionstringnolength 0–20000

Integrations

WhatsApp Business

WHATSAPP5 functions
whatsapp_conversationno hard delete

Returned fields

idcreatedAtupdatedAtcontactPhonecontactNamecustomerIdcontactIdassignedToIdstatuslastMessageAtunreadCount

get_whatsapp_conversationreadpermission: view

Get an accessible whatsapp_conversation by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_whatsapp_conversationsreadpermission: view

List accessible whatsapp_conversations. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: OPEN | CLOSED | ARCHIVEDno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
limitintegernorange 1–100
offsetintegernorange 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
messagestringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.statusenum: OPEN | CLOSED | ARCHIVEDno
data.assignedToIdstringnolength 1–160 · pattern ^[A-Za-z0-9_-]+$

Call Log

CALL_LOG4 functions
callno hard delete

Returned fields

idcreatedAtupdatedAtdirectionstatusfromNumbertoNumberdurationisVoicemailnotesdispositioncustomerIdcontactIduserIdstartedAtendedAt

get_callreadpermission: view

Get an accessible call by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
list_callsreadpermission: view

List accessible calls. Returns bounded pagination; monetary fields require financial access.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: INITIATED | RINGING | IN_PROGRESS | COMPLETED | BUSY | NO_ANSWER | FAILED | CANCELEDno
customerIdstringnolength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
customerIdstringyeslength 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.

ArgumentTypeRequiredNotes
confirmtrue (constant)yesSet true only after the human has authorized this action and its side effects.
operationIdstringyeslength 12–120 · pattern ^[A-Za-z0-9_-]+$ · Unique operation identifier. Reuse for retries of exactly the same request; never reuse for another action.
idstringyeslength 1–160 · pattern ^[A-Za-z0-9_-]+$
dataobjectyes
data.notesstringnolength 0–20000
data.dispositionenum: NO_DISPOSITION | ANSWERED | LEFT_VOICEMAIL | NO_ANSWER | BUSY | WRONG_NUMBER | FOLLOW_UP_NEEDED | RESOLVED | ESCALATEDno

Sage Business Cloud Accounting

SAGE_SYNC2 functions
sage_connectionadmin/manager user

Returned fields

idcreatedAtupdatedAtstatusregionbusinessNamelastSyncAtconnectedAt

get_sage_connectionreadpermission: viewadmin/manager user

Get an accessible sage_connection by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 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.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DISCONNECTED | CONNECTED | EXPIRED | ERRORno

Sage X3

SAGE_X32 functions
sage_x3_connectionadmin/manager user

Returned fields

idcreatedAtupdatedAtstatuscompanyCodesiteCodedefaultCurrencylastSyncAtlastTestedAtconnectedAt

get_sage_x3_connectionreadpermission: viewadmin/manager user

Get an accessible sage_x3_connection by id. Never returns credentials or signing tokens.

ArgumentTypeRequiredNotes
idstringyeslength 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.

ArgumentTypeRequiredNotes
searchstringnolength 0–200
limitintegernorange 1–100
offsetintegernorange 0–100000
statusenum: DISCONNECTED | CONNECTED | EXPIRED | ERRORno

Analytics

Reports & Analytics

REPORTS1 functions
get_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.

ProxCore Platform API Documentation