Skip to main content

SavingsGoal

No description

type SavingsGoal {
  allocationAmountsByAccount: [GoalAccountCurrentContributionAmounts]
  archivedAt: DateTime
  balanceThisMonth: Float!
  completedAt: DateTime
  contributionTotal: Float!
  createdAt: DateTime!
  currentBalance: Float!
  currentMonthActualBudgetAmount: Float!
  currentMonthPlannedContributionAmount: Float!
  estimatedMonthsUntilCompletion: Int
  forecastedCompletionDate: Date
  goalEvents: [GoalEvent]
  hasFutureBudgetDifferentFromCurrentMonth: Boolean!
  id: ID!
  imageStorageProvider: String
  imageStorageProviderId: String
  isArchived: Boolean
  isSinkingFund: Boolean
  linkedAccounts: [Account]!
  monthlyBudgetAmounts(
    endMonth: Date!
    startMonth: Date!
  ): [SavingsGoalBudgetAmountsForMonth!]!
  name: String!
  netContribution: Float!
  netContributionWithSpending: Float!
  netContributionWithoutSpending: Float!
  plannedMonthlyContribution: Float @deprecated
  priority: Int!
  progress: Float!
  rebalanceTotal: Float!
  spendingTotal: Float!
  status: GoalStatus
  targetAmount: Float
  targetDate: Date
  type: String!
  withdrawalTotal: Float!
}

Fields​

SavingsGoal.allocationAmountsByAccount ● [GoalAccountCurrentContributionAmounts] list object​

SavingsGoal.archivedAt ● DateTime scalar​

SavingsGoal.balanceThisMonth ● Float! non-null scalar​

The balance of this goal for the current month. Sums the goal events for the current month only.

SavingsGoal.completedAt ● DateTime scalar​

SavingsGoal.contributionTotal ● Float! non-null scalar​

SavingsGoal.createdAt ● DateTime! non-null scalar​

SavingsGoal.currentBalance ● Float! non-null scalar​

SavingsGoal.currentMonthActualBudgetAmount ● Float! non-null scalar​

The actual budget amount for the current month.

SavingsGoal.currentMonthPlannedContributionAmount ● Float! non-null scalar​

The planned contribution amount for the current month. We use this field for when editing goals when there are no differences between the current and planned contribution amounts.

SavingsGoal.estimatedMonthsUntilCompletion ● Int scalar​

SavingsGoal.forecastedCompletionDate ● Date scalar​

SavingsGoal.goalEvents ● [GoalEvent] list object​

SavingsGoal.hasFutureBudgetDifferentFromCurrentMonth ● Boolean! non-null scalar​

Whether any future month's budget differs from the current month.

SavingsGoal.id ● ID! non-null scalar​

SavingsGoal.imageStorageProvider ● String scalar​

SavingsGoal.imageStorageProviderId ● String scalar​

SavingsGoal.isArchived ● Boolean scalar​

SavingsGoal.isSinkingFund ● Boolean scalar​

SavingsGoal.linkedAccounts ● [Account]! non-null object​

SavingsGoal.monthlyBudgetAmounts ● [SavingsGoalBudgetAmountsForMonth!]! non-null object​

Monthly budget amounts (planned, actual, remaining) for this goal across a date range.

SavingsGoal.monthlyBudgetAmounts.endMonth ● Date! non-null scalar​
SavingsGoal.monthlyBudgetAmounts.startMonth ● Date! non-null scalar​

SavingsGoal.name ● String! non-null scalar​

SavingsGoal.netContribution ● Float! non-null scalar​

SavingsGoal.netContributionWithSpending ● Float! non-null scalar​

SavingsGoal.netContributionWithoutSpending ● Float! non-null scalar​

SavingsGoal.priority ● Int! non-null scalar​

SavingsGoal.progress ● Float! non-null scalar​

SavingsGoal.rebalanceTotal ● Float! non-null scalar​

SavingsGoal.spendingTotal ● Float! non-null scalar​

SavingsGoal.status ● GoalStatus enum​

SavingsGoal.targetAmount ● Float scalar​

SavingsGoal.targetDate ● Date scalar​

SavingsGoal.type ● String! non-null scalar​

SavingsGoal.withdrawalTotal ● Float! non-null scalar​

Show deprecated

Returned By​

savingsGoal query ● savingsGoals query

Member Of​

Account object ● ArchiveSavingsGoal object ● CreateSavingsGoal object ● CreateSavingsGoals object ● GoalAndAmount object ● GoalEvent object ● SavingsGoalBudgetAmountsForMonth object ● SavingsGoalMonthlyBudgetAmounts object ● TransactionFilterSet object ● TransactionFiltersMetadata object ● TransactionPreview object ● TransactionRuleV2 object ● UnarchiveSavingsGoal object ● UpdateSavingsGoal object ● UpdateSavingsGoalsPriorities object