MoneyHub.StandardFinancialStatements (MoneyHub v1.0.0)

Copy Markdown View Source

Standard Financial Statements (SFS): a pre-filled financial statement report, used alongside affordability and income-verification reports in lending and collections workflows.

Like MoneyHub.Affordability, report generation is asynchronous: create/3 returns a report in "pending" status that later transitions to "complete" or "failed".

See Lending and Collections Widgets.

Summary

Types

report()

Functions

create(config, token, attrs \\ %{})

Requests generation of a Standard Financial Statement for the user identified by token.

get(config, token, report_id)

Fetches a Standard Financial Statement's current status/contents by id.

list(config, token)

Lists metadata for all Standard Financial Statements for the user identified by token.

Types

report()

@type report() :: map()

Functions

create(config, token, attrs \\ %{})

@spec create(MoneyHub.Config.t(), String.t(), map()) ::
  {:ok, report()} | {:error, MoneyHub.Error.t()}

Requests generation of a Standard Financial Statement for the user identified by token.

get(config, token, report_id)

@spec get(MoneyHub.Config.t(), String.t(), String.t()) ::
  {:ok, report()} | {:error, MoneyHub.Error.t()}

Fetches a Standard Financial Statement's current status/contents by id.

list(config, token)

@spec list(MoneyHub.Config.t(), String.t()) ::
  {:ok, [report()]} | {:error, MoneyHub.Error.t()}

Lists metadata for all Standard Financial Statements for the user identified by token.