Account Structure Reference

id

Account id

Declaration

Swift

public let id: String


                    
                    
                    name

Account name

Declaration

Swift

public let name: String


                    
                    
                    type

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


                    
                    
                    onBudget

Budget account or not

Declaration

Swift

public let onBudget: Bool


                    
                    
                    closed

Closed account or not

Declaration

Swift

public let closed: Bool


                    
                    
                    note

Note on the account

Declaration

Swift

public let note: String?


                    
                    
                    balance

Account balance

Declaration

Swift

public let balance: Int


                    
                    
                    balanceFormatted

Account balance formatted in the plan currency

Declaration

Swift

public let balanceFormatted: String?


                    
                    
                    balanceCurrency

Account balance as a decimal currency amount

Declaration

Swift

public let balanceCurrency: Decimal?


                    
                    
                    clearedBalance

Cleared account balance

Declaration

Swift

public let clearedBalance: Int


                    
                    
                    clearedBalanceFormatted

Cleared account balance formatted in the plan currency

Declaration

Swift

public let clearedBalanceFormatted: String?


                    
                    
                    clearedBalanceCurrency

Cleared account balance as a decimal currency amount

Declaration

Swift

public let clearedBalanceCurrency: Decimal?


                    
                    
                    unclearedBalance

Uncleared account balance

Declaration

Swift

public let unclearedBalance: Int


                    
                    
                    unclearedBalanceFormatted

Uncleared account balance formatted in the plan currency

Declaration

Swift

public let unclearedBalanceFormatted: String?


                    
                    
                    unclearedBalanceCurrency

Uncleared account balance as a decimal currency amount

Declaration

Swift

public let unclearedBalanceCurrency: Decimal?


                    
                    
                    transferPayeeId

Payee id for transfers

Declaration

Swift

public let transferPayeeId: String?


                    
                    
                    directImportLinked

Indicates whether the account is linked via direct import

Declaration

Swift

public let directImportLinked: Bool?


                    
                    
                    directImportInError

Indicates whether direct import is in an error state

Declaration

Swift

public let directImportInError: Bool?


                    
                    
                    lastReconciledAt

Date when account was last reconciled

Declaration

Swift

public let lastReconciledAt: String?


                    
                    
                    debtOriginalBalance

Original balance for a debt account

Declaration

Swift

public let debtOriginalBalance: Int?


                    
                    
                    debtInterestRates

Interest rate at different points in time

Declaration

Swift

public let debtInterestRates: [String : Int]?


                    
                    
                    debtMinimumPayments

Minimum payment at different points in time

Declaration

Swift

public let debtMinimumPayments: [String : Int]?


                    
                    
                    debtEscrowAmounts

Escrow amount at different points in time

Declaration

Swift

public let debtEscrowAmounts: [String : Int]?


                    
                    
                    deleted

Deleted account or not

Declaration

Swift

public let deleted: Bool


                    
                    
                    init(id:name:type:onBudget:closed:note:balance:balanceFormatted:balanceCurrency:clearedBalance:clearedBalanceFormatted:clearedBalanceCurrency:unclearedBalance:unclearedBalanceFormatted:unclearedBalanceCurrency:transferPayeeId:directImportLinked:directImportInError:lastReconciledAt:debtOriginalBalance:debtInterestRates:debtMinimumPayments:debtEscrowAmounts:deleted:)

Undocumented

Declaration

Swift

public init(
    id: String,
    name: String,
    type: AccountType,
    onBudget: Bool,
    closed: Bool,
    note: String?,
    balance: Int,
    balanceFormatted: String?,
    balanceCurrency: Decimal?,
    clearedBalance: Int,
    clearedBalanceFormatted: String?,
    clearedBalanceCurrency: Decimal?,
    unclearedBalance: Int,
    unclearedBalanceFormatted: String?,
    unclearedBalanceCurrency: Decimal?,
    transferPayeeId: String?,
    directImportLinked: Bool?,
    directImportInError: Bool?,
    lastReconciledAt: String?,
    debtOriginalBalance: Int?,
    debtInterestRates: [String: Int]?,
    debtMinimumPayments: [String: Int]?,
    debtEscrowAmounts: [String: Int]?,
    deleted: Bool
)