DrCr/docs/docs.md

5.8 KiB

Contents

1. Introduction

DrCr (‘debit-credit’) is a self-contained open-source double-entry bookkeeping framework.

Conceptually, DrCr exists in a middle ground between lightweight ledger-keeping tools (e.g. ledger, hledger, beancount) and heavyweight accounting packages (e.g. Xero, MYOB). Compared to the ledger-likes:

  • DrCr is GUI driven, but data is stored in easily computer-readable format (SQL database)
  • DrCr embraces accounting conventions (debits/credits, account types) – DrCr is not suitable for managing arbitrary non-financial double-entry-like data
  • Applying accounting conventions to generate standard financial reports is core functionality in DrCr
  • DrCr also preserves the conventional accounting relationship between source documents and ledger transactions – while the ledger is the core structure consolidating accounting information, ledger transactions can be generated programatically from source data of different forms

Compared to heavyweight accounting packages:

  • DrCr's core function is to manage the double-entry ledger – management of other information is non-core, keeping functionality lightweight
    • For example, there is no invoicing functionality in DrCr – it is the user's responsibility to post appropriate transactions to the receivables ledger accounts
  • DrCr provides tools with sharp edges – it is assumed the user is familiar with double-entry bookkeeping
  • DrCr is tailored towards small-scale individual use for personal finance (but use for business accounting is entirely possible)

2. Quick start

If a binary build has been provided, simply double click the DrCr application. Otherwise, follow the build instructions in the README.

The welcome screen is displayed – ‘Welcome to DrCr. No file is currently open.’ The first step is to create a new DrCr file. Click New file. Click OK to accept the default settings. A file chooser dialog is displayed – choose where to save the new DrCr file.

The main menu is now displayed. Click Trial balance. The trial balance report is generated, showing there are no accounts, and the total debits and credits are accordingly both zero. To navigate back to the main menu:

  • Click DrCr in the top left at the menu bar, or
  • Right-click anywhere and select Back from the context menu, or
  • If the window is sufficiently wide, click the back icon to the left of DrCr at the menu bar

We will now enter a new transaction. From the main menu, click JournalNew transaction. The transaction editor is displayed. Enter:

DateDescriptionDrCr
Today's dateOpening balance
DrCash at Hand$100
CrOpening Balances$100

Click Save. The journal page has updated to show the new transaction.

From the main menu, click Trial balance. The trial balance now correctly shows a $100 debit balance in the Cash at Hand account, and a $100 credit balance in the Opening Balances account.

If we click Balance sheet from the main menu, the report will show zero balances for assets, liabilities and equity. This is because we have not configured Cash at Hand as an asset or Opening Balances as equity. We will do so now.

From the main menu, click Chart of accounts. The dropdown box at the top of the page is pre-populated with Asset. Select the checkbox next to Cash at Hand, and click Add type. The table updates to show that Cash at Hand is now configured as an asset account. Select the checkbox next to Opening Balances. Change the dropdown box from Asset to Equity, and click Add type. The table now shows:

  Account Associated types
Cash at Hand • Asset
Opening Balances • Equity

Return to the Balance sheet report. The report is now correct:

  $
Assets
Cash at Hand 100.00
Total assets 100.00
 
Liabilities
Total liabilities 0.00
 
Equity
Opening Balances 100.00
Total equity 100.00

Now add another transaction from the journal page:

DateDescriptionDrCr
Today's dateCash sales for the day
DrCash at Hand$10
CrSales$10

If we now click Balance sheet from the main menu, a warning is displayed ‘Total assets do not equal total liabilities and equity.’ As the warning goes on to note, this is because the Sales account has not been configured.

Configure the Sales account as an income account in the chart of accounts.

Now, from the main menu, click Income statement. The income statement report is displayed:

  $
Income
Sales 10.00
Total income 10.00
 
Expenses
Total expenses 10.00
 
Net surplus (deficit) 10.00

From the main menu, click Balance sheet. The current year surplus is automatically displayed under equity:

  $
Assets
Cash at Hand 110.00
Total assets 110.00
 
Liabilities
Total liabilities 0.00
 
Equity
Current Year Earnings 10.00
Opening Balances 100.00
Total equity 110.00

We can add additional transactions and configure additional accounts in like manner. Note that, whenever possible, it is preferred to generate transactions via the statements feature, rather than create manual journal entries.