[Feature] Add 'notes' fields to the account object #1198

New Issue

GiteaMirror · 2026-02-28T19:35:47-06:00

GiteaMirror commented

2026-02-28 19:35:47 -06:00

Originally created by @dimaj on GitHub (Jul 5, 2024).

Verified feature request does not already exist?

I have searched and found no existing issue

💻

Would you like to implement this feature?

Pitch: what problem are you trying to solve?

I am trying to write some automation around some accounts. To make that automation work, I am annotating accounts with various notes. Automation then reads those notes and does what it needs to do.

For example, I have an investment account that I would like to get updated balance of without connecting my account to the simpleFIN service. So, my idea was to add a note to the account describing how much of each stock I have in my portfolio. Then, have something like a Google Apps Script that would retrieve that note, identify various stock tickers, and update account register with latest portfolio value.

Describe your ideal solution to this problem

The ideal solution would be to get an account by ID and have a notes field in it.

Teaching and learning

Update API documentation for Account object

Originally created by @dimaj on GitHub (Jul 5, 2024). ### Verified feature request does not already exist? - [X] I have searched and found no existing issue ### 💻 - [X] Would you like to implement this feature? ### Pitch: what problem are you trying to solve? I am trying to write some automation around some accounts. To make that automation work, I am annotating accounts with various notes. Automation then reads those notes and does what it needs to do. For example, I have an investment account that I would like to get updated balance of without connecting my account to the simpleFIN service. So, my idea was to add a note to the account describing how much of each stock I have in my portfolio. Then, have something like a Google Apps Script that would retrieve that note, identify various stock tickers, and update account register with latest portfolio value. ### Describe your ideal solution to this problem The ideal solution would be to get an account by ID and have a `notes` field in it. ### Teaching and learning Update API documentation for [Account](https://actualbudget.org/docs/api/reference#account) object

GiteaMirror added the needs votes feature labels 2026-02-28 19:35:47 -06:00

GiteaMirror closed this issue

2026-02-28 19:35:47 -06:00

GiteaMirror commented

2026-02-28 19:35:47 -06:00

@dimaj commented on GitHub (Jul 5, 2024):

I don't mind taking a stab at implementing this feature, but don't really know where to start. I did find the account.d.ts type definition, but not sure if there's more that is needed to be udpdated/modified.

@dimaj commented on GitHub (Jul 5, 2024): I don't mind taking a stab at implementing this feature, but don't really know where to start. I did find the [account.d.ts](https://github.com/actualbudget/actual/blob/v24.6.0/packages/loot-core/src/types/models/account.d.ts) type definition, but not sure if there's more that is needed to be udpdated/modified.

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@github-actions[bot] commented on GitHub (Jul 5, 2024):

✨ Thanks for sharing your idea! ✨

This repository uses lodash style issue management for enhancements. That means enhancement issues are automatically closed. This doesn’t mean we don’t accept feature requests, though! We will consider implementing ones that receive many upvotes, and we welcome contributions for any feature requests marked as needing votes (just post a comment first so we can help you make a successful contribution).

The enhancement backlog can be found here: https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+

Don’t forget to upvote the top comment with 👍!

@github-actions[bot] commented on GitHub (Jul 5, 2024): :sparkles: Thanks for sharing your idea! :sparkles: This repository uses lodash style issue management for enhancements. That means enhancement issues are automatically closed. This doesn’t mean we don’t accept feature requests, though! We will consider implementing ones that receive many upvotes, and we welcome contributions for any feature requests marked as needing votes (just post a comment first so we can help you make a successful contribution). The enhancement backlog can be found here: https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+ Don’t forget to upvote the top comment with 👍!

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@youngcw commented on GitHub (Jul 5, 2024):

Could this also work if the existing notes were made available to the api? I don't see a good reason to rework how the notes work vs using what is already there.

@youngcw commented on GitHub (Jul 5, 2024): Could this also work if the existing notes were made available to the api? I don't see a good reason to rework how the notes work vs using what is already there.

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@dimaj commented on GitHub (Jul 5, 2024):

sorry, i am not following the question.

web ui has notes for budgets, accounts and transactions. Both Budgets and Transactions export notes field through API. Account does not.

@dimaj commented on GitHub (Jul 5, 2024): sorry, i am not following the question. web ui has notes for budgets, accounts and transactions. Both [Budgets](https://actualbudget.org/docs/api/reference/#budgets) and [Transactions](https://actualbudget.org/docs/api/reference/#transactions) export `notes` field through API. Account does not.

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@youngcw commented on GitHub (Jul 5, 2024):

Both Budgets and Transactions export notes field through API. Account does not.

Weird that accounts doesn't since the notes are all stored together in their own table

@youngcw commented on GitHub (Jul 5, 2024): > Both [Budgets](https://actualbudget.org/docs/api/reference/#budgets) and [Transactions](https://actualbudget.org/docs/api/reference/#transactions) export `notes` field through API. Account does not. Weird that accounts doesn't since the notes are all stored together in their own table

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@Wingysam commented on GitHub (Jul 22, 2024):

Where does it export the notes field? I don't see it here
5c0bee6031/packages/loot-core/src/types/api-handlers.d.ts (L39-L52)

@Wingysam commented on GitHub (Jul 22, 2024): Where does it export the notes field? I don't see it here https://github.com/actualbudget/actual/blob/5c0bee6031c081aa8ae573fbbe610611b302757b/packages/loot-core/src/types/api-handlers.d.ts#L39-L52

GiteaMirror commented

2026-02-28 19:35:48 -06:00

@dimaj commented on GitHub (Jul 22, 2024):

I was referring to the documentation (https://actualbudget.org/docs/api/reference), but now I do not see the table for budgets return.

@dimaj commented on GitHub (Jul 22, 2024): I was referring to the documentation (https://actualbudget.org/docs/api/reference), but now I do not see the table for budgets return.

GiteaMirror commented

2026-02-28 19:35:49 -06:00

@psybers commented on GitHub (Aug 7, 2024):

I do not believe notes are exposed directly in the API. This is a feature I will probably add.

For now though, you can read and update notes via the API by using the debug helpers. You can see an example of that here: 7e8cb82437/utils.js (L120-L141)

@psybers commented on GitHub (Aug 7, 2024): I do not believe notes are exposed directly in the API. This is a feature I will probably add. For now though, you *can* read and update notes via the API by using the debug helpers. You can see an example of that here: https://github.com/psybers/actual-helpers/blob/7e8cb824375e3b1834cd7ba3b45cc6d9040c514e/utils.js#L120-L141

GiteaMirror commented

2026-02-28 19:35:49 -06:00

@Wingysam commented on GitHub (Aug 7, 2024):

Okay thank you!

@Wingysam commented on GitHub (Aug 7, 2024): Okay thank you!