One Logo Pool Ball
X
Github
Discord

System

FinanceKit · IOS API REFERENCE

Balance

struct · iOS 17.4+ · SDK 27.1

struct Balance

A structure that describes an account balance.

Members (3)

get · iOS 17.4+

creditDebitIndicator

TypeScript
get creditDebitIndicator(): CreditDebitIndicator
Swift declaration
let creditDebitIndicator: CreditDebitIndicator

A value that indicates whether the balance is a credit or a debit balance. If an asset account has a positive balance, then the ``CreditDebitIndicator`` is ``CreditDebitIndicator/credit``. If it has a negative balance, then the `CreditDebitIndicator` is ``CreditDebitIndicator/debit``. If a liability account has a _spent_ balance, then the `CreditDebitIndicator` is `CreditDebitIndicator/debit`. If it has been _is in credit_ then the `CreditDebitIndicator` is `CreditDebitIndicator/credit`. - Note: FinanceKit considers a zero balance to be a credit balance.

get · iOS 17.4+

amount

TypeScript
get amount(): CurrencyAmount
Swift declaration
let amount: CurrencyAmount

The amount of the balance.

get · iOS 17.4+

asOfDate

TypeScript
get asOfDate(): globalThis.Date
Swift declaration
let asOfDate: Date

The date and time the system calculated the balance.

Skipped declarations

No declarations were skipped in this snapshot.

All FinanceKit types →