report

func (*FinanceReportService) CalculatePurchaseByTimeRange ¶

func (s *FinanceReportService) CalculatePurchaseByTimeRange(
	companyID string,
	documentType string,
	timeRange string,
) (float64, error)

CalculatePurchaseByTimeRange calculates the total purchase by time range.

The time range can be Q1, Q2, Q3, Q4, THIS_MONTH, THIS_WEEK, THIS_YEAR.

The document type can be BILL, PURCHASE_ORDER, PROCUREMENT.

func (*FinanceReportService) CalculateSalesByTimeRange ¶

func (s *FinanceReportService) CalculateSalesByTimeRange(
	companyID string,
	documentType string,
	timeRange string,
) (float64, error)

CalculateSalesByTimeRange calculates the total sales for the given company ID and document type (e.g. INVOICE, SALES_ORDER, etc.) within the given time range.

The time range can be one of the following:

• Q1: first quarter of the current year
• Q2: second quarter of the current year
• Q3: third quarter of the current year
• Q4: fourth quarter of the current year
• THIS_MONTH: the current month
• THIS_WEEK: the current week
• THIS_YEAR: the current year

The method returns the total sales amount as a float64 and an error, if any.

func (*FinanceReportService) CreateClosingBook ¶

func (s *FinanceReportService) CreateClosingBook(closingBook *models.ClosingBook) error

CreateClosingBook creates a new closing book record in the database.

The function takes a pointer to a models.ClosingBook struct as an argument. The function returns an error if the record cannot be created.

func (*FinanceReportService) DeleteClosingBook ¶

func (s *FinanceReportService) DeleteClosingBook(closingBookID string) error

DeleteClosingBook deletes a closing book record from the database and its associated transactions.

The function takes the ID of the closing book as an argument and returns an error if the deletion operation fails. The function first deletes all associated transactions by setting the deleted_at field on the transactions to the current time. Then, it deletes the closing book record from the database.

func (*FinanceReportService) GenerateAccountReport ¶

func (s *FinanceReportService) GenerateAccountReport(accountID string, companyID *string, request http.Request) (*models.AccountReport, error)

func (*FinanceReportService) GenerateBalanceSheet ¶

func (s *FinanceReportService) GenerateBalanceSheet(report models.GeneralReport) (*models.BalanceSheet, error)

GenerateBalanceSheet creates a balance sheet report for a specified company within a given date range. It calculates and summarizes the company's assets, liabilities, and equity, including fixed assets, current assets, liabilities, and equity accounts. The function also incorporates inventory data and profit and loss information to provide a comprehensive view of the financial position. It returns a populated BalanceSheet struct and any error encountered during the process.

func (*FinanceReportService) GenerateCapitalChangeReport ¶

func (s *FinanceReportService) GenerateCapitalChangeReport(report models.GeneralReport) (*models.CapitalChangeReport, error)

GenerateCapitalChangeReport generates a capital change report, which is a financial statement that shows the changes in a company's capital accounts over a particular period of time.

The report includes the following components: - Opening Balance: the capital account balance as of the beginning of the period. - Profit/Loss: the net profit or loss of the company during the period. - Prived Balance: the changes in capital accounts that are not related to profit/loss, such as capital injections or withdrawals. - Capital Change Balance: the total changes in capital accounts during the period. - Ending Balance: the capital account balance as of the end of the period.

The report is generated by querying the database for transactions that affect the capital accounts and summarizing the results.

func (*FinanceReportService) GenerateCashFlowReport ¶

func (s *FinanceReportService) GenerateCashFlowReport(cashFlow models.CashFlowReport) (*models.CashFlowReport, error)

GenerateCashFlowReport generates a cash flow report based on the given company ID and date range. It will calculate the total of each cash flow category and return the result as a models.CashFlowReport. The result will contain the total of each category and the total of all categories.

func (*FinanceReportService) GenerateClosingBook ¶

func (s *FinanceReportService) GenerateClosingBook(
	closingBook *models.ClosingBook,
	cashflowGroupSetting *models.CashflowGroupSetting,
	userID string,
	description string,
	retainingID string,
	profitSumID string,
	taxPayableID *string,
	taxExpenseID *string,
	taxPercentage float64,
) error

GenerateClosingBook generates a closing book report.

The function takes a closing book record and its associated settings as arguments. It generates a closing book report based on the settings. The report is stored in the closing book record.

The function creates transactions to close the profit and loss account. It creates transactions to close the retained earnings account. It generates a cash flow report and stores it in the closing book record. It generates a balance sheet report and stores it in the closing book record. It generates a trial balance report and stores it in the closing book record. It generates a capital change report and stores it in the closing book record.

The function returns an error if the operation fails.

func (*FinanceReportService) GenerateCogsReport ¶

func (s *FinanceReportService) GenerateCogsReport(report models.GeneralReport) (*models.COGSReport, error)

