Files
sure/app/models/assistant/function/get_bill_details.rb
T
Brandon ce92b36351 feat(bills): assistant and MCP tools for bills (#3203)
* feat(bills): assistant and MCP tools for bills

Last of three chunks carved out of #3083, stacked on the UI bundle. Exposes
bills to the builtin assistant and to MCP clients. Everything here is gated
behind preview features, so the tools are absent from tools/list until a user
opts in.

Seven tools:

- get_bills, get_bill_details and get_paycheck_plan for reads
- get_bill_audit, a deterministic review that surfaces likely duplicates, price
  changes, trials about to convert, upcoming renewals and long-overdue bills
- create_bill, update_bill and record_bill_payment for writes

Shared argument parsing, permission checks and error shapes live in
BillsSupport, so every tool answers with the same {error, hint} contract the
existing tools use, and a bad argument never aborts the turn.

The write tools mutate financial records on a model's say-so, so they refuse
rather than guess: a payment cannot exceed what its cycle still owes, a repeated
settle will not quietly close next month, an unrecognized frequency is an error
instead of a silent monthly default, and non-finite or negative amounts are
rejected before they reach the database.

The read tools say what they filtered. An empty result names the statuses that
do hold matches, the paycheck plan discloses the unconfirmed series it excluded
from spending headroom, and history and price-change windows report their real
totals rather than letting a caller sum a truncated list.

A not-found no longer returns the scoped relation's SQL, which handed any MCP
client the access-control schema for the cost of a guessed id.

The in-page AI helpers are not here. Smart fill and smart configuration are
buttons on the bills pages, so they ship with the UI bundle along with the
provider-side suggester they call.

Suite 7,854 runs, 0 failures. Rubocop clean, eager loading verified.

* Address the ready-review round

* Reject an out-of-range audit lookback out loud

* Speak the cycle remainder guard through the allocator locale
2026-09-02 07:06:13 +02:00

170 lines
7.3 KiB
Ruby

class Assistant::Function::GetBillDetails < Assistant::Function
include Assistant::Function::BillsSupport
HISTORY_LIMIT = 12
PRICE_CHANGE_LOOKBACK_MONTHS = 24
class << self
def name
"get_bill_details"
end
def description
<<~INSTRUCTIONS
Get one bill's complete story: full configuration, every open occurrence, the last
#{HISTORY_LIMIT} settled occurrences with their payments, upcoming due dates, price-change
history, and cost analytics.
Analytics are computed from confirmed payments on settled occurrences only, never
from estimates, and are null when nothing has been paid yet. The one figure that is
not payment-derived says so in its name: annualized_declared is the amount on the
bill times its cadence, while annualized_cost follows what has actually been paid.
Where they disagree, annualized_cost is what the bill is costing.
history is capped at the last #{HISTORY_LIMIT} settled cycles and price_changes at
#{PRICE_CHANGE_LOOKBACK_MONTHS} months. history_window and price_change_window report
the real totals, so do not sum the rows and present the result as a lifetime figure.
bill_id must be the exact id returned by get_bills.
INSTRUCTIONS
end
end
def params_schema
build_schema(
required: [ "bill_id" ],
properties: {
bill_id: { type: "string", description: "The bill's id, exactly as returned by get_bills." }
}
)
end
def call(params = {})
return recurring_disabled_result if recurring_disabled?
series, error = find_series(params["bill_id"])
return error if error
open_occurrences = series.recurring_occurrences.open_status.order(:due_on).to_a
closed = series.recurring_occurrences.closed
history = closed.order(due_on: :desc).limit(HISTORY_LIMIT).includes(allocations: :entry).to_a
preload_allocation_sums(open_occurrences + history)
changes = price_changes(series)
{
bill: serialize_series(series).merge(configuration(series)),
analytics: analytics(series),
open_occurrences: open_occurrences.map { |occurrence| serialize_occurrence(occurrence) },
history: history.map { |occurrence| serialize_history_row(occurrence) },
history_window: truncation(history.size, closed.count),
upcoming_due_dates: series.schedule.occurrences_between(Date.current + 1, Date.current + 400).first(3).map(&:iso8601),
price_changes: changes,
price_change_window: { months: PRICE_CHANGE_LOOKBACK_MONTHS, count: changes.size }
}
end
private
def configuration(series)
{
amount_strategy: series.amount_strategy,
weekend_adjust: series.weekend_adjust,
end_mode: series.end_mode,
end_on: series.end_on&.iso8601,
end_after_count: series.end_after_count,
anchor_date: series.anchor_date&.iso8601,
notes: series.notes,
notify_days_before: series.notify_days_before,
overdue_grace_days: series.overdue_grace_days,
trial_ends_on: series.trial_ends_on&.iso8601,
renews_on: series.renews_on&.iso8601,
cancelled_on: series.cancelled_on&.iso8601,
schedule_pinned: series.schedule_pinned?,
expected_amount_min: series.expected_amount_min_money&.abs&.format,
expected_amount_max: series.expected_amount_max_money&.abs&.format,
expected_amount_avg: series.expected_amount_avg_money&.abs&.format
}.compact
end
# Same discipline as the bill page: what each settled cycle actually cost,
# from confirmed allocations on paid occurrences. The frozen
# expected_amount is an estimate; averaging estimates beside sums of real
# payments would let the page disagree with itself.
def analytics(series)
paid_amounts = RecurringAllocation.confirmed
.joins(:recurring_occurrence)
.where(recurring_occurrences: {
recurring_transaction_id: series.id,
status: "paid"
})
.group(:recurring_occurrence_id)
.sum(:allocated_amount)
.values
return nil if paid_amounts.empty?
ytd = RecurringAllocation.confirmed
.joins(:recurring_occurrence)
.where(recurring_occurrences: { recurring_transaction_id: series.id })
.where("recurring_allocations.paid_on >= ?", Date.current.beginning_of_year)
.sum(:allocated_amount)
average = paid_amounts.sum / paid_amounts.size
{
average_paid: Money.new(average, series.currency).format,
lowest_paid: Money.new(paid_amounts.min, series.currency).format,
highest_paid: Money.new(paid_amounts.max, series.currency).format,
# This block is documented as payments-only, and annualized_cost was the
# exception: the DECLARED amount times cadence, sitting beside an average
# derived from what was actually paid. A bill declared at $100 whose every
# payment was $50 reported a $50 average and a $1,200 year in the same
# hash, and the description told the model to trust it as payment-derived.
# Run rate now follows the payments; the declared figure keeps its own
# name, so a caller comparing the two can see the gap. annualized_cost
# keeps its name and starts meaning what the block always promised.
annualized_cost: Money.new(average * series.schedule.occurrences_per_year, series.currency).format,
annualized_declared: (series.monthly_equivalent_amount * 12).abs.format,
paid_this_year: Money.new(ytd, series.currency).format
}
end
# get_bills reports total_results and truncated; every get_bill_audit
# section reports {items, truncated, count}. History and price changes
# clamped silently, so an assistant summing the rows it was given reported
# a lifetime total short by however many cycles fell off the end.
def truncation(shown, total)
{ count: total, truncated: total > shown }
end
def serialize_history_row(occurrence)
serialize_occurrence(occurrence).merge(
status: occurrence.status,
payments: occurrence.allocations.map do |allocation|
{
amount: allocation.allocated_amount_money.format,
paid_on: allocation.paid_on&.iso8601,
source: allocation.source,
state: allocation.state,
transaction_name: allocation.entry&.name
}.compact
end
)
end
def price_changes(series)
series.recurring_price_changes
.where("effective_on >= ?", PRICE_CHANGE_LOOKBACK_MONTHS.months.ago.to_date)
.order(effective_on: :desc)
.map do |change|
{
effective_on: change.effective_on.iso8601,
previous_amount: Money.new(change.previous_amount, change.currency).abs.format,
new_amount: Money.new(change.new_amount, change.currency).abs.format,
percent_change: percent_change(change.previous_amount, change.new_amount),
source: change.source
}
end
end
end