Tink.CashFlow (Tink v1.0.0)

Copy Markdown View Source

Cash flow analysis — income vs expenses over time. Delegates to Tink.Statistics with sensible defaults. Requires statistics:read scope.

Summary

Functions

query(client, opts \\ [])

Query income and expense statistics by period.

Functions

query(client, opts \\ [])

@spec query(
  Tink.Client.t(),
  keyword()
) :: {:ok, map()} | {:error, Tink.Error.t()}

Query income and expense statistics by period.

Options

All options from Tink.Statistics.query/2 are supported:

  • :period_mode — default "MONTHLY"
  • :statistic_types — default ["EXPENSES_BY_CATEGORY", "INCOME_BY_CATEGORY"]
  • :resolution — default "MONTHLY"
  • :period_start, :period_end, :currency