auxi.modelling.financial.reporting module¶
This module provides classes to manage currencies.
-
class
auxi.modelling.financial.reporting.
BalanceSheet
(data_source, end=datetime.date(9999, 12, 31), output_path=None)¶ Bases:
auxi.modelling.financial.reporting.Report
Report a balance sheet of a general ledger.
Parameters: - data_source – The object to report on.
- end – The end date to generate the report for.
- output_path – The path to write the report file to.
-
class
auxi.modelling.financial.reporting.
GeneralLedgerStructure
(data_source, output_path=None)¶ Bases:
auxi.modelling.financial.reporting.Report
Report on a general ledger structure.
Parameters: - data_source – The object to report on.
- output_path – The path to write the report file to.
-
class
auxi.modelling.financial.reporting.
IncomeStatement
(data_source, start=datetime.date(1, 1, 1), end=datetime.date(9999, 12, 31), component_path='', output_path=None)¶ Bases:
auxi.modelling.financial.reporting.Report
Report an income statement of a general ledger.
Parameters: - data_source – The object to report on.
- end – The start date to generate the report for.
- end – The end date to generate the report for.
- component_path – The path of the component to filter the report’s transactions by.
- output_path – The path to write the report file to.
-
class
auxi.modelling.financial.reporting.
Report
(data_source, output_path=None)¶ Bases:
auxi.core.reporting.Report
Base class for reports.
Parameters: - data_source – The object to report on.
- output_path – The path to write the report file to.
-
class
auxi.modelling.financial.reporting.
ReportType
¶ Bases:
enum.Enum
Represents a report type, e.g. balance sheet or income statement.
-
balance_sheet
= (1,)¶
-
cash_flow
= 4¶
-
income_statement
= (2,)¶
-
transaction_list
= (3,)¶
-
-
class
auxi.modelling.financial.reporting.
TransactionList
(data_source, start=datetime.date(1, 1, 1), end=datetime.date(9999, 12, 31), component_path='', output_path=None)¶ Bases:
auxi.modelling.financial.reporting.Report
Report on a list of transactions.
Parameters: - data_source – The object to report on.
- end – The start date to generate the report for.
- end – The end date to generate the report for.
- component_path – The path of the component to filter the report’s transactions by.
- output_path – The path to write the report file to.