API reference

Reference for the Faciotech Business Platform APIs, generated from their OpenAPI 3.0 specifications. Each API page lists its endpoints with parameters, request and response fields, and example payloads.

API	Endpoints	About
Finance	4	Manages general-ledger close runs, accounting period locks, and bank reconciliation imports for the Paxus Finance module. All endpoints require an authenticated tenant session with finance-ops permissions.
POS	6	Manages Point-of-Sale offline transaction batches and cashier sessions for the ClarusPOS module. The offline sync endpoints allow POS terminals that lost connectivity to push buffered transactions and have them reconciled against the server state. Session endpoints control cashier shift open/close lifecycle.
Payroll	58	Partner-grade payroll APIs for the VeritasRoll module. Covers time-event ingestion, payroll run management, payment batches, statutory filings, general ledger exports, garnishment orders, earned-wage access (EWA), and anomaly management. All POST endpoints that modify financial state support the Idempotency-Key header.
HR	14	Covers the SyneraHR workforce planning module: compensation bands, succession pools, and workforce plans. Also exposes employee, leave, performance, onboarding, and org-structure (branches, departments, positions) endpoints derived from the module routes. All endpoints require a tenant-authenticated session with HR permissions.
Sales	8	Covers the Sales module: territory management, quota plans, forecast confidence explanation, and the playbook library. Additional deal, quote, pipeline, CPQ, renewal, and analytics operations are available via the same module route prefix. All endpoints require a tenant-authenticated session with sales permissions.
Support	14	Covers the Support module: CSAT surveys, NPS campaigns, QA scorecards, and support brands. Also exposes ticket, reply, attachment, knowledge base, SLA policy, canned response, and KB category operations derived from the module routes. All endpoints require a tenant-authenticated session with support permissions.
Automation	8	Manages event-driven workflows in the Automation module. Workflows consist of a trigger event, optional conditions, and an ordered list of actions. Every save automatically creates a versioned snapshot. Activation publishes the latest version. Workflow runs are immutable audit records created when a live workflow fires. All endpoints require a tenant-authenticated session with automation permissions.
Integrations	9	Manages third-party connector accounts, field mappings, webhooks, sync jobs, and the outbox replay center in the Integrations module. Connectors bridge the CRM with external systems (CRMs, support tools, analytics, messaging). Field mappings define how data translates between systems. Webhooks deliver outbound events. Sync jobs execute bulk data transfers. The replay center allows re-queuing of failed outbox events. All endpoints require a tenant-authenticated session with integrations permissions.
Customer 360	15	Provides a unified customer data platform across the Customer360 module: customer profiles (with health scoring), behavioural segments, customer health scores, lifecycle journeys, and duplicate merge reviews. Profiles aggregate identities from multiple systems; health scores are automatically recalculated on profile save. All endpoints require a tenant-authenticated session with Customer360 permissions.
Omnichannel	18	Manages cross-channel customer conversations, channel configurations, channel profiles, routing rules, SLA policies, and quality reviews within a tenant workspace.
Revenue+	19	Manages recurring revenue contracts, price books, subscription lifecycle, billing schedules, and renewal forecasts within a tenant workspace. Part of the RevenuePlus module.
AI Copilot	15	Manages AI-powered prompt templates, copilot query execution, evaluation suites, governance policies, and approval workflows within a tenant workspace. Part of the AiCopilot module.
Marketplace	15	Manages the Faciotech CRM app marketplace: app listings, developer submissions, security scanning, approval workflows, tenant installations, and app ratings. Part of the Marketplace module.
Office Suite	17	Template management, merge-field bindings, document render jobs, multi-format conversion, worker runtime health, and central tenant administration for the OfficeSuite module. Render jobs are processed asynchronously; poll /render-jobs/{id} until status is "completed".
Tenant Control Plane	17	Administrative API for the Faciotech CRM platform control plane. Manages tenant impersonation sessions, lifecycle requests, health diagnostics, policy bundles, session revocation, identity provisioning configuration (SSO/SCIM), and security audit events. All endpoints require platform admin authentication.