Account

public struct Account : Codable, Equatable, Sendable

Budget account model

  • id

    Account id

    Declaration

    Swift

    public let id: String

  • Account name

    Declaration

    Swift

    public let name: String

  • Account type as returned by the server. Note this is the read-side enum and includes types (e.g. .mortgage, .lineOfCredit) that cannot be specified on creation. When creating an account, use SaveAccountType.

    Declaration

    Swift

    public let type: AccountType

  • Budget account or not

    Declaration

    Swift

    public let onBudget: Bool

  • Closed account or not

    Declaration

    Swift

    public let closed: Bool

  • Note on the account

    Declaration

    Swift

    public let note: String?

  • Account balance

    Declaration

    Swift

    public let balance: Int

  • Account balance formatted in the plan currency

    Declaration

    Swift

    public let balanceFormatted: String?

  • Account balance as a decimal currency amount

    Declaration

    Swift

    public let balanceCurrency: Decimal?

  • Cleared account balance

    Declaration

    Swift

    public let clearedBalance: Int

  • Cleared account balance formatted in the plan currency

    Declaration

    Swift

    public let clearedBalanceFormatted: String?

  • Cleared account balance as a decimal currency amount

    Declaration

    Swift

    public let clearedBalanceCurrency: Decimal?

  • Uncleared account balance

    Declaration

    Swift

    public let unclearedBalance: Int

  • Uncleared account balance formatted in the plan currency

    Declaration

    Swift

    public let unclearedBalanceFormatted: String?

  • Uncleared account balance as a decimal currency amount

    Declaration

    Swift

    public let unclearedBalanceCurrency: Decimal?

  • Payee id for transfers

    Declaration

    Swift

    public let transferPayeeId: String?

  • Indicates whether the account is linked via direct import

    Declaration

    Swift

    public let directImportLinked: Bool?

  • Indicates whether direct import is in an error state

    Declaration

    Swift

    public let directImportInError: Bool?

  • Date when account was last reconciled

    Declaration

    Swift

    public let lastReconciledAt: String?

  • Original balance for a debt account

    Declaration

    Swift

    public let debtOriginalBalance: Int?

  • Interest rate at different points in time

    Declaration

    Swift

    public let debtInterestRates: [String : Int]?

  • Minimum payment at different points in time

    Declaration

    Swift

    public let debtMinimumPayments: [String : Int]?

  • Escrow amount at different points in time

    Declaration

    Swift

    public let debtEscrowAmounts: [String : Int]?

  • Deleted account or not

    Declaration

    Swift

    public let deleted: Bool