GenerateCogsReport generates a Cost of Goods Sold (COGS) report for the given company and date range.

The report includes the following data: - Beginning Inventory: the opening balance of the inventory account - Purchases: the total of all purchase transactions - Freight In and Other Cost: the total of all freight-in and other costs - Total Purchases: the total of purchases and freight-in and other costs - Purchase Returns: the total of all purchase return transactions - Purchase Discounts: the total of all purchase discount transactions - Total Purchase Discounts: the total of purchase returns and purchase discounts - Net Purchases: the total purchases minus total purchase discounts - Goods Available: the beginning inventory plus net purchases - Ending Inventory: the closing balance of the inventory account - COGS: the Cost of Goods Sold, which is the goods available minus ending inventory - Inventory Account: the inventory account used in the report - Stock Opname: the difference between the beginning inventory and ending inventory, which is the stock opname amount

func (*FinanceReportService) GenerateProfitLoss ¶

func (s *FinanceReportService) GenerateProfitLoss(report *models.ProfitLoss) error

GenerateProfitLoss generates a profit loss report for a given period.

The function takes a `models.ProfitLoss` struct as an argument, which contains the start and end date of the period for which the report should be generated.

The function returns an error if the report cannot be generated.

func (*FinanceReportService) GenerateProfitLossReport ¶

func (s *FinanceReportService) GenerateProfitLossReport(report models.GeneralReport) (*models.ProfitLossReport, error)

GenerateProfitLossReport generates a profit and loss report for a given company within a specified date range. It calculates the revenue, cost of goods sold (COGS), gross profit, expenses, and net profit. The function returns a populated ProfitLossReport and any error encountered during the process.

func (*FinanceReportService) GetAccountBalance ¶

func (s *FinanceReportService) GetAccountBalance(accountID string, companyID *string, startDate *time.Time, endDate *time.Time) (float64, float64, error)

GetAccountBalance retrieves the total debit and credit amounts for a given account, for a given period of time. The period of time is specified by the start and end date parameters. If the start date is not provided, it will default to the beginning of time. If the end date is not provided, it will default to the present time. The company ID is also an optional parameter, and if it is not provided, the function will return the total debit and credit amounts for all companies.

func (*FinanceReportService) GetAccountPayableLedger ¶

func (s *FinanceReportService) GetAccountPayableLedger(companyID string, contactID string, startDate, endDate time.Time) (*models.AccountReceivableLedgerReport, error)

func (*FinanceReportService) GetAccountReceivableLedger ¶

func (s *FinanceReportService) GetAccountReceivableLedger(companyID string, contactID string, startDate, endDate time.Time) (*models.AccountReceivableLedgerReport, error)

GetAccountReceivableLedger retrieves the account receivable ledger report for a given company and contact.

It takes the company ID, contact ID, start date, and end date as input and returns a detailed account receivable ledger report. The report includes ledger entries with distinct transaction details, debit and credit amounts, reference numbers, and types. It also calculates the total debit, credit, and balance before the start date, within the date range, and after the end date. Additionally, it fetches contact details, updating the debt and receivables limits if applicable. The function returns an AccountReceivableLedgerReport and an error if the operation fails.

func (*FinanceReportService) GetAccountTransactions ¶

func (s *FinanceReportService) GetAccountTransactions(accountID string, companyID *string, startDate *time.Time, endDate *time.Time) ([]models.TransactionModel, error)

GetAccountTransactions retrieves a list of transactions for a given account, for a given period of time. The period of time is specified by the start and end date parameters. If the start date is not provided, it will default to the beginning of time. If the end date is not provided, it will default to the present time.

The company ID is also an optional parameter, and if it is not provided, the function will return the total debit and credit amounts for all companies.

The function returns a list of TransactionModel and an error if the operation fails. Otherwise, the error is nil.

func (*FinanceReportService) GetAlmostDuePurchase ¶

func (s *FinanceReportService) GetAlmostDuePurchase(companyID string, interval int) ([]models.SalesList, error)

GetAlmostDuePurchase retrieves a list of purchase orders that are almost due for a given company and time interval.

It takes the company ID and time interval as input and returns a list of SalesList containing details of purchase orders. The list includes purchase order ID, purchase number, contact name, total amount, balance, and due date. The function queries the database for purchase orders with a due date that is within the given time interval or has not been set. It also filters out purchase orders that have been fully paid and those that have been deleted. The results are sorted by due date in ascending order. If the operation fails, the function returns an error.

func (*FinanceReportService) GetAlmostDueSales ¶

func (s *FinanceReportService) GetAlmostDueSales(companyID string, interval int) ([]models.SalesList, error)

GetAlmostDueSales retrieves a list of sales that are almost due for a given company and time interval.

