Codat.Lending.FinancialStatements (codat v1.0.0)

Copy Markdown View Source

Access enhanced financial statement data through the Lending API.

Returns standardized, normalized financial statements suitable for automated underwriting and credit analysis.

Summary

Functions

balance_sheet(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

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

Returns enhanced balance sheet.

cash_flow_statement(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

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

Returns enhanced cash flow statement.

profit_and_loss(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

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

Returns enhanced profit and loss statement.