-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Plaid portfolio sync algorithm and calculation improvements #1526
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…everse-investment-portfolio-sync
…everse-investment-portfolio-sync
This was referenced Dec 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability to synchronize the
Account::Balance
andAccount::Holding
records in both the forward and reverse directions to support both "manual" and "connected" accounts.Manual account syncs
When dealing with a "manual" account (i.e. an account where the user is managing the data and balances), we must sync the account in the forwards direction.
For a manual account sync, we start the account at $0 and apply all
Account::Entry
records in chronological order.Plaid account syncs
When dealing with "connected" account syncs, we must treat the provided balance as the source of truth. In our case, Plaid will provide us with the user's "current balance" (i.e. "current bank balance"). We take that as our source of truth and must work backwards, applying
Account::Entry
records (also provided by Plaid) in reverse-chronological order to build up the historical balance.This also applies to investment holdings. Plaid provides the "current portfolio" (i.e. today's holding quantities, prices, values), which we treat as the source of truth and again, work backwards to construct the historical value of the investment portfolio.
Balance terminology
Depending on the account type, "balance" means different things. In general, the
account_balances
table represents a daily historical view of the overall "balance" on the account, which translates to:brokerage cash + holdings market value
This PR adds a
cash_balance
field to bothAccount
andAccount::Balance
tables to more easily display the total "balance" on an account. This field is optional and is primarily used forInvestment
accounts (cash_balance
is "brokerage cash",balance
is "total value", and the difference represents the "market value of the holdings")