Codat.Accounting.Transfers (codat v1.0.0)

Read and write transfers between bank accounts.

Summary

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

Creates a new transfers (async). Returns a push operation.

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

Fetches all transfers across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

Fetches a single transfers by ID.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

Returns the push model for creating transfers.

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

Returns a paginated list of transfers.

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

Returns a lazy Stream of all results.

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

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

Creates a new transfers (async). Returns a push operation.

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

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

Fetches all transfers across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

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

Fetches a single transfers by ID.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

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

Returns the push model for creating transfers.

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

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

Returns a paginated list of transfers.

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

@spec stream(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  Enumerable.t()

Returns a lazy Stream of all results.