FinanceKit · IOS API REFERENCE

AccountBalanceQuery

struct · iOS 17.4+ · SDK 27.1

struct AccountBalanceQuery

A structure that defines an account balance query. Use an `AccountBalanceQuery` to find and filter specific balances in a person's accounts.

Members (3)

init · iOS 17.4+

init

TypeScript

static init(sortDescriptors?: Array<_Foundation_SortDescriptor<AccountBalance>>, predicate?: (_Foundation_Predicate<AccountBalance>) | null, limit?: (number) | null, offset?: (number) | null): AccountBalanceQuery

Swift declaration

init(sortDescriptors: [SortDescriptor<AccountBalance>] = [], predicate: Predicate<AccountBalance>? = nil, limit: Int? = nil, offset: Int? = nil)

Creates a new account balance query structure with the provided sort descriptors. - parameters: - sortDescriptors: An array of ``AccountBalance`` sort descriptors. - predicate: A <doc://com.apple.documentation/documentation/foundation/predicate> to filter the `Account` records with. - limit: An integer that indicates the maximum number of records to return. - offset: An integer that indicates the number of records to offset the result by.

static · iOS 17.4+

predicate

TypeScript

static predicateBookedSinceUntil(startDate: globalThis.Date, endDate?: (globalThis.Date) | null): _Foundation_Predicate<AccountBalance>

Swift declaration

static func predicate(bookedSince startDate: Date, until endDate: Date? = nil) -> Predicate<AccountBalance>

A predicate that returns booked account balances since a specified date until another date. - Parameters: - startDate: The date to start collecting account balances. - endDate: The date to end collection account balances. This parameter is optional. If this parameter isn't included, the method returns all account balances since the `startDate`.

static · iOS 17.4+

predicate

TypeScript

static predicateAvailableSinceUntil(startDate: globalThis.Date, endDate?: (globalThis.Date) | null): _Foundation_Predicate<AccountBalance>

Swift declaration

static func predicate(availableSince startDate: Date, until endDate: Date? = nil) -> Predicate<AccountBalance>

A predicate that returns available account balances since a specified date, and, optionally, until another date. - Parameters: - startDate: The date to start collecting account balances. - endDate: The date to end collection account balances. This parameter is optional. If this parameter isn't included, the method returns all account balances since the `startDate`.

Skipped declarations

No declarations were skipped in this snapshot.

All FinanceKit types →