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
  goalEvent(
    id: ID!
  ): GoalEvent
  goalEventAggregation(
    endDate: Date
    excludeEventsBeforeV3Migration: Boolean
    excludeEventsNotInBudget: Boolean
    groupEventsAfterToday: Boolean
    groupingPeriod: GoalEventAggregationGroupingPeriodType
    startDate: Date
    today: Date
  ): GoalEventAggregation!
  goalEvents: [GoalEvent] @deprecated
  goalEventsPaginated(
    endDate: Date
    limit: Int
    offset: Int
    startDate: Date
  ): GoalEventPaginatedFields!
  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.goalEvent` ● `GoalEvent` object

Fetch a single goal event by ID. Returns null if the event does not belong to this goal.

`SavingsGoal.goalEvent.id` ● `ID!` non-null scalar

`SavingsGoal.goalEventAggregation` ● `GoalEventAggregation!` non-null object

Returns the goal events aggregated by period. Intended for use in the goal event timeline. Will return at most 1000 data points.

`SavingsGoal.goalEventAggregation.endDate` ● `Date` scalar

The end date to aggregate goal events for. If not provided, then the end date is derived from the forecasted completion date or target date of the goal.

`SavingsGoal.goalEventAggregation.excludeEventsBeforeV3Migration` ● `Boolean` scalar

If true, only include goal events that are after the v3 migration date.

`SavingsGoal.goalEventAggregation.excludeEventsNotInBudget` ● `Boolean` scalar

If true, only include goal events that are included in the budget.

`SavingsGoal.goalEventAggregation.groupEventsAfterToday` ● `Boolean` scalar

If true, all events dated after today are collapsed into a single bucket whose date is today + 1 day. Defaults to true.

`SavingsGoal.goalEventAggregation.groupingPeriod` ● `GoalEventAggregationGroupingPeriodType` enum

The type of grouping to use for the timeline data. If not provided, the grouping is derived from the forecasted completion date or target date of the goal.