It takes the company ID and time interval as input and returns a list of SalesList. The list includes the sales ID, sales number, contact name, total, balance, and due date. The function queries the database for sales with a due date that is within the given time interval or has not been set. It also filters out sales that have been fully paid and sales that have been deleted. The result is sorted by due date in ascending order. If the operation fails, the function returns an error.

func (*FinanceReportService) GetClosingBook ¶

func (s *FinanceReportService) GetClosingBook(request http.Request, search string) (paginate.Page, error)

GetClosingBook retrieves a paginated list of closing books from the database.

It takes an HTTP request and a search query string as input. The search query is applied to the closing book notes field. If a company ID is present in the request header, the result is filtered by the company ID. The function utilizes pagination to manage the result set and applies any necessary request modifications using the utils.FixRequest utility.

The function returns a paginated page of ClosingBook and an error if the operation fails.

func (*FinanceReportService) GetClosingBookByID ¶

func (s *FinanceReportService) GetClosingBookByID(closingBookID string) (*models.ClosingBook, error)

func (*FinanceReportService) GetMonthlyPurchaseReport ¶

func (s *FinanceReportService) GetMonthlyPurchaseReport(companyID string, year int) ([]models.MonthlySalesReport, error)

GetMonthlyPurchaseReport retrieves a list of monthly purchase reports from the database, filtered by the given year and company ID.

Each report contains the total purchase amount for the given month, with the month name represented as a string.

The method returns a slice of MonthlySalesReport and an error, if any.

func (*FinanceReportService) GetMonthlySalesReport ¶

func (s *FinanceReportService) GetMonthlySalesReport(companyID string, year int) ([]models.MonthlySalesReport, error)

GetMonthlySalesReport retrieves a list of monthly sales reports from the database, filtered by the given year and company ID.

Each report contains the total sales amount for the given month, with the month name represented as a string.

The method returns a slice of MonthlySalesReport and an error, if any.

func (*FinanceReportService) GetProductSalesCustomers ¶

func (s *FinanceReportService) GetProductSalesCustomers(companyID string, startDate, endDate time.Time, productIDs []string, customerIDs []string) ([]models.ProductSalesCustomer, error)

GetProductSalesCustomers retrieves a list of sales grouped by product and customer.

It takes the company ID, start date, end date, product IDs, and customer IDs as input and returns a list of ProductSalesCustomer. The list includes product ID, product code, contact ID, contact code, product name, contact name, quantity, unit name, unit code, total quantity, and total price. The function queries the database for sales with the given company ID, document type, and dates. It also filters out sales that have been deleted, and those that have not been posted or finished. The results are grouped by product and customer, and sorted by product name and ID in ascending order, and by contact name and ID in ascending order. If the operation fails, the function returns an error.

func (*FinanceReportService) GetSumCashBank ¶

func (s *FinanceReportService) GetSumCashBank(companyID string) (float64, error)

GetSumCashBank calculates the net sum of cash and bank transactions for a given company.

It takes the company ID as input and returns the total sum of debits minus credits for accounts of type ASSET and with a cashflow sub-group of CASH_BANK. The function queries the database for all transactions associated with these accounts that have not been deleted. If successful, it returns the computed total; otherwise, it returns an error.

func (*FinanceReportService) GetWeeklyPurchaseReport ¶

func (s *FinanceReportService) GetWeeklyPurchaseReport(companyID string, year, month int) ([]models.MonthlySalesReport, error)

GetWeeklyPurchaseReport retrieves a list of weekly purchase reports for a specified company, year, and month. Each report contains the total purchase amount for each week within the given month, identified by week number. The function queries the purchase orders records from the database, filtering by document type 'BILL', the specified year, month, and company ID. It returns a slice of MonthlySalesReport with the total purchase and week name for each week, or an error if the operation fails.

func (*FinanceReportService) GetWeeklySalesReport ¶

func (s *FinanceReportService) GetWeeklySalesReport(companyID string, year, month int) ([]models.MonthlySalesReport, error)

GetWeeklySalesReport retrieves a list of weekly sales reports for a specified company, year, and month. Each report contains the total sales amount for each week within the given month, identified by week number. The function queries the sales records from the database, filtering by document type 'INVOICE', the specified year, month, and company ID. It returns a slice of MonthlySalesReport with the total sales and week name for each week, or an error if the operation fails.

func (*FinanceReportService) SetContactService ¶

func (s *FinanceReportService) SetContactService(contactService *contact.ContactService)

func (*FinanceReportService) TrialBalanceReport ¶

func (s *FinanceReportService) TrialBalanceReport(report models.GeneralReport) (*models.TrialBalanceReport, error)

TrialBalanceReport generates a trial balance report for a given company within a specified date range. It calculates the trial balance, adjustments, and balance sheet for various account types, including ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE, COST, RECEIVABLE, and CONTRA_REVENUE. The function returns a populated TrialBalanceReport and any error encountered during the process.