feat: add method to get budgets #52
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -390,6 +390,243 @@ async def get_account_holdings(self, account_id: int) -> Dict[str, Any]: | |
| variables=variables, | ||
| ) | ||
|
|
||
| async def get_budgets( | ||
| self, | ||
| start_date: Optional[str] = None, | ||
| end_date: Optional[str] = None, | ||
| use_legacy_goals: Optional[bool] = False, | ||
| use_v2_goals: Optional[bool] = True, | ||
|
Comment on lines
+397
to
+398
There was a problem hiding this comment. What happens if you both of these are set to If a condition for validity of the API call is that There was a problem hiding this comment. @grablair This is the result from the query: (use_legacy_goals=true, use_v2_goals=true): two lists returned. One list under dictionary key "goals" and another list under dictionary key "goalsV2". If you have no goals, the list will be empty. So all combinations could be valid |
||
| ) -> Dict[str, Any]: | ||
| """ | ||
| Get your budgets and corresponding actual amounts from the account. | ||
|
|
||
| When no date arguments given: | ||
| | `start_date` will default to last month based on todays date | ||
| | `end_date` will default to next month based on todays date | ||
|
|
||
| :param start_date: | ||
| the earliest date to get budget data, in "yyyy-mm-dd" format (default: last month) | ||
| :param end_date: | ||
| the latest date to get budget data, in "yyyy-mm-dd" format (default: next month) | ||
| :param use_legacy_goals: | ||
| Set True to return a list of monthly budget set aside for goals (default: no list) | ||
| :param use_v2_goals: | ||
| Set True to return a list of monthly budget set aside for version 2 goals (default list) | ||
| """ | ||
| query = gql( | ||
| """ | ||
| query GetJointPlanningData($startDate: Date!, $endDate: Date!, $useLegacyGoals: Boolean!, $useV2Goals: Boolean!) { | ||
| budgetData(startMonth: $startDate, endMonth: $endDate) { | ||
| monthlyAmountsByCategory { | ||
| category { | ||
| id | ||
| __typename | ||
| } | ||
| monthlyAmounts { | ||
| month | ||
| plannedCashFlowAmount | ||
| plannedSetAsideAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| rolloverType | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| monthlyAmountsByCategoryGroup { | ||
| categoryGroup { | ||
| id | ||
| __typename | ||
| } | ||
| monthlyAmounts { | ||
| month | ||
| plannedCashFlowAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| rolloverType | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| monthlyAmountsForFlexExpense { | ||
| budgetVariability | ||
| monthlyAmounts { | ||
| month | ||
| plannedCashFlowAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| rolloverType | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| totalsByMonth { | ||
| month | ||
| totalIncome { | ||
| plannedAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| __typename | ||
| } | ||
| totalExpenses { | ||
| plannedAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| __typename | ||
| } | ||
| totalFixedExpenses { | ||
| plannedAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| __typename | ||
| } | ||
| totalNonMonthlyExpenses { | ||
| plannedAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| __typename | ||
| } | ||
| totalFlexibleExpenses { | ||
| plannedAmount | ||
| actualAmount | ||
| remainingAmount | ||
| previousMonthRolloverAmount | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| categoryGroups { | ||
| id | ||
| name | ||
| order | ||
| groupLevelBudgetingEnabled | ||
| budgetVariability | ||
| rolloverPeriod { | ||
| id | ||
| startMonth | ||
| endMonth | ||
| __typename | ||
| } | ||
| categories { | ||
| id | ||
| name | ||
| icon | ||
| order | ||
| budgetVariability | ||
| rolloverPeriod { | ||
| id | ||
| startMonth | ||
| endMonth | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| type | ||
| __typename | ||
| } | ||
| goals @include(if: $useLegacyGoals) { | ||
| id | ||
| name | ||
| icon | ||
| completedAt | ||
| targetDate | ||
| __typename | ||
| } | ||
| goalMonthlyContributions(startDate: $startDate, endDate: $endDate) @include(if: $useLegacyGoals) { | ||
| mount: monthlyContribution | ||
| startDate | ||
| goalId | ||
| __typename | ||
| } | ||
| goalPlannedContributions(startDate: $startDate, endDate: $endDate) @include(if: $useLegacyGoals) { | ||
| id | ||
| amount | ||
| startDate | ||
| goal { | ||
| id | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| goalsV2 @include(if: $useV2Goals) { | ||
| id | ||
| name | ||
| archivedAt | ||
| completedAt | ||
| priority | ||
| imageStorageProvider | ||
| imageStorageProviderId | ||
| plannedContributions(startMonth: $startDate, endMonth: $endDate) { | ||
| id | ||
| month | ||
| amount | ||
| __typename | ||
| } | ||
| monthlyContributionSummaries(startMonth: $startDate, endMonth: $endDate) { | ||
| month | ||
| sum | ||
| __typename | ||
| } | ||
| __typename | ||
| } | ||
| budgetSystem | ||
| } | ||
| """ | ||
| ) | ||
|
|
||
| variables = { | ||
| "startDate": start_date, | ||
| "endDate": end_date, | ||
| "useLegacyGoals": use_legacy_goals, | ||
| "useV2Goals": use_v2_goals, | ||
| } | ||
|
|
||
| if not start_date and not end_date: | ||
| # Default start_date to last month and end_date to next month | ||
| today = datetime.today() | ||
|
|
||
| # Get the first day of last month | ||
| last_month = today.month - 1 | ||
| last_month_year = today.year | ||
| first_day_of_last_month = 1 | ||
| if last_month < 1: | ||
| last_month_year -= 1 | ||
| last_month = 12 | ||
| variables["startDate"] = datetime( | ||
| last_month_year, last_month, first_day_of_last_month | ||
| ).strftime("%Y-%m-%d") | ||
|
|
||
| # Get the last day of next month | ||
| next_month = today.month + 1 | ||
| next_month_year = today.year | ||
| if next_month > 12: | ||
| next_month_year += 1 | ||
| next_month = 1 | ||
| last_day_of_next_month = calendar.monthrange(next_month_year, next_month)[1] | ||
| variables["endDate"] = datetime( | ||
| next_month_year, next_month, last_day_of_next_month | ||
| ).strftime("%Y-%m-%d") | ||
|
Comment on lines
+598
to
+617
There was a problem hiding this comment. use Python's # Get first day of last month
last_month_start = today - datetime.timedelta(weeks=4)
last_month.replace(day=1)
variables["startDate"] = last_month_start.strftime("%Y-%m-%d")
# Get the last day of the next month
next_month_end = today + datetime.timedelta(weeks=4)
next_month_end.replace(
day=calendar.monthrange(
next_month_end.year,
next_month_end.month
)[1]
)
variables["endDate"] = next_month_end.strftime("%Y-%m-%d") |
||
|
|
||
| elif bool(start_date) != bool(end_date): | ||
| raise Exception( | ||
| "You must specify both a startDate and endDate, not just one of them." | ||
| ) | ||
|
|
||
| return await self.gql_call( | ||
| operation="GetJointPlanningData", | ||
| graphql_query=query, | ||
| variables=variables, | ||
| ) | ||
|
|
||
| async def get_subscription_details(self) -> Dict[str, Any]: | ||
| """ | ||
| The type of subscription for the Monarch Money account. | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will it still work if someone sets both of these to
True?