@spec categorize_multiple(Tink.Client.t(), [map()]) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Bulk categorize multiple transactions. Requires transactions:categorize.

Example

Tink.Transactions.categorize_multiple(client, [
  %{"id" => "tx-001", "categoryId" => "cat-expenses"},
  %{"id" => "tx-002", "categoryId" => "cat-income"}
])

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

Get a single transaction by ID. Requires transactions:read.

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

Get transactions similar to a given transaction. Requires transactions:read.

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

List transactions with cursor pagination. Returns one page.

Options

• :page_size — results per page (consult your Tink dashboard/docs for the current maximum on /data/v2/transactions; the related /enrichment/v1/transactions endpoint defaults to 10 and caps at 100 per request)
• :page_token — cursor from previous nextPageToken
• :account_id_in — list of account IDs to filter by
• :booked_date_gte — ISO 8601 date, e.g. "2024-01-01"
• :booked_date_lte — ISO 8601 date
• :status_in — list of statuses: "BOOKED", "PENDING", "UNDEFINED"

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

Collect all transactions across all pages eagerly. Use stream/2 for large datasets.

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

Full-text search over transactions. Requires transactions:read.

Options

• :query_string — free-text search
• :limit — max results

@spec stream(
  Tink.Client.t(),
  keyword()
) :: Enumerable.t()

Stream all transactions lazily across all pages. Never buffers all pages in memory.

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

Transaction autocomplete / suggestions. Requires transactions:read.

Options

• :limit — max suggestions

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

Update a transaction (custom category, tags, notes). Requires transactions:write.

Common params: %{"categoryId" => "...", "notes" => "...", "tags" => ["..."]}.