SQL-Ledger Documentation

Table of Contents

• Introduction

  • Quick Start
  • Feature List

• Installation

  • GitHub Repository
  • Requirements
  • Ansible Role
  • Manual Installation
  • Virtualization

• Upgrade

  • Change to Git Version Control
  • Upgrade within Version 4
    • Upgrade from Version 4.n.x to 4.n.y
    • Upgrade from Version 4.x to 4.y
  • Upgrade from Version 3 to Version 4
  • Downgrade from Version 4 to Version 3

• Configuration

  • Storage Location
  • Global Configuration
  • Database Configuration
  • User Configuration
  • Passwords
  • Localized Postal Addresses
    • Prerequisites
    • Customer and Vendor Screens
    • Templates
    • Missing Localizations

• Customization

  • Structure
  • Menu
  • Program code
    • Customized Reports

• Backup

  • Backup Formats
  • Encrypted Backups
  • Restore

• User Interface

  • Color Themes
  • Helping Notes
  • Keyboard Shortcuts
    • Access Keys
    • Quick Date Entry

• LaTeX Templates

  • Simple Markdown
  • Variables for Localized Addresses
  • Variables for Swiss QR Bill
  • Directive to Generate QR Codes

• Translations

  • File Structure
  • Updating and Creating Translations

• API

  • JSON and HTML API
  • Prerequisites
  • Authentication
    • Access token (recommended)
    • Login with every request (alternative)
  • JSON API
    • List Accounts
    • Search Customers
    • Customer Details
    • Search Order
    • Search Transaction
    • Invoice Details
    • Add Payment
    • Add Reference
  • HTML API
    • Preparation
    • Add an invoice

• Development

  • Perldoc
  • Testing
  • Contributing