# ERPDesktop

## Docs

- [ERPDesktop AI Assistant: Query Your ERP in Plain English](https://erpdesktop.com/docs/ai-assistant.md): ERPDesktop's AI assistant turns plain English into ERP reports, PDF exports, and drafted emails — no menu navigation or database queries required.
- [ERPDesktop Agent Health, Info, and Status Endpoints](https://erpdesktop.com/docs/api/agent.md): Use GET /api/v1/health for an unauthenticated liveness probe and GET /api/v1/info for extended agent status, version, and ERP connection details.
- [ERPDesktop Agent API — Authentication and API Keys](https://erpdesktop.com/docs/api/authentication.md): Generate an API key in ERPDesktop, then pass it as a Bearer token in the Authorization header to authenticate every agent REST API request.
- [ERPDesktop Backups API — Trigger and Monitor Backups](https://erpdesktop.com/docs/api/backups.md): POST /api/v1/backups/run to trigger an immediate ERP backup via the ERPDesktop agent. List and monitor recent backup jobs with GET /api/v1/backups.
- [List Hardware Devices via the ERPDesktop Devices API](https://erpdesktop.com/docs/api/devices.md): GET /api/v1/devices — list all configured hardware devices and their current status. Use the devices endpoint to monitor biometric readers and printers.
- [ERPDesktop Agent REST API Reference and Error Codes](https://erpdesktop.com/docs/api/overview.md): The ERPDesktop agent exposes a REST API for programmatic control of devices, backups, and plugins. Learn the base URL, response format, and error codes.
- [ERPDesktop Plugins API — List Plugins and Commands](https://erpdesktop.com/docs/api/plugins.md): GET /api/v1/plugins — list installed ERPDesktop plugins and their status. Use the plugins API to monitor plugin health and invoke plugin commands.
- [Automated Encrypted Backups — Configure and Restore](https://erpdesktop.com/docs/backups.md): Keep AES-256 encrypted ERP backups on your machine with ERPDesktop. Automatic snapshots run on your schedule — restore any point in a single click.
- [Biometric Device Setup and ERP Attendance Sync Guide](https://erpdesktop.com/docs/biometric.md): Connect ZKTeco biometric readers to ERPDesktop for automatic attendance sync. Map employee IDs, set sync intervals, and configure device failover.
- [ERPDesktop FAQ — Pricing, Plugins, and Compatibility](https://erpdesktop.com/docs/faq.md): Answers to the most common questions about ERPDesktop — pricing, supported ERP versions, hardware compatibility, offline mode, plugin safety, and more.
- [ERPDesktop Features: Hardware, Offline, AI, and More](https://erpdesktop.com/docs/features.md): Explore ERPDesktop's core capabilities: hardware integrations, offline mode, encrypted backups, AI assistant, thermal printing, and the plugin marketplace.
- [How to Install ERPDesktop on macOS, Windows, or Linux](https://erpdesktop.com/docs/installation.md): Download and install the ERPDesktop desktop app and the server-side agent on any supported platform. Step-by-step setup for macOS, Windows, and Linux.
- [ERPDesktop: Native ERP Operations from Your Desktop](https://erpdesktop.com/docs/introduction.md): Learn what ERPDesktop is, who it's for, and how it extends ERPNext and Odoo with hardware integrations, offline mode, and an open plugin marketplace.
- [Offline Mode: Operate Without an Internet Connection](https://erpdesktop.com/docs/offline-mode.md): Stay productive through server outages. ERPDesktop caches ERP data locally, queues offline transactions, and syncs automatically when connectivity returns.
- [How to Create an ERPDesktop Plugin with Python SDK](https://erpdesktop.com/docs/plugins/create.md): Scaffold, build, and test an ERPDesktop plugin using the Python SDK — covering the plugin lifecycle, commands, and ERP API calls.
- [ERPDesktop Marketplace: Install and Manage Plugins](https://erpdesktop.com/docs/plugins/marketplace.md): Browse, install, and manage free and paid plugins from the ERPDesktop marketplace to extend your ERP with hardware and automation tools.
- [ERPDesktop Plugin System: Architecture and Overview](https://erpdesktop.com/docs/plugins/overview.md): Learn how ERPDesktop plugins work as Python sidecars with device access, ERP integrations, commands, and marketplace distribution.
- [plugin.json Manifest Reference — ERPDesktop Plugins](https://erpdesktop.com/docs/plugins/plugin-json.md): Full reference for the plugin.json manifest — required and optional fields, permission strings, config schema types, and network endpoints.
- [How to Publish Your ERPDesktop Plugin to Marketplace](https://erpdesktop.com/docs/plugins/publish.md): Package and publish your ERPDesktop plugin to the marketplace — create a publisher account, pass review, and ship updates with changelogs.
- [Thermal Printing: Receipts and Labels in ERPDesktop](https://erpdesktop.com/docs/printing.md): Configure ESC/POS, ZPL, and EPL thermal printers in ERPDesktop for receipt and label printing. Supports USB, serial, and network-connected printers.
- [Get Started with ERPDesktop: Connect in Under 5 Minutes](https://erpdesktop.com/docs/quickstart.md): Connect ERPDesktop to your ERPNext or Odoo site, explore the control panel, and install your first plugin — all in under 5 minutes.
- [device — Hardware Device Leasing in Plugins](https://erpdesktop.com/docs/sdk/device.md): Use the device module to claim exclusive access to hardware like biometric readers in your ERPDesktop plugin, preventing device conflicts between plugins.
- [erpnext_request & odoo_request — ERP API Calls](https://erpdesktop.com/docs/sdk/erp-requests.md): Use erpnext_request and odoo_request to make authenticated API calls to your connected ERPNext or Odoo site from within an ERPDesktop plugin.
- [i18n — Translations in ERPDesktop Plugins](https://erpdesktop.com/docs/sdk/i18n.md): Add multi-language support to your ERPDesktop plugin using the i18n module. Store translation strings in JSON locale files and switch languages at runtime.
- [log & event — Logging and Telemetry in Plugins](https://erpdesktop.com/docs/sdk/log.md): Emit structured log messages with the log module and send telemetry events with the event module from your ERPDesktop plugin for observability.
- [notify — Desktop Notifications from ERPDesktop Plugins](https://erpdesktop.com/docs/sdk/notify.md): Send desktop notifications from your ERPDesktop plugin using the notify module — surface sync completions, alerts, and errors to the user's desktop.
- [ERPDesktop Python SDK Reference](https://erpdesktop.com/docs/sdk/overview.md): Full reference for the ERPDesktop Python SDK. Build plugins with ERP integrations, hardware device access, persistent storage, logging, and notifications.
- [permissions — Runtime Permission Checks in Plugins](https://erpdesktop.com/docs/sdk/permissions.md): Check and enforce declared permissions at runtime in your ERPDesktop plugin using the permissions module before accessing restricted resources.
- [storage and secrets — Persistent Data in Plugins](https://erpdesktop.com/docs/sdk/storage.md): Store plugin state with the storage key-value module and protect credentials with the secrets encrypted keychain module in ERPDesktop plugins.
- [Troubleshoot ERPDesktop Connection and Device Issues](https://erpdesktop.com/docs/troubleshooting.md): Resolve the most common ERPDesktop problems — connection failures, device sync issues, backup errors, plugin crashes, and performance problems.