Increase.AccountStatements.AccountStatement (Increase v1.0.0)

Copy Markdown View Source

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.

Fields

  • id - The Account Statement identifier.
  • account_id - The identifier for the Account this Account Statement belongs to.
  • created_at - The ISO 8601 time at which the Account Statement was created.
  • ending_balance - The Account's balance at the end of its statement period.
  • file_id - The identifier of the File containing a PDF of the statement.
  • loan - The loan balances.
  • starting_balance - The Account's balance at the start of its statement period.
  • statement_period_end - The ISO 8601 time representing the end of the period the Account Statement covers.
  • statement_period_start - The ISO 8601 time representing the start of the period the Account Statement covers.
  • type - A constant representing the object's type. For this resource it will always be account_statement.

Summary

Types

t()

@type t() :: %Increase.AccountStatements.AccountStatement{
  account_id: String.t(),
  created_at: DateTime.t(),
  ending_balance: integer(),
  file_id: String.t(),
  id: String.t(),
  loan: Increase.AccountStatements.AccountStatement.Loan.t() | nil,
  starting_balance: integer(),
  statement_period_end: DateTime.t(),
  statement_period_start: DateTime.t(),
  type: String.t()
}