Get Started

Connect your app to LedgerLine accounting infrastructure.

This is the practical first-run path for developers and operators. LedgerLine gives SaaS and custom apps server-side API-key access to accounting workflows, documents, reports, and developer setup tooling. During early access, some workspace and API-key setup may require manual review. Use this page to reach setup/testing and beta readiness, not as production approval.

Public page

Product Overview

Understand LedgerLine as accounting infrastructure for connected apps.

/product

Open

Public page

Use Cases

See where LedgerLine fits for SaaS, marketplaces, service platforms, operations tools, and document-heavy apps.

/use-cases

Open

Public page

Accounting API

Review the marketing-level API overview before reading detailed developer docs.

/accounting-api

Open

Public page

Developer Docs Hub

Start from the public accounting API and docs index.

/developers

Open

Public page

Integration Guide

Read fake setup examples, API auth, webhooks, and boundaries.

/developers/integration-guide

Open

Public page

API Reference

Browse read-only endpoint examples without entering real keys.

/developers/api-console

Open

Public route

OpenAPI YAML

Use the manual OpenAPI 3.1 source for route reference.

/developers/openapi.yaml

Open

Public page

AI Install Prompt

Copy a safe prompt for AI coding tools to add server-side LedgerLine calls.

/developers/ai-install-prompt

Open

Public page

API Recipes

Browse public workflow recipes for money-in, money-out, documents, reports, settings, webhooks, errors, and test/live keys.

/developers/recipes

Open

Public page

Webhook Registry

Review active and planned event types, webhook signatures, idempotency, and retry guidance.

/developers/webhooks

Open

Public page

API Changelog

Review /api/v1 versioning, changelog, deprecation, OpenAPI, SDK, and webhook compatibility guidance.

/developers/changelog

Open

Public page

Accounting Model

Understand what creates ledger impact, what stays operational, and how reversals preserve history.

/developers/accounting-model

Open

Public page

Security / Trust

Review API-key safety, scope isolation, rate limits, storage posture, RLS/Storage boundaries, and production gates.

/developers/security

Open

First-run flow

Ten steps from model to smoke checks.

2

Step 2: Sign in or create an account

Create a LedgerLine account or sign in, then create or join an organization. Organization setup happens inside the authenticated dashboard.

3

Step 3: Create an organization and connected app

After signing in, create or open an organization, then create a connected app from the dashboard. Connected apps can use separate test and live environments.

4

Step 4: Create an API key

Create a test API key for your connected app. Raw API keys are shown once only, must stay server-side, and should never be committed or embedded in browser code. Test keys start with ll_test_; live keys start with ll_live_.

5

Step 5: Choose modules

Use connected-app module toggles to mark intended workflows such as customers, estimates, invoices, payments, documents, reports, webhooks, embedded settings, customer portal, vendors, bills/A/P, and 1099 summary. These toggles are setup guidance with soft warnings today, not billing enforcement or hard API gates. A future hard-enforcement phase may return module_disabled for disabled modules after separate rollout work.

6

Step 6: Copy setup snippets

Dashboard launch and integration pages provide placeholder-safe snippets for app-server setup. Keep real values in server-side environment variables only.

LEDGERLINE_BASE_URL=https://your-ledgerline-domain.com
LEDGERLINE_API_KEY=ll_test_replace_me
LEDGERLINE_WEBHOOK_SECRET=whsec_test_replace_me
7

Step 7: Make the first API call

Start with the read-only auth check from your app server. The API key determines the organization, connected app, and environment.

GET /api/v1/auth/check
Authorization: Bearer ll_test_replace_me
8

Step 8: Try core workflows

Once setup is healthy, start with the read-only Next.js starter, then use opt-in test-mode workflow scripts for money-in and money-out, and the fake-only webhook receiver for signature and idempotency patterns.

9

Step 9: Run smoke checks

After a local, preview, or staging app is configured and running, use the read-only smoke script. API-key checks are optional and skipped when no smoke API key is provided.

LEDGERLINE_SMOKE_BASE_URL=https://your-preview-url.example npm run smoke:check

LEDGERLINE_SMOKE_BASE_URL=https://your-preview-url.example LEDGERLINE_SMOKE_API_KEY=ll_test_replace_me npm run smoke:check
10

Step 10: Before beta or production

Before beta, configure env vars, apply migrations, create private buckets, configure the platform admin allowlist, run /api/health, run smoke checks, run RLS/Storage dry-run, and complete manual smoke/security QA. Production still requires rollout planning.

Integration Quickstart

A safe path from first auth check to accounting proof.

Work through these tracks in order. They keep real secrets server-side, separate read-only checks from opt-in test mutations, and make the accounting impact visible before any production setup claim.

1. Read-only starter

Clone or copy the server-side starter first. It proves env loading, auth check, and read-only report calls without creating records.

examples/nextjs-ledgerline-starter

  • server-only env vars
  • no browser API key
  • auth check
  • summary report read
Read integration guide

2. Money-in and money-out

Run only after configuring a non-placeholder test key and explicit opt-in. These scripts create fake test records and show the full posting path.

examples/test-mode-workflows

  • ll_test_ key required
  • explicit opt-in
  • idempotency keys
  • A/R and A/P report reads
Review recipes

3. Webhook receiver

Use the fake-only receiver to understand signature verification, fast 2xx handling, and durable idempotency requirements.

examples/webhook-receiver

  • HMAC verification
  • safe logs
  • duplicate handling
  • no LedgerLine mutation
Open webhook registry

4. Accounting trust check

Before beta, verify which calls are operational only, which calls post journals, and how reports should tie back to source records.

/developers/accounting-model

  • posting boundaries
  • reversal behavior
  • report source of truth
  • CPA review packet later
Read accounting model

Core Workflows

What to try after setup is healthy.

Money-in

  • customer
  • invoice
  • post invoice
  • payment
  • A/R report

Money-out

  • vendor
  • bill
  • post bill
  • vendor payment
  • A/P report

Documents

  • upload files
  • list evidence
  • link records
  • server downloads

Reports

  • summary
  • A/R
  • A/P
  • 1099 support

Developer

  • webhooks
  • OpenAPI
  • API recipes
  • SDK helpers

Before Beta / Production

Operator setup is still required.

  • Configure public and server-only environment variables.
  • Pin Node 20 or newer in the deployment target.
  • Apply migrations through the latest committed migration.
  • Create private buckets: cpa-exports, supporting-documents, and customer-documents.
  • Configure the platform admin allowlist if /platform will be used.
  • Create the first organization, connected app, app environment, and API key.
  • Run /api/health and read-only smoke checks.
  • Run the disposable/staging RLS and Storage dry-run.
  • Run manual smoke/security QA before production rollout planning.

Product Truth

What this path does and does not promise.

  • The API Reference is read-only and never asks for real API keys.
  • Core accounting does not require Stripe, SendGrid, Plaid, OCR/AI, IRS e-filing, or payroll providers.
  • Real email sending, Stripe Checkout/payment collection, Plaid bank feeds, OCR/AI parsing, IRS e-filing, and payroll/HR remain deferred unless implemented later.
  • This page is a setup/testing path, not production approval.
  • Production approval still requires setup, migrations, private buckets, RLS/Storage dry-run, smoke/security QA, and rollout planning.

Developer Docs

Next developer docs after setup

After the first-run path, use recipes, the accounting model, security notes, OpenAPI, and the read-only API Reference to deepen the integration.