Unit.API.Statements (Unit v1.0.0)

API module for Unit Statements.

Statements are generated on the 1st of every month. You are responsible for distributing them to your customers.

Retrieve statements as HTML (for in-app display) or PDF (for download).

Summary

Get a bank-branded statement PDF (for regulatory delivery).

Get the HTML content of a statement.

Get the PDF binary content of a statement.

list(opts \\ [])

List statements for an account or customer.

@spec get_bank_pdf(
  String.t(),
  keyword()
) :: Unit.Client.response()

Get a bank-branded statement PDF (for regulatory delivery).

@spec get_html(
  String.t(),
  keyword()
) :: Unit.Client.response()

Get the HTML content of a statement.

@spec get_pdf(
  String.t(),
  keyword()
) :: Unit.Client.response()

Get the PDF binary content of a statement.

@spec list(keyword()) ::
  {:ok, [Unit.Resource.Statement.t()], map()} | {:error, term()}

List statements for an account or customer.