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)

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)

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)

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)

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

Represents a report type, e.g. balance sheet or income statement.

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)

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.

ReportType enum

class auxi.modelling.financial.reporting.ReportType

Represents a report type, e.g. balance sheet or income statement.

balance_sheet = <ReportType.balance_sheet: (1,)>

cash_flow = <ReportType.cash_flow: 4>

income_statement = <ReportType.income_statement: (2,)>

transaction_list = <ReportType.transaction_list: (3,)>

Report class

class auxi.modelling.financial.reporting.Report(data_source, output_path=None)

Base class for reports.

Parameters:

• data_source – The object to report on.
• output_path – The path to write the report file to.

read(path)

render(format=<ReportFormat.printout: (1, )>)

Render the report in the specified format

Parameters:format – The format. The default format is to print the report to the console. Returns:If the format was set to ‘string’ then a string representation of the report is returned.

write(path)

GeneralLedgerStructure class

class auxi.modelling.financial.reporting.GeneralLedgerStructure(data_source, output_path=None)

Report on a general ledger structure.

Parameters:

• data_source – The object to report on.
• output_path – The path to write the report file to.

read(path)

render(format=<ReportFormat.printout: (1, )>)

Render the report in the specified format

Parameters:format – The format. The default format is to print the report to the console. Returns:If the format was set to ‘string’ then a string representation of the report is returned.

write(path)

TransactionList class

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)

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.

read(path)

render(format=<ReportFormat.printout: (1, )>)

Render the report in the specified format

Parameters:format – The format. The default format is to print the report to the console. Returns:If the format was set to ‘string’ then a string representation of the report is returned.

write(path)

BalanceSheet class

class auxi.modelling.financial.reporting.BalanceSheet(data_source, end=datetime.date(9999, 12, 31), output_path=None)

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.

read(path)

render(format=<ReportFormat.printout: (1, )>)

Render the report in the specified format

Parameters:format – The format. The default format is to print the report to the console. Returns:If the format was set to ‘string’ then a string representation of the report is returned.

write(path)

IncomeStatement class

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)

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.

read(path)

render(format=<ReportFormat.printout: (1, )>)

Render the report in the specified format

Parameters:format – The format. The default format is to print the report to the console. Returns:If the format was set to ‘string’ then a string representation of the report is returned.

write(path)