From 66d5bb2fd3717e85023d75a4cc71dcbef6440089 Mon Sep 17 00:00:00 2001 From: RunasSudo Date: Sat, 4 Apr 2020 20:11:25 +1100 Subject: [PATCH] Update documentation --- README.md | 8 ++++++++ demo/config.yml | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bce913b..b6ca19c 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,11 @@ Additionally, ledger-pyreport expects the next level of assets and liabilities t Ledger-pyreport by default observes the convention that positive amounts in Ledger represent debits, and negative amounts in Ledger represent credits. A commodity which has *any* price data in Ledger (including those specified through `@` or `@@`, or explicitly through `P`) will be regarded as a commodity measured at fair market value, and automatically revalued accordingly. A commodity which has *no* price data in Ledger (i.e. lot prices through `{…}` or `{{…}}` only) will be regarded as a commodity measured at historical cost, and will not be subsequently revalued. + +## Caution on standards compliance + +ledger-pyreport is developed with reference to the [AASB Australian Accounting Standards](https://www.aasb.gov.au/Pronouncements/Current-standards.aspx) and [IFRS International Financial Reporting Standards](https://www.ifrs.org/issued-standards/list-of-standards/), and we prefer compliance with those standards whenever practical. (We do not specifically consider United States FASB GAAP compliance.) + +However, strict compliance with AASB/IFRS is not always practical, and ledger-pyreport departs from AASB/IFRS in a number of material ways – for example, the statement of cash flows generated by ledger-pyreport does not show the detailed subclassifications required by AASB/IFRS, nor does ledger-pyreport produce a statement of changes in equity. In both cases, the background information required to produce the reports accurately is beyond the scope of ledger-pyreport. + +Other aspects of AASB/IFRS requirements are the user's responsibility – for example, the selection of an appropriate chart of accounts and appropriate recognition of transactions in those accounts. diff --git a/demo/config.yml b/demo/config.yml index 16eae18..53ad1ca 100644 --- a/demo/config.yml +++ b/demo/config.yml @@ -15,9 +15,9 @@ oci_account: OCI # Other Comprehensive Income unrealized_gains: 'OCI:Unrealized Gains' accumulated_oci: 'Equity:Accumulated Other Comprehensive Income' -current_year_oci: 'Equity:Current Year Other Comprehensive Income' +current_year_oci: 'Equity:Accumulated Other Comprehensive Income:Current Year Other Comprehensive Income' retained_earnings: 'Equity:Retained Earnings' -current_year_earnings: 'Equity:Current Year Earnings' +current_year_earnings: 'Equity:Retained Earnings:Current Year Earnings' # Which asset accounts to consider in cash basis mode cash_asset_accounts: ['Assets:Current:Cash on Hand', 'Assets:Current:Cash at Bank', 'Assets:Current:International Account']