📄️ addTransactionAttachment
No description
📄️ answerProfileQuestionV2
No description
📄️ answerProfileQuestion
No description
📄️ applyAllTransactionRulesToExistingTransactions
No description
📄️ applyStripeCancelDiscountOffer
No description
📄️ archiveGoal
No description
📄️ archiveSavingsGoal
No description
📄️ assignTaxScheduleCategoryMapping
Assign or reassign a category to a Schedule C line item (upsert by category/schedule/year).
📄️ assignTransactionToStream
No description
📄️ bulkDeleteTransactions
Bulk delete transactions from IDs
📄️ bulkUpdateTransactions
Bulk edit transactions from IDs.
📄️ cancelDataProviderSwitch
Cancel a pre-execution switch and discard the newly connected credential (DP Switching cancel).
📄️ cancelMessageThread
No description
📄️ cancelStripeSubscription
No description
📄️ cancelSubscriptionSponsorship
Cancel subscription sponsorship
📄️ changeStripeSubscription
Change a household's stripe subscription plan, for example from monthly to yearly
📄️ checkActivity
No description
📄️ claimBillItem
Claim an item for a participant
📄️ clearAllActivities
No description
📄️ clearBudget
No description
📄️ clearHoldingClassification
No description
📄️ clearSecurityClassification
No description
📄️ completeGuessYourSpendGame
No description
📄️ completeRetailSync
Mutation to complete a retail sync.
📄️ confirmDataProviderSwitchMappings
Persist the confirmed account mappings and advance the switch to mappings_confirmed (step 3).
📄️ confirmSavingsGoalMigration
Confirm the savings goal migration by marking the household as migrated.
📄️ confirmTotpDevice
Confirm a user's unconfirmed TOTPDevice.
📄️ convertEmployeeTrial
Convert the current employee's trial to an active paid subscription (employee-only)
📄️ copySnapshots
Copy snapshots from one account to another
📄️ createAccountsFromPlaidToken
No description
📄️ createAdditionalRecurringTransactionStream
No description
📄️ createAdvisorStripeSubscription
Creates a Stripe subscription for an advisor household during onboarding.
📄️ createAiReport
Mutation to create an AI-generated report from a description.
📄️ createBudget
No description
📄️ createBulkRetailSync
Mutation to create multiple retail syncs for bulk receipt upload.
📄️ createCategoryGroup
No description
📄️ createCategory
No description
📄️ createCoinbaseAccount
No description
📄️ createEquityAccountWithGrants
No description
📄️ createEquityAccount
No description
📄️ createEquityGrant
No description
📄️ createFeedbackEvent
Mutation to create a new feedback event.
📄️ createFinancialInsightExclusion
No description
📄️ createFinicityConnectFixUrl
Generates a Connect "Fix" url to re-link an existing credential
📄️ createFinicityConnectUrl
Generates a Connect url to begin linking a new credential
📄️ createFinicityCredentials
This is similar to CreateAccountsFromPlaidToken, but for Finicity. It will
📄️ createForecastScenario
Create a new fully-initialized non-duplicate forecast scenario.
📄️ createGoalAccountAllocation
No description
📄️ createGoalAccountInitialContributions
No description
📄️ createGoalV2
No description
📄️ createGoals
No description
📄️ createHouseholdAccessGrant
No description
📄️ createInstitutionIssueReport
No description
📄️ createManualAccount
No description
📄️ createManualHolding
No description
📄️ createManualInvestmentsAccount
No description
📄️ createManualTaxLot
No description
📄️ createManualTaxLotsBulk
Create multiple manual tax lots in a single operation.
📄️ createMessageThread
No description
📄️ createMxConnectFixUrl
Generates a Connect "Fix" url to re-link an existing credential
📄️ createMxConnectUrl
Request a Connect URL to create a new member
📄️ createMxCredentials
This is similar to CreateAccountsFromPlaidToken, but for MX. It will
📄️ createOrUpdateGoalPlannedContribution
No description
📄️ createPaycheckEmployer
No description
📄️ createPaycheck
No description
📄️ createPlaidLinkToken
No description
📄️ createPromoCodeCheckoutSession
Create a Stripe checkout session for a one-time promo code purchase
📄️ createRecoveryCodes
No description
📄️ createRecurringTransactionStream
No description
📄️ createReportConfiguration
Endpoint to create a report configuration.
📄️ createRetailSync
Mutation to create a new retail sync record.
📄️ createReviewCheckin
No description
📄️ createSavingsGoalContribution
No description
📄️ createSavingsGoalWithdrawal
No description
📄️ createSavingsGoal
No description
📄️ createSavingsGoals
No description
📄️ createSpinwheelAccountMapping
Endpoint to create the account mappping in the database.
📄️ createSpinwheelToken
Endpoint to create / authenticate a user with Spinwheel and get a token
📄️ createStripeCheckoutSession
No description
📄️ createStripeSubscription
Creates a Stripe subscription for a user's household. This mutation should only be called
📄️ createSubscriptionSponsorshipInvites
Create subscription sponsorship invites
📄️ createSyncedRealEstateAccount
No description
📄️ createSyncedVehicleAccount
No description
📄️ createTransactionFilterSet
Endpoint to create a transaction filter set.
📄️ createTransactionRuleV2
No description
📄️ createTransactionTag
No description
📄️ createTransaction
Create a new manual transaction
📄️ createTrustedReceiptSender
No description
📄️ createUnconfirmedTotpDevice
Create an unconfirmed TOTP device for the user.
📄️ deleteAccountLogo
No description
📄️ deleteAccount
No description
📄️ deleteAllHouseholdTransactionTags
No description
📄️ deleteAllMessageThreads
No description
📄️ deleteAllReconciliationRecordsForHousehold
No description
📄️ deleteAllTransactionRules
No description
📄️ deleteBusinessEntityLogo
Delete the logo from a business entity.
📄️ deleteBusinessEntity
No description
📄️ deleteCategoryGroup
No description
📄️ deleteCategory
Delete (or disable) a category, and move all rules / transactions to
📄️ deleteCredential
No description
📄️ deleteCreditScoreSnapshots
Endpoint to delete all credit score snapshots for a user.
📄️ deleteEquityGrant
No description
📄️ deleteFinancialInsightExclusion
No description
📄️ deleteForecastAccount
Delete a linked forecast account whose underlying Account has been soft-deleted.
📄️ deleteForecastScenario
Soft-delete a scenario and re-pack the surviving order to `0..N`.
📄️ deleteGoalAccountAllocation
No description
📄️ deleteGoalEvent
No description
📄️ deleteGoalReconciliationRecordsForTransaction
No description
📄️ deleteGoalV2
No description
📄️ deleteHolding
No description
📄️ deleteHousehold
No description
📄️ deleteMerchantLogo
No description
📄️ deleteMerchant
No description
📄️ deleteMessageThread
No description
📄️ deletePaycheckEmployer
No description
📄️ deletePaycheck
No description
📄️ deleteReceipt
No description
📄️ deleteRecurringTransactionStream
No description
📄️ deleteReportConfiguration
Endpoint to delete a report configuration.
📄️ deleteSavingsGoal
No description
📄️ deleteSyncedSnapshots
Delete before a specified date
📄️ deleteSyncedTransactions
Delete synced transactions
📄️ deleteTaxLot
No description
📄️ deleteTaxLotsBulk
Soft delete multiple tax lots in a single operation.
📄️ deleteTaxScheduleCategoryMapping
Remove a category's mapping from a Schedule C line item.
📄️ deleteTotpDevice
Delete a user's TOTP device. This assumes the user only has one, which
📄️ deleteTransactionAttachment
No description
📄️ deleteTransactionFilterSet
Endpoint to delete a transaction filter set.
📄️ deleteTransactionRule
No description
📄️ deleteTransactionTag
No description
📄️ deleteTransaction
Delete a manual transaction
📄️ deleteTransactions
Delete transactions
📄️ deleteTrustedReceiptSender
No description
📄️ deleteUnmatchedRetailSync
Mutation to delete an unmatched retail sync.
📄️ deleteUserFromHousehold
No description
📄️ deleteUserProfilePicture
No description
📄️ detectRecurrenceGroups
Enqueue V2 recurrence detection for the current employee's own household (employee-only). Persists to recurrence_group. Requires feat-recurring-v2.
📄️ didRequestAppStoreReview
No description
📄️ disableCredentialAndDeleteFromDataProvider
No description
📄️ disconnectCredential
No description
📄️ disconnectCredentialsFromDataProvider
No description
📄️ disconnectDiscord
No description
📄️ disconnectSpinwheel
Endpoint to disconnect a user from Spinwheel.
📄️ discordOauthCallback
Handles the OAuth2 callback after the user authorizes Discord access.
📄️ dismissActivity
No description
📄️ dismissBusinessEntitiesBanner
Dismisses the business entities banner. Sets dismissed_business_entities_banner_at and tracks analytics.
📄️ dispatchSavingsGoalMigration
Asynchronously dispatch a Celery task to migrate Goal V2 models to SavingsGoal models.
📄️ duplicateForecastScenario
Deep-copy a scenario (including all child rows) into a new scenario.
📄️ endBrowserAutomation
Close the browser permanently (cancel or done).
📄️ extendFreeTrialDuration
Extends a user's household's free trial for 7 days.
📄️ fixCoinbaseCredential
No description
📄️ forceRefreshAccount
No description
📄️ forceRefreshAccounts
No description
📄️ forceRefreshAllAccounts
No description
📄️ getCloudinaryUploadInfo
Get Cloudinary upload info
📄️ getMerchantLogoCloudinaryUploadInfo
Get Cloudinary upload info
📄️ getTransactionAttachmentUploadInfo
No description
📄️ getUserProfilePictureCloudinaryUploadInfo
Get Cloudinary upload info
📄️ giveEmployeeInfinitePlusAccess
Give the current employee infinite Premium Plus access (employee-only)
📄️ giveEmployeeInfinitePremiumAccess
Give the current employee infinite Premium access (employee-only)
📄️ initScheduleCDefaultMappings
Generate default Schedule C category-to-line-item mappings for the household.
📄️ initializeFlexBudget
No description
📄️ initializeForecast
No description
📄️ inviteUserToHousehold
No description
📄️ linkTransactionToGoal
Link or unlink a transaction to/from a savings goal.
📄️ markActivityAsRead
No description
📄️ markAdviceItemTaskCompleteV2
No description
📄️ markAdviceItemTaskComplete
No description
📄️ markAdviceItemTaskIncompleteV2
No description
📄️ markAdviceItemTaskIncomplete
No description
📄️ markAllActivityAsRead
No description
📄️ markDataProviderSwitchConnected
Link the newly connected credential to a switch session and advance it (DP Switching step 2).
📄️ markGoalComplete
No description
📄️ markGoalIncomplete
No description
📄️ markStreamAsNotRecurring
No description
📄️ matchRetailTransaction
Mutation to manually match retail transaction with monarch transaction (reconcile and update).
📄️ migrateHouseholdToSavingsGoals
This is meant to be used internally as a way to test the migration.
📄️ moveMoneyBetweenCategories
No description
📄️ moveTransactions
Move transactions from one account to another
📄️ parseBalanceHistory
No description
📄️ parseUploadStatementSession
No description
📄️ populateBusinessEntityDemo
Populate the current user's household with business entity demo data for testing multi-entity scenarios
📄️ populateMultiRecurrenceDemo
Populate the current user's household with multi-recurrence recurring demo data
📄️ reactivateStripeSubscription
Reactivates a user's household's Stripe subscription after they have canceled.
📄️ reconcileExternalSpending
No description
📄️ recordBusinessEntitiesBannerImpression
Records an impression when the business entities banner enters the viewport.
📄️ recordRecurrenceGroupNewBadgeImpressions
Count one 'New' indicator impression per listed group for the calling user.
📄️ recordSmartPromptClick
Record that a smart prompt was clicked by the user
📄️ recordSmartPromptImpression
Record that a smart prompt was shown to the user
📄️ recordSmartPromptImpressions
Record that multiple smart prompts were shown to the user
📄️ redeemTrustAndWill
No description
📄️ registerParticipant
Register a participant to a bill split using a join token
📄️ releasePendingStripeCheckoutSession
No description
📄️ removeEmployeeEntitlements
Remove all entitlements from the current employee's household (employee-only)
📄️ replaceForecastEvents
No description
📄️ requestEmailReport
Employee only endpoint to send a monthly email report to yourself.
📄️ requestInstitution
No description
📄️ resendInviteToHousehold
No description
📄️ resendReferralRewardEmail
No description
📄️ resendTrustedReceiptSenderVerification
No description
📄️ resetAdvice
Employee only API to delete all profile question answers and advice
📄️ resetAiAssistantOptIn
Employee-only mutation to reset the AI assistant opt-in status.
📄️ resetAndSyncAccount
No description
📄️ resetBudgetRollover
No description
📄️ resetBudget
No description
📄️ resetCategorizationMemory
No description
📄️ resetEmployeeAndSubscribe
Reset the current employee and create a fresh subscription with trial (employee-only)
📄️ resetEmployeeToNoSubscription
Reset the current employee to a clean state with no subscription (employee-only)
📄️ resetForecastData
No description
📄️ resetMonarchMethod
Clear all saved Monarch Method data for the caller's household. Any authenticated user outside production; employees and demo households in production.
📄️ resetRecap
Mutation to reset (delete) a weekly recap for the given date range.
📄️ resetRecurrenceGroupDetection
Delete every V2 recurrence group (and its transaction links) for the current employee's own household (employee-only), returning the household to a clean re-detection state. Pair with detectRecurrenceGroups to re-run from scratch. Leaves V1 streams and any marked-not-recurring overrides untouched.
📄️ resetRecurringMerchantSearch
No description
📄️ restoreCategory
Delete (or disable) a category, and move all rules / transactions to
📄️ reviewRecurringStream
No description
📄️ revokeConnectedApp
No description
📄️ revokeHouseholdAccessGrant
No description
📄️ revokeInviteToHousehold
No description
📄️ revokeSubscriptionSponsorshipInvite
Revoke subscription sponsorship invite
📄️ runBrowserAgent
Run the agent on an existing browser session. Blocks 40-120s.
📄️ saveDebtPaydownProjectionToBudget
Set the budget amounts for debt paydown based on the projection from the debt paydown calculator.
📄️ saveForecastAccounts
No description
📄️ saveForecastParticipantOverrides
No description
📄️ saveForecastPriorityRules
No description
📄️ saveForecastScenarioKpis
No description
📄️ sendCreditScoreNotification
Endpoint to send a credit score notification to a user (employee-only).
📄️ sendMessage
No description
📄️ setAccountLogo
No description
📄️ setAccountTargetThreshold
Set (or clear) an account's `target_threshold` — the balance the projection alerts on.
📄️ setDebtPaydownBudgetAmount
Set the budget amount for a debt account for a specific month.
📄️ setEmployeeActiveSubscription
Set the current employee to an active subscription state (employee-only)
📄️ setEmployeeBillingIssue
Toggle billing issue state on the current employee's household (employee-only)
📄️ setEmployeeCancellationDiscountUsed
Toggle cancellation discount usage on the current employee's household (employee-only)
📄️ setEmployeeExpiredTrial
Set the current employee to an expired-trial state (employee-only)
📄️ setEmployeePlusTrialFields
Modify Plus trial fields on the current employee's subscription (employee-only)
📄️ setEmployeeSubscriptionEnded
Set the current employee to a subscription-ended state (employee-only)
📄️ setFinancialInsightsEnabled
No description
📄️ setHoldingClassification
No description
📄️ setMerchantLogo
No description
📄️ setMonarchMethodAccountSettings
Update the Monarch Method settings for one or more of the current household's accounts.
📄️ setMonarchMethodCashFlowFixedExpenseSettings
Set which of the household's expense categories count toward the Cash Flow pillar.
📄️ setSavingsGoalBudgetAmount
Set the budget amount for a savings goal for a specific month.
📄️ setSecurityClassification
No description
📄️ setTransactionTags
No description
📄️ setUserOnboardingFinancialGoals
Set a users goals during onboarding. This will clear any previous goals set by the user.
📄️ setUserProfilePicture
No description
📄️ softDeleteFinancialInsight
No description
📄️ startBrowserAutomation
Create a browser session. Derives playbook from the insight's FK.
📄️ startDataProviderSwitch
Open a "switch provider" session for a credential and return its id (DP Switching step 1).
📄️ startDownloadScheduleCSession
No description
📄️ startDownloadTransactionsSession
No description
📄️ startPreviewRecurrenceDetection
Start async recurrence detection preview on the current employee's own household (employee-only). Poll previewRecurrenceDetectionSession for results.
📄️ startRetailSync
Mutation to initialize and start a retail sync.
📄️ startSavingsGoalMigration
Synchronously migrate Goal V2 models to SavingsGoal models for the current household.
📄️ submitAssistantFeedback
No description
📄️ submitBillSplitInitiatorEdit
Mutation to submit initiator edits to a bill split.
📄️ submitProductFeedback
Submit member product feedback; stored locally and forwarded to Voltron.
📄️ submitQuestionnaireAnswer
No description
📄️ syncAppleFinanceKitAccountInfo
No description
📄️ syncCredentialAfterReconnect
Mutation to be called after a user completes a credential reconnect flow (any provider).
📄️ syncEmployeeSubscription
Resync the current employee's subscription from RevenueCat/Stripe (employee-only)
📄️ toggleBillSyncTracking
Endpoint to toggle bill sync tracking for a user.
📄️ toggleCreditScoreTracking
Endpoint to toggle credit score tracking for a user.
📄️ toggleSupportAccountAccess
No description
📄️ transferAccountDataAsync
Asynchronously transfer account data (transactions and/or snapshots) from one account to another.
📄️ transferAccountData
No description
📄️ triggerRecurringMerchantSearch
No description
📄️ unarchiveGoal
No description
📄️ unarchiveSavingsGoal
No description
📄️ unclaimBillItem
Unclaim a previously claimed item
📄️ undeleteAccount
No description
📄️ undoHouseholdSavingsGoalsMigration
Undo the migration from Goal V2 to SavingsGoal models for the current household.
📄️ unmatchRetailTransaction
Mutation to manually unmatch a retail transaction from its linked Monarch transaction.
📄️ updateAccountGroupOrder
No description
📄️ updateAccountIncludeInGoals
No description
📄️ updateAccountOrder
No description
📄️ updateAccount
No description
📄️ updateAccounts
No description
📄️ updateAllNotificationPreferencesForPlatform
No description
📄️ updateBillAmount
Endpoint to update the bill amount of a credit report liability statement.
📄️ updateBillPaid
Endpoint to mark a credit report liability statement paid or unpaid.
📄️ updateBillingPostalCode
No description
📄️ updateBudgetSettings
No description
📄️ updateCategoryGroupOrder
No description
📄️ updateCategoryGroup
No description
📄️ updateCategoryOrderInCategoryGroup
No description
📄️ updateCategory
No description
📄️ updateCompany
No description
📄️ updateCredential
No description
📄️ updateDashboardConfig
No description
📄️ updateDoNotSellOrShare
No description
📄️ updateEquityGrant
No description
📄️ updateFinancialInsightStatus
No description
📄️ updateForecastScenarioComparison
No description
📄️ updateForecastScenarioOrder
Replace the household's scenario order with the supplied list.
📄️ updateForecastScenario
No description
📄️ updateGoalAccountAllocation
No description
📄️ updateGoalEvent
No description
📄️ updateGoalPriorities
No description
📄️ updateGoalV2
No description
📄️ updateGoals
Bulk version of UpdateGoal
📄️ updateHolding
No description
📄️ updateHouseholdExperimentAssignment
Employee-only mutation to manually add or remove a household from a persisted A/B experiment.
📄️ updateHouseholdPreferences
No description
📄️ updateHouseholdProfile
No description
📄️ updateMe
No description
📄️ updateMerchant
No description
📄️ updateMyHousehold
No description
📄️ updateNotificationPreferences
No description
📄️ updateOrCreateBudgetItem
No description
📄️ updateOrCreateFlexBudgetItem
No description
📄️ updateOrCreateStripePaymentMethod
No description
📄️ updatePaycheckEmployer
No description
📄️ updatePaycheck
No description
📄️ updateRecurringTransactionStream
No description
📄️ updateRenewalReminder
No description
📄️ updateReportConfiguration
Endpoint to update a report configuration.
📄️ updateRetailOrder
Mutation to update retail order, transactions and line items.
📄️ updateRetailVendorSettings
Mutation to update the retail vendor settings.
📄️ updateReviewCheckin
No description
📄️ updateSavingsGoal
No description
📄️ updateSavingsGoalsPriorities
No description
📄️ updateSubscriptionSponsor
Update subscription sponsor
📄️ updateSubscriptionSponsorshipInvite
Update subscription sponsorship invite
📄️ updateTaxLot
No description
📄️ updateTransactionListDisplayPreferences
No description
📄️ updateTransactionRuleOrderV2
No description
📄️ updateTransactionRuleV2
No description
📄️ updateTransactionSplit
No description
📄️ updateTransactionTagOrder
No description
📄️ updateTransactionTag
No description
📄️ updateTransaction
No description
📄️ updateUserFinancialProfile
Mutation for household members to update financial and demographic profile
📄️ updateUserProfile
No description
📄️ upsertBusinessEntity
No description
📄️ upsertCreditScoreSnapshot
No description
📄️ verifyTrustedReceiptSender
No description
📄️ withdrawAllGoalContributionsFromAccount
No description