Savings goals with allocations, deposits, withdrawals, and reallocation.
Requires savings-goals:read and savings-goals:write scopes.
Summary
Functions
Archive a savings goal. Requires savings-goals:write.
Mark a savings goal as complete. Requires savings-goals:write.
Create a savings goal. Requires savings-goals:write.
Deposit funds into a savings goal allocation. Requires savings-goals:write.
Get a savings goal by ID. Requires savings-goals:read.
Get period progress for a savings goal. Requires savings-goals:read.
List all savings goals. Requires savings-goals:read.
List allocations for a savings goal account. Requires savings-goals:read.
List savings goal accounts. Requires savings-goals:read.
List allocations for a savings goal. Requires savings-goals:read.
List savings goal categories. Requires savings-goals:read.
Reallocate funds between savings goals. Requires savings-goals:write.
Update a savings goal. Requires savings-goals:write.
Withdraw funds from a savings goal allocation. Requires savings-goals:write.
Functions
@spec archive(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Archive a savings goal. Requires savings-goals:write.
@spec complete(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Mark a savings goal as complete. Requires savings-goals:write.
@spec create(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Create a savings goal. Requires savings-goals:write.
@spec deposit(Tink.Client.t(), String.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Deposit funds into a savings goal allocation. Requires savings-goals:write.
@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Get a savings goal by ID. Requires savings-goals:read.
@spec get_period_progress(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Get period progress for a savings goal. Requires savings-goals:read.
@spec list(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
List all savings goals. Requires savings-goals:read.
@spec list_account_allocations(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
List allocations for a savings goal account. Requires savings-goals:read.
@spec list_accounts(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
List savings goal accounts. Requires savings-goals:read.
@spec list_allocations(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
List allocations for a savings goal. Requires savings-goals:read.
@spec list_categories(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
List savings goal categories. Requires savings-goals:read.
@spec reallocate(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Reallocate funds between savings goals. Requires savings-goals:write.
@spec update(Tink.Client.t(), String.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Update a savings goal. Requires savings-goals:write.
@spec withdraw(Tink.Client.t(), String.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Withdraw funds from a savings goal allocation. Requires savings-goals:write.