Documentation

Everything you need to run OpSyn.

Operator handbooks, admin guides, integration specs, and the full REST API reference. Written by the team that runs the platform — and updated each release.

Browse by audience

The library is structured around the people doing the work. Operators get task-level handbooks; administrators get configuration guides; developers get the API reference.

Getting started

Sign in, set up your first organisation, run your first shift, and read your first dashboard — in under an hour.

  • Account & 2FA setup
  • Defining your first department
  • Logging your first shift
  • Reading the OEE board

Operator handbook

Daily and per-shift workflows for line operators and team leaders.

  • Shift logging
  • Downtime entry & taxonomy
  • Process logs & checklists
  • First-off and quality holds

Inventory & stores

Stock movement, counting, and variance management across multiple locations.

  • Receipts, issues, transfers
  • Cycle counts & variance
  • Reserved-inventory tracking
  • Low-stock and overstock alerts

Purchasing

Requisition lifecycle, approvals, and vendor management.

  • Raising a requisition
  • Approval chain configuration
  • Vendor records & terms
  • Line-item cost tracking

Production & BOM

Production orders, bills of materials, routing steps, and asset linkage.

  • BOM line items & versions
  • Routing steps
  • Asset & equipment register
  • Linking shifts to orders

Financial forecasting

Chart of accounts, cost centres, monthly forecast versions, and GL mapping.

  • CoA & cost-centre setup
  • Monthly forecast entry
  • Forecast versioning
  • GL mapping & exports

Administration

Configure your tenant, users, roles, feature flags, and audit settings.

  • Departments & processes
  • OEE definitions
  • RBAC: action × access × entity
  • Per-module feature flags

Integrations

Get data in and out of OpSyn — bulk imports, ERP/MES sync, and reporting.

  • CSV bulk import
  • REST API sync
  • Custom SQL reporting
  • Webhook events

API reference

Authentication, schemas, and all 52 REST endpoints with example requests.

  • Auth & API tokens
  • Pagination & filtering
  • Error model
  • Endpoint catalogue

The full library lives inside OpSyn

Every module's documentation sits next to the feature it describes. Operator handbooks open inline at the point of use; admin guides surface in the configuration screens; the API reference is rendered against your tenant's real schema.

Sign in to view the catalogue against your organisation's modules, or book a demo and we'll walk through it with you.