Interface: SavingsClient
Read-only recurring savings, savings goals, credit, and pension data. All require a session.
Properties
context
protectedreadonlycontext:ClientContext
Methods
categories()
categories(
signal?):Promise<readonlySavingsCategory[]>
Accounts grouped into savings goals and other categories.
Parameters
signal?
AbortSignal
Returns
Promise<readonly SavingsCategory[]>
creditAccounts()
creditAccounts(
signal?):Promise<CreditAccountsResponse>
Accounts available for securities credit.
Parameters
signal?
AbortSignal
Returns
Promise<CreditAccountsResponse>
creditInfo()
creditInfo(
type,signal?):Promise<CreditInfoResponse>
Credit limit, used credit, interest, and leverage per account.
Parameters
type
signal?
AbortSignal
Returns
Promise<CreditInfoResponse>
goalHealth()
goalHealth(
categoryId,signal?):Promise<SavingsGoalHealth>
Parameters
categoryId
string
signal?
AbortSignal
Returns
Promise<SavingsGoalHealth>
goalPerformance()
goalPerformance(
categoryId,timePeriod,signal?):Promise<SavingsGoalPerformance>
Parameters
categoryId
string
timePeriod
"ONE_WEEK" | "ONE_MONTH" | "THREE_MONTHS" | "THIS_YEAR" | "ONE_YEAR" | "THREE_YEARS" | "INFINITY"
signal?
AbortSignal
Returns
Promise<SavingsGoalPerformance>
payoutPlan()
payoutPlan(
accountId,signal?):Promise<Readonly<Record<string,unknown>> |null>
Resolves to null when the account has no payout plan (HTTP 204).
Parameters
accountId
string
signal?
AbortSignal
Returns
Promise<Readonly<Record<string, unknown>> | null>
payoutPlans()
payoutPlans(
signal?):Promise<readonlyReadonly<Record<string,unknown>>[]>
Parameters
signal?
AbortSignal
Returns
Promise<readonly Readonly<Record<string, unknown>>[]>
pensionDetails()
pensionDetails(
accountId,signal?):Promise<PensionDetails>
accountId is the numeric account ID of a pension or insurance account.
Parameters
accountId
string
signal?
AbortSignal
Returns
Promise<PensionDetails>
pensionDistribution()
pensionDistribution(
accountId,signal?):Promise<PensionDistribution>
Current and next fund allocation for new pension premiums.
Parameters
accountId
string
signal?
AbortSignal
Returns
Promise<PensionDistribution>
periodicSavings()
periodicSavings(
signal?):Promise<PeriodicSavingsResponse>
Parameters
signal?
AbortSignal
Returns
Promise<PeriodicSavingsResponse>
recurringDeposits()
recurringDeposits(
signal?):Promise<RecurringDepositsResponse>
Parameters
signal?
AbortSignal
Returns
Promise<RecurringDepositsResponse>