| # Copyright (c) 2020, Frappe Technologies Pvt. Ltd. and Contributors |
| # License: GNU General Public License v3. See license.txt |
| |
| import frappe |
| import json |
| from frappe.utils import nowdate, add_months, get_date_str |
| from frappe import _ |
| from erpnext.accounts.utils import get_fiscal_year, get_account_name, FiscalYearError |
| |
| def _get_fiscal_year(date=None): |
| try: |
| fiscal_year = get_fiscal_year(date=nowdate(), as_dict=True) |
| return fiscal_year |
| |
| except FiscalYearError: |
| #if no fiscal year for current date then get default fiscal year |
| try: |
| fiscal_year = get_fiscal_year(as_dict=True) |
| return fiscal_year |
| |
| except FiscalYearError: |
| #if still no fiscal year found then no accounting data created, return |
| return None |
| |
| def get_company_for_dashboards(): |
| company = frappe.defaults.get_defaults().company |
| if company: |
| return company |
| else: |
| company_list = frappe.get_list("Company") |
| if company_list: |
| return company_list[0].name |
| return None |
| |
| def get_data(): |
| |
| fiscal_year = _get_fiscal_year(nowdate()) |
| |
| if not fiscal_year: |
| return frappe._dict() |
| |
| return frappe._dict({ |
| "dashboards": get_dashboards(), |
| "charts": get_charts(fiscal_year), |
| "number_cards": get_number_cards(fiscal_year) |
| }) |
| |
| def get_dashboards(): |
| return [{ |
| "name": "Accounts", |
| "dashboard_name": "Accounts", |
| "doctype": "Dashboard", |
| "charts": [ |
| { "chart": "Profit and Loss" , "width": "Full"}, |
| { "chart": "Incoming Bills (Purchase Invoice)", "width": "Half"}, |
| { "chart": "Outgoing Bills (Sales Invoice)", "width": "Half"}, |
| { "chart": "Accounts Receivable Ageing", "width": "Half"}, |
| { "chart": "Accounts Payable Ageing", "width": "Half"}, |
| { "chart": "Budget Variance", "width": "Full"}, |
| { "chart": "Bank Balance", "width": "Full"} |
| ], |
| "cards": [ |
| {"card": "Total Outgoing Bills"}, |
| {"card": "Total Incoming Bills"}, |
| {"card": "Total Incoming Payment"}, |
| {"card": "Total Outgoing Payment"} |
| ] |
| }] |
| |
| def get_charts(fiscal_year): |
| company = frappe.get_doc("Company", get_company_for_dashboards()) |
| bank_account = company.default_bank_account or get_account_name("Bank", company=company.name) |
| default_cost_center = company.cost_center |
| |
| return [ |
| { |
| "doctype": "Dashboard Charts", |
| "name": "Profit and Loss", |
| "owner": "Administrator", |
| "report_name": "Profit and Loss Statement", |
| "filters_json": json.dumps({ |
| "company": company.name, |
| "filter_based_on": "Fiscal Year", |
| "from_fiscal_year": fiscal_year.get('name'), |
| "to_fiscal_year": fiscal_year.get('name'), |
| "periodicity": "Monthly", |
| "include_default_book_entries": 1 |
| }), |
| "type": "Bar", |
| 'timeseries': 0, |
| "chart_type": "Report", |
| "chart_name": _("Profit and Loss"), |
| "is_custom": 1, |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Chart", |
| "time_interval": "Monthly", |
| "name": "Incoming Bills (Purchase Invoice)", |
| "chart_name": _("Incoming Bills (Purchase Invoice)"), |
| "timespan": "Last Year", |
| "color": "#a83333", |
| "value_based_on": "base_net_total", |
| "filters_json": json.dumps([["Purchase Invoice", "docstatus", "=", 1]]), |
| "chart_type": "Sum", |
| "timeseries": 1, |
| "based_on": "posting_date", |
| "owner": "Administrator", |
| "document_type": "Purchase Invoice", |
| "type": "Bar", |
| "width": "Half", |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Chart", |
| "name": "Outgoing Bills (Sales Invoice)", |
| "time_interval": "Monthly", |
| "chart_name": _("Outgoing Bills (Sales Invoice)"), |
| "timespan": "Last Year", |
| "color": "#7b933d", |
| "value_based_on": "base_net_total", |
| "filters_json": json.dumps([["Sales Invoice", "docstatus", "=", 1]]), |
| "chart_type": "Sum", |
| "timeseries": 1, |
| "based_on": "posting_date", |
| "owner": "Administrator", |
| "document_type": "Sales Invoice", |
| "type": "Bar", |
| "width": "Half", |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Charts", |
| "name": "Accounts Receivable Ageing", |
| "owner": "Administrator", |
| "report_name": "Accounts Receivable", |
| "filters_json": json.dumps({ |
| "company": company.name, |
| "report_date": nowdate(), |
| "ageing_based_on": "Due Date", |
| "range1": 30, |
| "range2": 60, |
| "range3": 90, |
| "range4": 120 |
| }), |
| "type": "Donut", |
| 'timeseries': 0, |
| "chart_type": "Report", |
| "chart_name": _("Accounts Receivable Ageing"), |
| "is_custom": 1, |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Charts", |
| "name": "Accounts Payable Ageing", |
| "owner": "Administrator", |
| "report_name": "Accounts Payable", |
| "filters_json": json.dumps({ |
| "company": company.name, |
| "report_date": nowdate(), |
| "ageing_based_on": "Due Date", |
| "range1": 30, |
| "range2": 60, |
| "range3": 90, |
| "range4": 120 |
| }), |
| "type": "Donut", |
| 'timeseries': 0, |
| "chart_type": "Report", |
| "chart_name": _("Accounts Payable Ageing"), |
| "is_custom": 1, |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Charts", |
| "name": "Budget Variance", |
| "owner": "Administrator", |
| "report_name": "Budget Variance Report", |
| "filters_json": json.dumps({ |
| "company": company.name, |
| "from_fiscal_year": fiscal_year.get('name'), |
| "to_fiscal_year": fiscal_year.get('name'), |
| "period": "Monthly", |
| "budget_against": "Cost Center" |
| }), |
| "type": "Bar", |
| "timeseries": 0, |
| "chart_type": "Report", |
| "chart_name": _("Budget Variance"), |
| "is_custom": 1, |
| "is_public": 1 |
| }, |
| { |
| "doctype": "Dashboard Charts", |
| "name": "Bank Balance", |
| "time_interval": "Quarterly", |
| "chart_name": "Bank Balance", |
| "timespan": "Last Year", |
| "filters_json": json.dumps({ |
| "company": company.name, |
| "account": bank_account |
| }), |
| "source": "Account Balance Timeline", |
| "chart_type": "Custom", |
| "timeseries": 1, |
| "owner": "Administrator", |
| "type": "Line", |
| "width": "Half", |
| "is_public": 1 |
| }, |
| ] |
| |
| def get_number_cards(fiscal_year): |
| |
| year_start_date = get_date_str(fiscal_year.get("year_start_date")) |
| year_end_date = get_date_str(fiscal_year.get("year_end_date")) |
| return [ |
| { |
| "doctype": "Number Card", |
| "document_type": "Payment Entry", |
| "name": "Total Incoming Payment", |
| "filters_json": json.dumps([ |
| ['Payment Entry', 'docstatus', '=', 1], |
| ['Payment Entry', 'posting_date', 'between', [year_start_date, year_end_date]], |
| ['Payment Entry', 'payment_type', '=', 'Receive'] |
| ]), |
| "label": _("Total Incoming Payment"), |
| "function": "Sum", |
| "aggregate_function_based_on": "base_received_amount", |
| "is_public": 1, |
| "is_custom": 1, |
| "show_percentage_stats": 1, |
| "stats_time_interval": "Monthly" |
| }, |
| { |
| "doctype": "Number Card", |
| "document_type": "Payment Entry", |
| "name": "Total Outgoing Payment", |
| "filters_json": json.dumps([ |
| ['Payment Entry', 'docstatus', '=', 1], |
| ['Payment Entry', 'posting_date', 'between', [year_start_date, year_end_date]], |
| ['Payment Entry', 'payment_type', '=', 'Pay'] |
| ]), |
| "label": _("Total Outgoing Payment"), |
| "function": "Sum", |
| "aggregate_function_based_on": "base_paid_amount", |
| "is_public": 1, |
| "is_custom": 1, |
| "show_percentage_stats": 1, |
| "stats_time_interval": "Monthly" |
| }, |
| { |
| "doctype": "Number Card", |
| "document_type": "Sales Invoice", |
| "name": "Total Outgoing Bills", |
| "filters_json": json.dumps([ |
| ['Sales Invoice', 'docstatus', '=', 1], |
| ['Sales Invoice', 'posting_date', 'between', [year_start_date, year_end_date]] |
| ]), |
| "label": _("Total Outgoing Bills"), |
| "function": "Sum", |
| "aggregate_function_based_on": "base_net_total", |
| "is_public": 1, |
| "is_custom": 1, |
| "show_percentage_stats": 1, |
| "stats_time_interval": "Monthly" |
| }, |
| { |
| "doctype": "Number Card", |
| "document_type": "Purchase Invoice", |
| "name": "Total Incoming Bills", |
| "filters_json": json.dumps([ |
| ['Purchase Invoice', 'docstatus', '=', 1], |
| ['Purchase Invoice', 'posting_date', 'between', [year_start_date, year_end_date]] |
| ]), |
| "label": _("Total Incoming Bills"), |
| "function": "Sum", |
| "aggregate_function_based_on": "base_net_total", |
| "is_public": 1, |
| "is_custom": 1, |
| "show_percentage_stats": 1, |
| "stats_time_interval": "Monthly" |
| } |
| ] |