Developer Docs

Build LedgerLine from your server-side code.

Use the quickstart, authentication guide, API reference, recipes, webhooks, accounting model, security notes, changelog, and OpenAPI YAML to integrate customers, invoices, payments, bills, documents, reports, and events.

Start here

Quickstart

Follow the first-run path from account setup to server-side env placeholders, auth check, test workflows, and smoke checks.

Open docs

Server-side rules

Authentication

Keep API keys on your server, understand test/live boundaries, reject trusted scope fields, and make the first calls.

Open docs

Route detail

API Reference

Browse read-only endpoint groups, fake request examples, response examples, SDK snippets, and accounting impact notes.

Open docs

Workflow detail

Recipes

Pick money-in, money-out, documents, reports, webhooks, test/live, and error-handling implementation patterns.

Open docs

Events

Webhooks

Review inbound events, outbound webhook payloads, signature headers, idempotency, and active versus planned event behavior.

Open docs

Accounting truth

Accounting Model

Understand what posts to the ledger, what stays operational, how reversals work, and how reports read posted state.

Open docs

Trust

Security

Review API-key safety, scope isolation, rate limits, private document posture, no-secret rules, and production gates.

Open docs

Compatibility

Changelog

Read the /api/v1 compatibility, deprecation, OpenAPI, SDK, webhook, and breaking-change policy.

Open docs

Spec

OpenAPI YAML

Open the manual OpenAPI 3.1 YAML for route-level reference and tooling import.

Open spec

Suggested Order

A clean path from first read to first integration.

  1. 1Read the Quickstart to understand the setup/testing path.
  2. 2Use Authentication to wire server-side env vars and keys.
  3. 3Open API Reference for endpoint shapes and examples.
  4. 4Choose Recipes for the workflow your app needs.
  5. 5Review Accounting Model before posting or reversing records.
  6. 6Review Security before preview, beta, or production setup.

Developer Boundaries

The docs are technical, but still safe by default.

  • API keys are server-side credentials and must not be placed in browser code.
  • The API Reference is read-only; it does not send live requests or ask for keys.
  • Build with AI is the guided planning lane; Developer Docs is the exact technical lane.
  • OpenAPI YAML remains available at /developers/openapi.yaml.
  • Production rollout still requires setup, smoke checks, security review, and operator approval.