solarOSsolarOS Docs

solarOS documentation

How to set up solarOS and do the day-to-day work in each part of the app, plus the API for developers.

These docs cover setting up your organization, day-to-day tasks across solarOS, and the API for building integrations.

  • Get started: set up your organization, team, and first job, in order.
  • Guides by area:
    • Sales: leads, customers, opportunities, quotes, and agreements.
    • Operations: projects, service work, scheduling and dispatch, and the Technician app. For example, Schedule a service visit.
    • Monitoring: sites, alerts, and maintenance plan subscriptions.
    • Accounting: invoices, payments, financing, and reports.
    • Settings: quote setup, project setup, team setup, and monitoring setup.
    • Integrations: Stripe, QuickBooks, Slack, Zapier, API keys, and webhooks. For example, Connect Slack.
  • API reference: authenticate and call the solarOS API, with every endpoint, field, and error code.
  • Reference: glossary, status values, permissions, webhook events, error codes, and limits.
  • Troubleshooting: common problems and error messages, and what to do about them.
Was this page helpful?