Skip to content

A local-first personal finance app

[AI] Add Quarterly interval to custom reports (#9347)

Kareem Halabi7caedc7c4892
diff --git a/packages/desktop-client/src/components/reports/ReportOptions.test.ts b/packages/desktop-client/src/components/reports/ReportOptions.test.ts
index 279bd7b312..d14f6700d5 100644
--- a/packages/desktop-client/src/components/reports/ReportOptions.test.ts
+++ b/packages/desktop-client/src/components/reports/ReportOptions.test.ts
@@ -1,3 +1,5 @@
+import * as monthUtils from '@actual-app/core/shared/months';
+
import { getIntervalFormat, ReportOptions } from './ReportOptions';
// The six values selectable in Settings -> Formatting -> Dates.
@@ -35,9 +37,9 @@ describe('getIntervalFormat', () => {
});
});
- describe('Monthly and Yearly intervals', () => {
+ describe('Monthly, Quarterly and Yearly intervals', () => {
// No day/month ambiguity to resolve, so the preference must not reach them.
- it.each(['Monthly', 'Yearly'])(
+ it.each(['Monthly', 'Quarterly', 'Yearly'])(
'%s is unchanged by the date format preference',
interval => {
const base = ReportOptions.intervalFormat.get(interval);
@@ -48,6 +50,15 @@ describe('getIntervalFormat', () => {
);
});
+ it('labels quarters by their number and year', () => {
+ const format = getIntervalFormat('Quarterly', 'MM/dd/yyyy');
+ expect(
+ ['2026-01', '2026-04', '2026-07', '2026-10'].map(quarter =>
+ monthUtils.format(quarter, format),
+ ),
+ ).toEqual(["Q1 '26", "Q2 '26", "Q3 '26", "Q4 '26"]);
+ });
+
it('returns an empty string for an unknown interval', () => {
// Call sites currently write `intervalFormat.get(interval) || ''`, so an
// unknown key has to keep producing a falsy format rather than throwing.
diff --git a/packages/desktop-client/src/components/reports/ReportOptions.ts b/packages/desktop-client/src/components/reports/ReportOptions.ts
index b7c98700f9..50e01ef74a 100644
--- a/packages/desktop-client/src/components/reports/ReportOptions.ts
+++ b/packages/desktop-client/src/components/reports/ReportOptions.ts
@@ -85,6 +85,7 @@ export type dateRangeProps = {
Daily: boolean;
Weekly: boolean;
Monthly: boolean;
+ Quarterly: boolean;
Yearly: boolean;
};
@@ -97,6 +98,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: false,
+ Quarterly: false,
Yearly: false,
},
{
@@ -107,6 +109,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: false,
+ Quarterly: false,
Yearly: false,
},
{
@@ -117,6 +120,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: false,
Yearly: false,
},
{
@@ -127,6 +131,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: false,
Yearly: false,
},
{
@@ -137,6 +142,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: false,
},
{
@@ -147,6 +153,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: false,
},
{
@@ -157,6 +164,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: false,
Yearly: false,
},
{
@@ -167,6 +175,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: true,
Weekly: true,
Monthly: true,
+ Quarterly: false,
Yearly: false,
},
{
@@ -177,6 +186,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: false,
Monthly: true,
+ Quarterly: true,
Yearly: false,
},
{
@@ -187,6 +197,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: false,
Monthly: true,
+ Quarterly: true,
Yearly: false,
},
{
@@ -197,6 +208,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: true,
},
{
@@ -207,6 +219,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: true,
},
{
@@ -217,6 +230,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: true,
},
{
@@ -227,6 +241,7 @@ const dateRangeOptions: dateRangeProps[] = [
Daily: false,
Weekly: true,
Monthly: true,
+ Quarterly: true,
Yearly: true,
},
];
@@ -234,12 +249,13 @@ const dateRangeOptions: dateRangeProps[] = [
type intervalOptionsProps = {
description: string;
key: string;
- name: 'Day' | 'Week' | 'Month' | 'Year';
+ name: 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year';
format: string;
range:
| 'dayRangeInclusive'
| 'weekRangeInclusive'
| 'rangeInclusive'
+ | 'quarterRangeInclusive'
| 'yearRangeInclusive';
};
@@ -265,6 +281,13 @@ const intervalOptions: intervalOptionsProps[] = [
format: "MMM ''yy",
range: 'rangeInclusive',
},
+ {
+ description: t('Quarterly'),
+ key: 'Quarterly',
+ name: 'Quarter',
+ format: "QQQ ''yy",
+ range: 'quarterRangeInclusive',
+ },
{
description: t('Yearly'),
key: 'Yearly',
@@ -287,7 +310,7 @@ export const ReportOptions = {
dateRangeMap: new Map(dateRangeOptions.map(item => [item.key, item.name])),
dateRangeType: new Map(dateRangeOptions.map(item => [item.key, item.type])),
interval: intervalOptions,
- intervalMap: new Map<string, 'Day' | 'Week' | 'Month' | 'Year'>(
+ intervalMap: new Map<string, 'Day' | 'Week' | 'Month' | 'Quarter' | 'Year'>(
intervalOptions.map(item => [item.key, item.name]),
),
intervalFormat: new Map(intervalOptions.map(item => [item.key, item.format])),
@@ -296,13 +319,15 @@ export const ReportOptions = {
| 'dayRangeInclusive'
| 'weekRangeInclusive'
| 'rangeInclusive'
+ | 'quarterRangeInclusive'
| 'yearRangeInclusive'
>(intervalOptions.map(item => [item.key, item.range])),
};
// Only Daily and Weekly labels spell out a day and a month, so they are the
// only intervals whose ordering a date-format preference can disagree with.
-// Monthly ("MMM ''yy") and Yearly ("yyyy") are unambiguous either way.
+// Monthly ("MMM ''yy"), Quarterly ("QQQ ''yy") and Yearly ("yyyy") are
+// unambiguous either way.
const dayLevelIntervals = new Set(['Daily', 'Weekly']);
/**
diff --git a/packages/desktop-client/src/components/reports/ReportSidebar.tsx b/packages/desktop-client/src/components/reports/ReportSidebar.tsx
index 013643059c..9798b26509 100644
--- a/packages/desktop-client/src/components/reports/ReportSidebar.tsx
+++ b/packages/desktop-client/src/components/reports/ReportSidebar.tsx
@@ -210,7 +210,7 @@ export function ReportSidebar({
setGroupBy('Category');
defaultItems('Category');
}
- // Budgeted only supports Monthly and Yearly intervals
+ // Budgeted only supports Monthly, Quarterly and Yearly intervals
if (
customReportItems.interval === 'Daily' ||
customReportItems.interval === 'Weekly'
diff --git a/packages/desktop-client/src/components/reports/disabledList.ts b/packages/desktop-client/src/components/reports/disabledList.ts
index 2c5789838e..99b022b6ba 100644
--- a/packages/desktop-client/src/components/reports/disabledList.ts
+++ b/packages/desktop-client/src/components/reports/disabledList.ts
@@ -17,6 +17,11 @@ const intervalOptions = [
key: 'Monthly',
defaultRange: 'Last 6 months',
},
+ {
+ description: t('Quarterly'),
+ key: 'Quarterly',
+ defaultRange: 'Last 12 months',
+ },
{
description: t('Yearly'),
key: 'Yearly',
diff --git a/packages/desktop-client/src/components/reports/graphs/showActivity.test.ts b/packages/desktop-client/src/components/reports/graphs/showActivity.test.ts
index cba503451a..56fea941b2 100644
--- a/packages/desktop-client/src/components/reports/graphs/showActivity.test.ts
+++ b/packages/desktop-client/src/components/reports/graphs/showActivity.test.ts
@@ -245,6 +245,36 @@ describe('showActivity', () => {
},
);
+ it('filters a Quarterly time drilldown to the whole quarter', () => {
+ const navigate = vi.fn();
+
+ showActivity({
+ navigate,
+ categories,
+ accounts,
+ balanceTypeOp: 'totalTotals',
+ filters: [],
+ showHiddenCategories: true,
+ showOffBudget: true,
+ type: 'time',
+ startDate: '2026-04',
+ endDate: '2026-06-30',
+ interval: 'Quarterly',
+ });
+
+ const [, options] = navigate.mock.calls[0];
+
+ expect(options.state.filterConditions).toEqual([
+ { field: 'date', op: 'gte', value: '2026-04-01', type: 'date' },
+ {
+ field: 'date',
+ op: 'lte',
+ value: '2026-06-30',
+ options: { date: true },
+ },
+ ]);
+ });
+
it.each(['totalTotals', 'netAssets', 'netDebts'] as const)(
'includes all transactions for a %s interval drilldown',
balanceTypeOp => {
diff --git a/packages/desktop-client/src/components/reports/graphs/showActivity.ts b/packages/desktop-client/src/components/reports/graphs/showActivity.ts
index 07f9161ff8..b55a59e011 100644
--- a/packages/desktop-client/src/components/reports/graphs/showActivity.ts
+++ b/packages/desktop-client/src/components/reports/graphs/showActivity.ts
@@ -58,8 +58,15 @@ export function showActivity({
interval === 'Weekly'
? 'dayFromDate'
: (((ReportOptions.intervalMap.get(interval) || 'Day').toLowerCase() +
- 'FromDate') as 'dayFromDate' | 'monthFromDate' | 'yearFromDate');
- const isDateOp = interval === 'Weekly' || type !== 'time';
+ 'FromDate') as
+ | 'dayFromDate'
+ | 'monthFromDate'
+ | 'quarterFromDate'
+ | 'yearFromDate');
+ // Weeks and quarters have no single date value to match, so they are
+ // filtered as a start-to-end date range instead.
+ const isDateOp =
+ interval === 'Weekly' || interval === 'Quarterly' || type !== 'time';
const drilldownFilter =
field === 'tag' && bucketTagNames
? {
diff --git a/packages/desktop-client/src/components/reports/reportRanges.test.ts b/packages/desktop-client/src/components/reports/reportRanges.test.ts
index 4f65569a8a..77cd4a637e 100644
--- a/packages/desktop-client/src/components/reports/reportRanges.test.ts
+++ b/packages/desktop-client/src/components/reports/reportRanges.test.ts
@@ -7,6 +7,8 @@ import {
calculateTimeRange,
getFullFutureRange,
getLatestRange,
+ validateEnd,
+ validateStart,
} from './reportRanges';
// In test mode, monthUtils.currentMonth() returns '2017-01'
@@ -240,3 +242,68 @@ describe('boundMonthRange', () => {
);
});
});
+
+describe('Quarterly range validation', () => {
+ it('starts a range on the first day of the chosen quarter', () => {
+ expect(
+ validateStart(
+ '2016-01-01',
+ '2016-12-31',
+ '2016-04',
+ '2016-12-31',
+ 'Quarterly',
+ ),
+ ).toEqual(['2016-04-01', '2016-12-31', 'static']);
+ });
+
+ it('ends a range on the last day of the chosen quarter', () => {
+ expect(
+ validateEnd(
+ '2016-01-01',
+ '2016-12-31',
+ '2016-01-01',
+ '2016-04',
+ 'Quarterly',
+ ),
+ ).toEqual(['2016-01-01', '2016-06-30', 'static']);
+ });
+
+ it('keeps From when To moves before it on whole-quarter bounds', () => {
+ expect(
+ validateStart(
+ '2010-01-01',
+ '2016-12-31',
+ '2014-07',
+ '2014-06-30',
+ 'Quarterly',
+ ),
+ ).toEqual(['2014-07-01', '2015-06-30', 'static']);
+ });
+
+ it('keeps To when From moves after it on whole-quarter bounds', () => {
+ expect(
+ validateEnd(
+ '2010-01-01',
+ '2016-12-31',
+ '2014-07-01',
+ '2014-04',
+ 'Quarterly',
+ ),
+ ).toEqual(['2013-07-01', '2014-06-30', 'static']);
+ });
+});
+
+describe('same-period range validation', () => {
+ it.each([
+ ['Monthly', '2016-04-01', '2016-04', '2016-04-30'],
+ ['Quarterly', '2016-04-01', '2016-04', '2016-06-30'],
+ ['Yearly', '2016-01-01', '2016', '2016-12-31'],
+ ])(
+ 'keeps From when %s To is the same period',
+ (interval, start, end, expectedEnd) => {
+ expect(
+ validateEnd('2015-01-01', '2016-12-31', start, end, interval),
+ ).toEqual([start, expectedEnd, 'static']);
+ },
+ );
+});
diff --git a/packages/desktop-client/src/components/reports/reportRanges.ts b/packages/desktop-client/src/components/reports/reportRanges.ts
index 40c52be2c5..7f906414a3 100644
--- a/packages/desktop-client/src/components/reports/reportRanges.ts
+++ b/packages/desktop-client/src/components/reports/reportRanges.ts
@@ -10,29 +10,37 @@ export function validateStart(
interval?: string,
firstDayOfWeekIdx?: SyncedPrefs['firstDayOfWeekIdx'],
): [string, string, TimeFrame['mode']] {
- let addDays: number;
let dateStart: string;
+ let fallbackEnd: string;
switch (interval) {
case 'Monthly':
dateStart = start + '-01';
- addDays = 180;
+ fallbackEnd = monthUtils.addDays(dateStart, 180);
+ break;
+ case 'Quarterly':
+ dateStart = start + '-01';
+ // The chosen quarter and the three after it, ending on a quarter boundary
+ fallbackEnd = monthUtils.getMonthEnd(
+ monthUtils.getQuarterEnd(monthUtils.addMonths(start, 9)) + '-01',
+ );
break;
case 'Yearly':
dateStart = start + '-01-01';
- addDays = 1095;
+ fallbackEnd = monthUtils.addDays(dateStart, 1095);
break;
case 'Daily':
dateStart = start;
- addDays = 6;
+ fallbackEnd = monthUtils.addDays(dateStart, 6);
break;
default:
dateStart = start;
- addDays = 180;
+ fallbackEnd = monthUtils.addDays(dateStart, 180);
break;
}
- if (end < start) {
- end = monthUtils.addDays(dateStart, addDays);
+ // Compare full dates: `start` may be a shorter month or year key.
+ if (end < dateStart) {
+ end = fallbackEnd;
}
return boundedRange(
earliest,
@@ -52,29 +60,36 @@ export function validateEnd(
interval?: string,
firstDayOfWeekIdx?: SyncedPrefs['firstDayOfWeekIdx'],
): [string, string, TimeFrame['mode']] {
- let subDays: number;
let dateEnd: string;
+ let fallbackStart: string;
switch (interval) {
case 'Monthly':
dateEnd = monthUtils.getMonthEnd(end + '-01');
- subDays = 180;
+ fallbackStart = monthUtils.subDays(dateEnd, 180);
+ break;
+ case 'Quarterly':
+ dateEnd = monthUtils.getMonthEnd(monthUtils.getQuarterEnd(end) + '-01');
+ // The chosen quarter and the three before it, starting on a quarter boundary
+ fallbackStart =
+ monthUtils.getQuarterStart(monthUtils.subMonths(end, 9)) + '-01';
break;
case 'Yearly':
dateEnd = end + '-12-31';
- subDays = 1095;
+ fallbackStart = monthUtils.subDays(dateEnd, 1095);
break;
case 'Daily':
dateEnd = end;
- subDays = 6;
+ fallbackStart = monthUtils.subDays(dateEnd, 6);
break;
default:
dateEnd = end;
- subDays = 180;
+ fallbackStart = monthUtils.subDays(dateEnd, 180);
break;
}
- if (start > end) {
- start = monthUtils.subDays(dateEnd, subDays);
+ // Compare full dates: `end` may be a shorter month or year key.
+ if (start > dateEnd) {
+ start = fallbackStart;
}
return boundedRange(
earliest,
@@ -158,6 +173,7 @@ function boundedRange(
latest = monthUtils.currentDay();
break;
case 'Monthly':
+ case 'Quarterly':
latest = monthUtils.getMonthEnd(monthUtils.currentDay());
break;
case 'Yearly':
diff --git a/packages/desktop-client/src/components/reports/reports/CustomReport.tsx b/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
index a7e2409121..170b841a10 100644
--- a/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
+++ b/packages/desktop-client/src/components/reports/reports/CustomReport.tsx
@@ -350,7 +350,11 @@ function CustomReportInner({
interval === 'Weekly'
? 'dayFromDate'
: (((ReportOptions.intervalMap.get(interval) || 'Day').toLowerCase() +
- 'FromDate') as 'dayFromDate' | 'monthFromDate' | 'yearFromDate');
+ 'FromDate') as
+ | 'dayFromDate'
+ | 'monthFromDate'
+ | 'quarterFromDate'
+ | 'yearFromDate');
const earliestInterval =
interval === 'Weekly'
@@ -375,7 +379,9 @@ function CustomReportInner({
? monthUtils.currentDay()
: interval === 'Yearly'
? monthUtils.currentYear()
- : monthUtils.currentMonth();
+ : interval === 'Quarterly'
+ ? monthUtils.currentQuarter()
+ : monthUtils.currentMonth();
const maxInterval =
latestInterval > currentInterval ? latestInterval : currentInterval;
diff --git a/packages/desktop-client/src/components/reports/reports/GetCardData.tsx b/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
index a14341d1fc..6e9f63b167 100644
--- a/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
+++ b/packages/desktop-client/src/components/reports/reports/GetCardData.tsx
@@ -42,10 +42,12 @@ function ErrorFallback() {
function convertFromDate(
interval: string | undefined,
-): 'dayFromDate' | 'monthFromDate' | 'yearFromDate' {
+): 'dayFromDate' | 'monthFromDate' | 'quarterFromDate' | 'yearFromDate' {
switch (interval) {
case 'Monthly':
return 'monthFromDate';
+ case 'Quarterly':
+ return 'quarterFromDate';
case 'Yearly':
return 'yearFromDate';
default:
@@ -55,10 +57,16 @@ function convertFromDate(
function convertRangeInclusive(
interval: string | undefined,
-): 'dayRangeInclusive' | 'rangeInclusive' | 'yearRangeInclusive' {
+):
+ | 'dayRangeInclusive'
+ | 'rangeInclusive'
+ | 'quarterRangeInclusive'
+ | 'yearRangeInclusive' {
switch (interval) {
case 'Monthly':
return 'rangeInclusive';
+ case 'Quarterly':
+ return 'quarterRangeInclusive';
case 'Yearly':
return 'yearRangeInclusive';
default:
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/budgetDataQuery.ts b/packages/desktop-client/src/components/reports/spreadsheets/budgetDataQuery.ts
index 5ebccd8e02..9be6b136e5 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/budgetDataQuery.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/budgetDataQuery.ts
@@ -228,7 +228,12 @@ export async function fetchBudgetData({
);
for (const { month, monthData } of monthDataList) {
- const dateKey = interval === 'Yearly' ? month.slice(0, 4) : month;
+ const dateKey =
+ interval === 'Yearly'
+ ? month.slice(0, 4)
+ : interval === 'Quarterly'
+ ? monthUtils.quarterFromDate(month)
+ : month;
for (const cat of filteredCategories) {
if (cat.is_income) {
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.test.ts b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.test.ts
index ed8f64ab2a..9f0001661d 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.test.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.test.ts
@@ -77,3 +77,50 @@ it.each([
]);
},
);
+
+it('rolls monthly rows up into calendar quarters for Quarterly reports', async () => {
+ vi.mocked(fetchSpreadsheetQueryData).mockResolvedValue({
+ assets: [],
+ debts: [
+ { ...transaction, notes: '#red', amount: -50, date: '2026-01' },
+ { ...transaction, notes: '#red', amount: -25, date: '2026-03' },
+ { ...transaction, notes: '#red', amount: -10, date: '2026-04' },
+ { ...transaction, notes: '#red', amount: -5, date: '2026-09' },
+ ],
+ });
+ const { result } = renderHook(useSpreadsheet, {
+ wrapper: SpreadsheetProvider,
+ });
+ const setData = vi.fn<(data: DataEntity) => void>();
+ await createCustomSpreadsheet({
+ startDate: '2026-01-01',
+ endDate: '2026-09-30',
+ interval: 'Quarterly',
+ categories: { list: [], grouped: [] },
+ conditions: [],
+ conditionsOp: 'and',
+ showEmpty: false,
+ showOffBudget: false,
+ showHiddenCategories: false,
+ showUncategorized: false,
+ trimIntervals: false,
+ groupBy: 'Tag',
+ tags: [{ id: 'red', tag: 'red' }],
+ })(result.current, setData);
+
+ const data = setData.mock.calls[0][0];
+ expect(data.intervalData.map(interval => interval.date)).toEqual([
+ "Q1 '26",
+ "Q2 '26",
+ "Q3 '26",
+ ]);
+ expect(data.intervalData.map(interval => interval.totalDebts)).toEqual([
+ -75, -10, -5,
+ ]);
+ expect(data.intervalData.map(interval => interval.intervalEndDate)).toEqual([
+ '2026-03-31',
+ '2026-06-30',
+ '2026-09-30',
+ ]);
+ expect(data.totalDebts).toBe(-90);
+});
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
index 86853859f6..c70ad55b2c 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/custom-spreadsheet.ts
@@ -193,6 +193,17 @@ export function createCustomSpreadsheet({
});
}
+ if (interval === 'Quarterly' && balanceTypeOp !== 'totalBudgeted') {
+ debts = debts.map(d => ({
+ ...d,
+ date: monthUtils.quarterFromDate(d.date),
+ }));
+ assets = assets.map(d => ({
+ ...d,
+ date: monthUtils.quarterFromDate(d.date),
+ }));
+ }
+
const intervals =
interval === 'Weekly'
? monthUtils.weekRangeInclusive(startDate, endDate, firstDayOfWeekIdx)
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
index d896cf3e4e..3125afb547 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/grouped-spreadsheet.ts
@@ -84,6 +84,17 @@ export function createGroupedSpreadsheet({
});
}
+ if (interval === 'Quarterly' && balanceTypeOp !== 'totalBudgeted') {
+ debts = debts.map(d => ({
+ ...d,
+ date: monthUtils.quarterFromDate(d.date),
+ }));
+ assets = assets.map(d => ({
+ ...d,
+ date: monthUtils.quarterFromDate(d.date),
+ }));
+ }
+
const intervals =
interval === 'Weekly'
? monthUtils.weekRangeInclusive(startDate, endDate, firstDayOfWeekIdx)
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.test.ts b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.test.ts
index 0ec164c969..2efc287e1e 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.test.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.test.ts
@@ -31,4 +31,20 @@ describe('makeQuery', () => {
expect(query.selectExpressions).not.toContain('notes');
},
);
+
+ it('queries Quarterly reports by month so they can be rolled up', () => {
+ const query = makeQuery(
+ 'assets',
+ '2026-01-01',
+ '2026-06-30',
+ 'Quarterly',
+ '$and',
+ [],
+ ).serialize();
+
+ expect(query.groupExpressions).toContainEqual({ $month: '$date' });
+ expect(query.selectExpressions).toContainEqual({
+ date: { $month: '$date' },
+ });
+ });
});
diff --git a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts
index def1439306..bba6e27664 100644
--- a/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts
+++ b/packages/desktop-client/src/components/reports/spreadsheets/makeQuery.ts
@@ -12,8 +12,10 @@ export function makeQuery(
filters: unknown[],
groupBy?: string,
) {
+ // Weekly and Quarterly have no AQL date transform, so they are queried at a
+ // finer grain (days and months) and rolled up by the spreadsheets.
const intervalGroup =
- interval === 'Monthly'
+ interval === 'Monthly' || interval === 'Quarterly'
? { $month: '$date' }
: interval === 'Yearly'
? { $year: '$date' }
@@ -21,7 +23,10 @@ export function makeQuery(
const intervalFilter =
interval === 'Weekly'
? '$day'
- : '$' + ReportOptions.intervalMap.get(interval)?.toLowerCase() || 'month';
+ : interval === 'Quarterly'
+ ? '$month'
+ : '$' + ReportOptions.intervalMap.get(interval)?.toLowerCase() ||
+ 'month';
const query = q('transactions')
//Apply filters and split by "Group By"
diff --git a/packages/loot-core/src/shared/months.test.ts b/packages/loot-core/src/shared/months.test.ts
index 1931569617..c21bc9ffe9 100644
--- a/packages/loot-core/src/shared/months.test.ts
+++ b/packages/loot-core/src/shared/months.test.ts
@@ -22,6 +22,29 @@ test('getQuarterStart and getQuarterEnd return the bounding months of the quarte
expect(monthUtils.getQuarterEnd('2024-11')).toBe('2024-12');
});
+test('quarterFromDate keys a date by the first month of its quarter', () => {
+ expect(monthUtils.quarterFromDate('2024-01-01')).toBe('2024-01');
+ expect(monthUtils.quarterFromDate('2024-03-31')).toBe('2024-01');
+ expect(monthUtils.quarterFromDate('2024-05')).toBe('2024-04');
+ expect(monthUtils.quarterFromDate('2024-12-15')).toBe('2024-10');
+});
+
+test('quarterRangeInclusive lists every quarter touched by the range', () => {
+ expect(monthUtils.quarterRangeInclusive('2023-11-15', '2024-05-01')).toEqual([
+ '2023-10',
+ '2024-01',
+ '2024-04',
+ ]);
+ expect(monthUtils.quarterRangeInclusive('2024-02', '2024-03')).toEqual([
+ '2024-01',
+ ]);
+});
+
+test('currentQuarter returns the first month of the current quarter', () => {
+ // In test mode, currentMonth() returns '2017-01'
+ expect(monthUtils.currentQuarter()).toBe('2017-01');
+});
+
test('prevQuarter subtracts three months, landing in the previous quarter', () => {
expect(monthUtils.prevQuarter('2024-02')).toBe('2023-11');
expect(monthUtils.prevQuarter('2024-01')).toBe('2023-10');
diff --git a/packages/loot-core/src/shared/months.ts b/packages/loot-core/src/shared/months.ts
index 58c602d828..19f621cb83 100644
--- a/packages/loot-core/src/shared/months.ts
+++ b/packages/loot-core/src/shared/months.ts
@@ -431,6 +431,29 @@ export function getQuarterEnd(month: string): string {
return getYear(month) + '-' + String(endMonth).padStart(2, '0');
}
+// Quarters are keyed by their first month, e.g. Q2 2024 is '2024-04'.
+export function quarterFromDate(date: DateLike): string {
+ return getQuarterStart(monthFromDate(date));
+}
+
+export function currentQuarter(): string {
+ return getQuarterStart(currentMonth());
+}
+
+export function quarterRangeInclusive(
+ start: DateLike,
+ end: DateLike,
+): string[] {
+ const quarters: string[] = [];
+ let quarter = quarterFromDate(start);
+ const endQuarter = quarterFromDate(end);
+ while (quarter <= endQuarter) {
+ quarters.push(quarter);
+ quarter = addMonths(quarter, 3);
+ }
+ return quarters;
+}
+
export function sheetForMonth(month: string): string {
return 'budget' + month.replace('-', '');
}
diff --git a/upcoming-release-notes/add-quarterly-custom-report-interval.md b/upcoming-release-notes/add-quarterly-custom-report-interval.md
new file mode 100644
index 0000000000..6d60348a64
--- /dev/null
+++ b/upcoming-release-notes/add-quarterly-custom-report-interval.md
@@ -0,0 +1,6 @@
+---
+category: Features
+authors: [kareemhalabi]
+---
+
+Add a Quarterly interval to custom reports