mirror of
https://github.com/actualbudget/actual.git
synced 2026-07-15 22:54:03 -05:00
[GH-ISSUE #2987] [Feature] Add 'notes' fields to the account object #90827
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: github-starred/actual#90827
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @dimaj on GitHub (Jul 5, 2024).
Original GitHub issue: https://github.com/actualbudget/actual/issues/2987
Verified feature request does not already exist?
💻
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
notesfield in it.Teaching and learning
Update API documentation for Account object
@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.
@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 👍!
@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.
@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
notesfield through API. Account does not.@youngcw commented on GitHub (Jul 5, 2024):
Weird that accounts doesn't since the notes are all stored together in their own table
@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)@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.
@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)@Wingysam commented on GitHub (Aug 7, 2024):
Okay thank you!