126 lines
4.0 KiB
Ruby
126 lines
4.0 KiB
Ruby
class Assistant::Function::GetIncomeStatement < Assistant::Function
|
|
include ActiveSupport::NumberHelper
|
|
|
|
class << self
|
|
def name
|
|
"get_income_statement"
|
|
end
|
|
|
|
def description
|
|
<<~INSTRUCTIONS
|
|
Use this to get income and expense insights by category, for a specific time period
|
|
|
|
This is great for answering questions like:
|
|
- What is the user's net income for the current month?
|
|
- What are the user's spending habits?
|
|
- How much income or spending did the user have over a specific time period?
|
|
|
|
Simple example:
|
|
|
|
```
|
|
get_income_statement({
|
|
start_date: "2024-01-01",
|
|
end_date: "2024-12-31"
|
|
})
|
|
```
|
|
INSTRUCTIONS
|
|
end
|
|
end
|
|
|
|
def call(params = {})
|
|
period = Period.custom(start_date: Date.parse(params["start_date"]), end_date: Date.parse(params["end_date"]))
|
|
income_data = family.income_statement.income_totals(period: period)
|
|
expense_data = family.income_statement.expense_totals(period: period)
|
|
|
|
{
|
|
currency: family.currency,
|
|
period: {
|
|
start_date: period.start_date,
|
|
end_date: period.end_date
|
|
},
|
|
income: {
|
|
total: format_money(income_data.total),
|
|
by_category: to_ai_category_totals(income_data.category_totals)
|
|
},
|
|
expense: {
|
|
total: format_money(expense_data.total),
|
|
by_category: to_ai_category_totals(expense_data.category_totals)
|
|
},
|
|
insights: get_insights(income_data, expense_data)
|
|
}
|
|
end
|
|
|
|
def params_schema
|
|
build_schema(
|
|
required: [ "start_date", "end_date" ],
|
|
properties: {
|
|
start_date: {
|
|
type: "string",
|
|
description: "Start date for aggregation period in YYYY-MM-DD format"
|
|
},
|
|
end_date: {
|
|
type: "string",
|
|
description: "End date for aggregation period in YYYY-MM-DD format"
|
|
}
|
|
}
|
|
)
|
|
end
|
|
|
|
private
|
|
def format_money(value)
|
|
Money.new(value, family.currency).format
|
|
end
|
|
|
|
def calculate_savings_rate(total_income, total_expenses)
|
|
return 0 if total_income.zero?
|
|
savings = total_income - total_expenses
|
|
rate = (savings / total_income.to_f) * 100
|
|
rate.round(2)
|
|
end
|
|
|
|
def to_ai_category_totals(category_totals)
|
|
hierarchical_groups = category_totals.group_by { |ct| ct.category.parent_id }.then do |grouped|
|
|
root_category_totals = grouped[nil] || []
|
|
|
|
root_category_totals.each_with_object({}) do |ct, hash|
|
|
subcategory_totals = ct.category.name == "Uncategorized" ? [] : (grouped[ct.category.id] || [])
|
|
hash[ct.category.name] = {
|
|
category_total: ct,
|
|
subcategory_totals: subcategory_totals
|
|
}
|
|
end
|
|
end
|
|
|
|
hierarchical_groups.sort_by { |name, data| -data.dig(:category_total).total }.map do |name, data|
|
|
{
|
|
name: name,
|
|
total: format_money(data.dig(:category_total).total),
|
|
percentage_of_total: number_to_percentage(data.dig(:category_total).weight, precision: 1),
|
|
subcategory_totals: data.dig(:subcategory_totals).map do |st|
|
|
{
|
|
name: st.category.name,
|
|
total: format_money(st.total),
|
|
percentage_of_total: number_to_percentage(st.weight, precision: 1)
|
|
}
|
|
end
|
|
}
|
|
end
|
|
end
|
|
|
|
def get_insights(income_data, expense_data)
|
|
net_income = income_data.total - expense_data.total
|
|
savings_rate = calculate_savings_rate(income_data.total, expense_data.total)
|
|
median_monthly_income = family.income_statement.median_income
|
|
median_monthly_expenses = family.income_statement.median_expense
|
|
avg_monthly_expenses = family.income_statement.avg_expense
|
|
|
|
{
|
|
net_income: format_money(net_income),
|
|
savings_rate: number_to_percentage(savings_rate),
|
|
median_monthly_income: format_money(median_monthly_income),
|
|
median_monthly_expenses: format_money(median_monthly_expenses),
|
|
avg_monthly_expenses: format_money(avg_monthly_expenses)
|
|
}
|
|
end
|
|
end
|