Package: ixbrl-reporter
ixbrl-reporterSummaryThis is a command-line utility which creates iXBRL-tagged financial reports
from configuration templates and account data.  It currently supports account
information from GnuCash files, and also a CSV file of transactions.DiscussThere's a #ixbrl-reporter channel on our Discord server if you want
to discuss...https://discord.gg/3cAvPASS6pNoteThe configuration files used by ixbrl-reporter are complex.  Seeixbrl-reporter-jsonnetfor an easier way to manage the configuration files.SummaryThis code is intended for use withixbrl-reporter.Usingixbrl-reporterrequires a complex configuration file, or set of
configuration files.  An internal import/reference mechanism was introduced
to allow the configuration files to be modulariesd, but the mechanism is
still not ideal.This repo implements JSONNET templates for construction of configuration
files forixbrl-reporterwhich makes the matter more manageable.Jsonnet (see jsonnet.org) is a programming language (invented by Google)
which extends JSON with programming constructs.  Jsonnet is specifically
designed to make it easy to build configuration files; it supports object
templating and extension.iXBRLThe iXBRL format is commonly used to describe regulatory account information
which companies must publish.  Different schemas are in use in different
places in the world.  The example account and report data included in this
project uses schemas which are used in the UK reporting regime, and there
is also a minimalistic ESEF example, but it is possible to define other
taxonomies.iXBRL stands for "Inline XBRL".  It was built on the XBRL standard
(eXtensible Business Reporting Language).  iXBRL is HTML with embedded XBRL
tags so that the document can be viewed in an HTML browser and read by
a human, but the tags are also machine-readable.  This allows the same
accounts to be usable by a human, and also by automated data extraction tools.ExamplesIncluded in this repo are example accounts and configuration files exist
which output:Company accounts for UK Companies House filing using the FRS-102 taxonomy.UK HMRC corporation tax filing using the CT600 schema and Detailed Profit
and Loss schema in a single document.ESEF filing configuration for an English-language filing as well as
French.Configuration files can be written for other taxonomies.Other outputsPlain-text report output is supported (semi-useful), as is plain-text
HTML output created by stripping the iXBRL tags.MotivationiXBRL report generation is presently convoluted.  Generally people generate
financial reports, or use an accountant to create the reports, and then
send the report files away for a human to semi-automatically tag using an
iXBRL tagging tool, which takes some number of days and costs at least €150.This tool demonstrates auto-generating reports with the right tags in the
first place.The overheads in configuring reports and iXBRL output withixbrl-reporteris not small, but that's an up-front cost, once set-up, up-to-date reports
can be generated.WarrantyThis code comes with no warranty whatsoever.  See theLICENSEfile
for details.  Further, I am not an accountant.  Even if I were, I would not be
YOUR accountant.  It is possible that this code could be useful to you in
meeting regulatory reporting requirements for your business.  It is also
possible that the software could report misleading information which could
land you in a lot of trouble if used for regulatory purposes.  Really, you
should check with a qualified accountant.Configuration overviewixbrl-reporterconfiguration is complex: If the configuration files
supplied work for your business you could get accounts with little work.However, it is very likely that you'll need to tailor the reports to work
with your business.  The information flows are described
inInformation flows.InstallingThere is a dependency on one of thegnucash,piecashorcsvPython
modules:ThegnucashPython support is built from the GnuCash source code tree
itself.  It is currently only distributed with Linux packages.  You cannot
use this on Windows or MacOS.  Seehttps://wiki.gnucash.org/wiki/Python_Bindingsfor installation, but on
Linux it is generally installed when you install the gnucash package.
It is not possible to install thegnucashmodule using PyPI.ThepiecashPython support can be download usingpipor your favourite
Python package manager.  It works on Linux, MacOS and Windows.  However,
it only supports the Sqlite or Postgres GnuCash formats, and not the
XML format which is the default.ThecsvPython module is bundled with Python.It is possible to convert a GnuCash file to Sqlite format by using
GnuCash, select Save As... and selecting Sqlite.pip3 install git+https://github.com/cybermaggedon/ixbrl-reporterUsageixbrl-reporter <config> <report> <format>Where:configspecifies a configuration file.  SeeConfiguration File.reportspecifies a report tag.formatspecifies output format.textoutputs plain text,ixbrloutputs iXBRL (XHTML tagged with XBRL tags) andhtmloutputs HTML, which
is iXBRL with the XBRL tags removed.The examples use files in the git repo.  Clone the git repo to run this
stuff:git clone https://github.com/cybermaggedon/ixbrl-reporterExample, Companies House accounts. You should be able to view the resultant
HTML in a browser:ixbrl-reporter config.yaml report ixbrl > accts.htmlCorporation tax filing:ixbrl-reporter config-corptax.yaml report ixbrl > ct.htmlESMA ESEF filing:ixbrl-reporter config-esef.yaml report ixbrl > esef.htmlCheck out the awesome Graffiti tool for viewing iXBRL tags in a document.
The basic version is free.  It's just a bookmark in your browser!  Once
your iXBRL document is loaded in the browser, invoke the bookmark and
iXBRL tag navigation is seamlessly added to the document you are looking at.https://stechanalytics.com/#GraffitiConfigurationAll the configuration is in YAML, and there are various configuration
files which are linked together.  If the templates work for you, you should
only have to changeconfig.yamlandmetadata.yaml.config.yamlis the top-level configuration file which imports the
other configuration files.  Of interest, is theaccountssection which
specifies which GnuCash file to use.  There is also areportsetting
which describes which report definition to import.  Also apretty-printsetting which causes HTML to be output with indented spacing to make it
easier to read if you have to debug something.metadata.yamlcontains information specific to the business the report
is about, such as name of business, address, company identifiers and so
on.  You would edit this to describe your business.Taxonomy definitions under thetaxonomydirectory specify the mapping
between identifiers and the iXBRL tagging.  If the report templates do
what you need, you won't need to change this.Report configuration files under thereportdirectory.  Think of these
as report templates. They define the structure of information going into
the report.  There is achsub-directory containing various kinds of
Companies House filing templates.  Also anhmrcsub-directory containing
the HMRC corporation tax filing template.  If these report configurations do
what you want, you don't need to change them.directors-report.yaml,accountants-report.yaml,auditors-report.yaml,notes.yamlare used to provide specific sections of the company accounts.
These are only needed for more complex reports, for a micro-entity account
filing, these are not used.All configuration files are YAML.SeeConfiguration File.Screenshots of outputScreenshotsOther things to tryHaving created iXBRL, you can try loading intoArellewhich is an iXBRL development tool.
In Arelle, you can invoke a validation and check the output matches the
schema.Once Arelle is installed, you can install the Workivaixbrl-viewer.  When an iXBRL
document is loaded into Arelle, the document is automatically loaded into
a browser with markup so that you can navigate the tags and discover tagged
information.  With the iXBRL viewer when you hover over tagged information,
it is highlighted, clicking opens up the metadata viewer.Test suite / examplesSee thetestdirectory.sh test/run_allOutput inoutput.LicenseCopyright (c) Accounts Machine Limited, 2020-2022
Licenced under the GPL version 3 licence, see theLICENSEfile