Increase.AccountStatements (Increase v1.0.0)

Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.

See https://increase.com/documentation/api/account-statements for the full API reference for this resource.

Summary

Functions

list(client, params \\ %{}, opts \\ [])

List Account Statements

retrieve(client, account_statement_id, opts \\ [])

Retrieve an Account Statement

Functions

list(client, params \\ %{}, opts \\ [])

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

List Account Statements

Returns a %Increase.Page{} whose data is a list of %__MODULE__. AccountStatement{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /account_statements

retrieve(client, account_statement_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.AccountStatements.AccountStatement.t()}
  | {:error, Increase.Error.t()}

Retrieve an Account Statement

GET /account_statements/{account_statement_id}