Category

public struct Category : Codable, Equatable

Budget category

  • id

    Category id

    Declaration

    Swift

    public let id: String

  • Category group id

    Declaration

    Swift

    public let categoryGroupId: String

  • Category name

    Declaration

    Swift

    public let name: String

  • Whether or not the category is hidden

    Declaration

    Swift

    public let hidden: Bool

  • Original category group id

    Declaration

    Swift

    public let originalCategoryGroupId: String?

  • Category note

    Declaration

    Swift

    public let note: String?

  • Amount budgeted to this category

    Declaration

    Swift

    public let budgeted: Int

  • Activity on this category

    Declaration

    Swift

    public let activity: Int

  • Current balance on this category

    Declaration

    Swift

    public let balance: Int

  • Type of goal associated with this category

    Declaration

    Swift

    public let goalType: String?

  • The day of the goal

    Declaration

    Swift

    public let goalDay: Int?

  • The goal cadence

    Declaration

    Swift

    public let goalCadence: Int?

  • The goal cadence frequency

    Declaration

    Swift

    public let goalCadenceFrequency: Int?

  • Goal creation month

    Declaration

    Swift

    public let goalCreationMonth: String?

  • Goal target amount

    Declaration

    Swift

    public let goalTarget: Int?

  • Goal target date

    Declaration

    Swift

    public let goalTargetMonth: String?

  • Goal percentage complete

    Declaration

    Swift

    public let goalPercentageComplete: Int?

  • The number of months, including the current month, left in the current goal period.

    Declaration

    Swift

    public let goalMonthsToBudget: Int?

  • The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the ‘Underfunded’ amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month. The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month.

    Declaration

    Swift

    public let goalUnderFunded: Int?

  • The total amount funded towards the goal within the current goal period.

    Declaration

    Swift

    public let goalOverallFunded: Int?

  • The amount of funding still needed to complete the goal within the current goal period.

    Declaration

    Swift

    public let goalOverallLeft: Int?

  • Whether or not the goal is deleted

    Declaration

    Swift

    public let deleted: Bool